#include <egammaTrkRefitterTool.h>

Inheritance diagram for egammaTrkRefitterTool:

Collaboration diagram for egammaTrkRefitterTool:

Classes
struct	MeasurementsAndTrash

Public Types
typedef IegammaTrkRefitterTool::Cache	Cache

Public Member Functions
	egammaTrkRefitterTool (const std::string &, const std::string &, const IInterface *)
	Constructor with AlgTool parameters.
virtual	~egammaTrkRefitterTool ()=default
	Destructor.
virtual StatusCode	initialize () override
	AlgTool initialise method.
virtual StatusCode	finalize () override
	AlgTool finalise method.
virtual StatusCode	refitTrack (const EventContext &ctx, const Trk::Track *, Cache &cache) const override final
	Refit a track.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Alg tool and IAlgTool interface method.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::vector< const Trk::MeasurementBase * >	getIDHits (const Trk::Track *track) const
	Get the hits from the Inner Detector.
MeasurementsAndTrash	addPointsToTrack (const EventContext &ctx, const Trk::Track track, const xAOD::Electron eg=nullptr) const
	Adds a beam spot to the Measurements passed to the track refitter.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< Trk::ITrackFitter >	m_ITrackFitter
	The track refitter.
ToolHandle< ICaloCluster_OnTrackBuilder >	m_CCOTBuilder { this, "CCOTBuilder", "CaloCluster_OnTrackBuilder", "" }
Gaudi::Property< int >	m_matEffects
	type of material interaction in extrapolation
Trk::ParticleHypothesis	m_ParticleHypothesis
	Particle Hypothesis.
const AtlasDetectorID *	m_idHelper
Gaudi::Property< bool >	m_useClusterPosition
Gaudi::Property< bool >	m_RemoveTRT
	Option to remove TRT hits from track.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 35 of file egammaTrkRefitterTool.h.

Member Typedef Documentation

◆ Cache

typedef IegammaTrkRefitterTool::Cache egammaTrkRefitterTool::Cache

Definition at line 55 of file egammaTrkRefitterTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ egammaTrkRefitterTool()

egammaTrkRefitterTool::egammaTrkRefitterTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor with AlgTool parameters.

Definition at line 26 of file egammaTrkRefitterTool.cxx.

  : AthAlgTool(type, name, parent)
  , m_ParticleHypothesis(Trk::electron)
  , m_idHelper(nullptr)
{
  declareInterface<IegammaTrkRefitterTool>(this);
}

◆ ~egammaTrkRefitterTool()

virtual egammaTrkRefitterTool::~egammaTrkRefitterTool ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addPointsToTrack()

egammaTrkRefitterTool::MeasurementsAndTrash egammaTrkRefitterTool::addPointsToTrack	(	const EventContext &	ctx,
		const Trk::Track *	track,
		const xAOD::Electron *	eg = nullptr ) const

private

Adds a beam spot to the Measurements passed to the track refitter.

Definition at line 135 of file egammaTrkRefitterTool.cxx.

{
  egammaTrkRefitterTool::MeasurementsAndTrash collect{};
  /* The issue here is that some of the returned measurements are owned by
   * storegate some not. For the ones that are not put them in a vector of
   * unique_ptr which we will also return to the caller*/
  if (m_useClusterPosition && eg->caloCluster()) {
    int charge(0);
    if (track->perigeeParameters()) {
      charge = (int)track->perigeeParameters()->charge();
    }
    std::unique_ptr<const Trk::CaloCluster_OnTrack> ccot(
      m_CCOTBuilder->buildClusterOnTrack(ctx, eg->caloCluster(), charge));
    if (ccot != nullptr) {
      collect.m_trash.push_back(std::move(ccot));
      collect.m_measurements.push_back(collect.m_trash.back().get());
    }
  }
  std::vector<const Trk::MeasurementBase*> vecIDHits = getIDHits(track);
  std::vector<const Trk::MeasurementBase*>::const_iterator it =
      vecIDHits.begin();
  std::vector<const Trk::MeasurementBase*>::const_iterator itend =
      vecIDHits.end();
  // Fill the track , these are not trash
  for (; it != itend; ++it) {
    collect.m_measurements.push_back(*it);
  }
  return collect;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode egammaTrkRefitterTool::finalize ( )

overridevirtual

AlgTool finalise method.

Definition at line 56 of file egammaTrkRefitterTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ getIDHits()

std::vector< const Trk::MeasurementBase * > egammaTrkRefitterTool::getIDHits ( const Trk::Track * track ) const

private

Get the hits from the Inner Detector.

Definition at line 168 of file egammaTrkRefitterTool.cxx.

{
 
  //store measurement to fit in the measurementSet
  std::vector<const Trk::MeasurementBase*> measurementSet;
  measurementSet.reserve(track->trackStateOnSurfaces()->size());
 
  for (const auto* tsos : *(track->trackStateOnSurfaces())) {
    if (!tsos) {
      ATH_MSG_WARNING(
          "This track contains an empty TrackStateOnSurface "
          "that won't be included in the fit");
      continue;
    }
    if (tsos->type(Trk::TrackStateOnSurface::Measurement) ||
        tsos->type(Trk::TrackStateOnSurface::Outlier)) {
 
      const auto* meas = tsos->measurementOnTrack();
      if (meas) {
        const Trk::RIO_OnTrack* rio = nullptr;
        if (meas->type(Trk::MeasurementBaseType::RIO_OnTrack)) {
          rio = static_cast<const Trk::RIO_OnTrack*>(meas);
        }
        if (rio != nullptr) {
          const Identifier& surfaceID = (rio->identify());
          if (m_idHelper->is_sct(surfaceID) ||
              m_idHelper->is_pixel(surfaceID) ||
              (!m_RemoveTRT && m_idHelper->is_trt(surfaceID))) {
            measurementSet.push_back(meas);
          }
        }
      }
    }
  }
  return measurementSet;
}

◆ initialize()

StatusCode egammaTrkRefitterTool::initialize ( )

overridevirtual

AlgTool initialise method.

Definition at line 37 of file egammaTrkRefitterTool.cxx.

{
  // Retrieve fitter
  ATH_CHECK(m_ITrackFitter.retrieve());
 
  ATH_CHECK(detStore()->retrieve(m_idHelper, "AtlasID"));
 
  // configure calo cluster on track builder (only if used)
  if (m_useClusterPosition) {
    ATH_CHECK(m_CCOTBuilder.retrieve());
  } else {
    m_CCOTBuilder.disable();
  }
  // Set the particle hypothesis to match the material effects
  m_ParticleHypothesis = Trk::ParticleSwitcher::particle[m_matEffects];
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & IegammaTrkRefitterTool::interfaceID ( )

inlinestaticinherited

Alg tool and IAlgTool interface method.

Definition at line 34 of file IegammaTrkRefitterTool.h.

35 { return IID_egammaTrkRefitterTool; };

IID_egammaTrkRefitterTool

static const InterfaceID IID_egammaTrkRefitterTool("IegammaTrkRefitterTool", 1, 0)

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ refitTrack()

StatusCode egammaTrkRefitterTool::refitTrack	(	const EventContext &	ctx,
		const Trk::Track *	track,
		Cache &	cache ) const

finaloverridevirtual

Refit a track.

Implements IegammaTrkRefitterTool.

Definition at line 62 of file egammaTrkRefitterTool.cxx.

{
  cache.refittedTrack = nullptr;
  cache.refittedTrackPerigee = nullptr;
  cache.originalTrack = nullptr;
  cache.originalTrackPerigee = nullptr;
  if (!track) {
    return StatusCode::FAILURE;
  }
  // Set the pointer to the track
  cache.originalTrack = track;
 
  // Set pointer to the original perigee
  cache.originalTrackPerigee = cache.originalTrack->perigeeParameters();
 
  if (cache.originalTrackPerigee != nullptr) {
    double od0 = cache.originalTrackPerigee->parameters()[Trk::d0];
    double oz0 = cache.originalTrackPerigee->parameters()[Trk::z0];
    double ophi0 = cache.originalTrackPerigee->parameters()[Trk::phi0];
    double otheta = cache.originalTrackPerigee->parameters()[Trk::theta];
    double oqOverP = cache.originalTrackPerigee->parameters()[Trk::qOverP];
    ATH_MSG_DEBUG("Original parameters " << od0 << " " << oz0 << " " << ophi0
                                         << " " << otheta << " " << oqOverP
                                         << " " << 1 / oqOverP);
  } else {
    ATH_MSG_WARNING("Could not get Trk::Perigee of original track");
  }
 
  // Refit the track with the beam spot if desired otherwise just refit the
  // original track
  if (m_useClusterPosition) {
    egammaTrkRefitterTool::MeasurementsAndTrash collect =
      addPointsToTrack(ctx, cache.originalTrack, cache.electron);
    if (collect.m_measurements.size() > 4) {
      cache.refittedTrack =
        m_ITrackFitter->fit(ctx,
                            collect.m_measurements,
                            *cache.originalTrack->perigeeParameters(),
                            false,
                            m_ParticleHypothesis);
    } else {
      cache.refittedTrack = nullptr;
    }
  } else {
    std::vector<const Trk::MeasurementBase*> measurements =
      getIDHits(cache.originalTrack);
    if (measurements.size() > 4) {
      cache.refittedTrack =
        m_ITrackFitter->fit(ctx,
                            measurements,
                            *cache.originalTrack->perigeeParameters(),
                            false,
                            m_ParticleHypothesis);
    } else {
      cache.refittedTrack = nullptr;
    }
  }
 
  // Store refitted perigee pointers
  if (cache.refittedTrack) {
    cache.refittedTrackPerigee = cache.refittedTrack->perigeeParameters();
    if (cache.refittedTrackPerigee == nullptr) {
      ATH_MSG_WARNING("Could not get refitted Trk::Perigee");
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_CCOTBuilder

ToolHandle<ICaloCluster_OnTrackBuilder> egammaTrkRefitterTool::m_CCOTBuilder { this, "CCOTBuilder", "CaloCluster_OnTrackBuilder", "" }

private

Definition at line 92 of file egammaTrkRefitterTool.h.

92{ this, "CCOTBuilder", "CaloCluster_OnTrackBuilder", "" };

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_idHelper

const AtlasDetectorID* egammaTrkRefitterTool::m_idHelper

private

Definition at line 105 of file egammaTrkRefitterTool.h.

◆ m_ITrackFitter

ToolHandle<Trk::ITrackFitter> egammaTrkRefitterTool::m_ITrackFitter

private

Initial value:

{
    this,
    "FitterTool",
    "Trk__GaussianSumFitter/GSFTrackFitter",
    "ToolHandle for track fitter implementation"
  }

The track refitter.

Definition at line 84 of file egammaTrkRefitterTool.h.

                                            {
    this,
    "FitterTool",
    "Trk__GaussianSumFitter/GSFTrackFitter",
    "ToolHandle for track fitter implementation"
  };

◆ m_matEffects

Gaudi::Property<int> egammaTrkRefitterTool::m_matEffects

private

Initial value:

{
    this,
    "matEffects",
    1,
    "Type of material interaction in extrapolation (Default Electron)"
  }

type of material interaction in extrapolation

Definition at line 95 of file egammaTrkRefitterTool.h.

                                 {
    this,
    "matEffects",
    1,
    "Type of material interaction in extrapolation (Default Electron)"
  };

◆ m_ParticleHypothesis

Trk::ParticleHypothesis egammaTrkRefitterTool::m_ParticleHypothesis

private

Particle Hypothesis.

Definition at line 103 of file egammaTrkRefitterTool.h.

◆ m_RemoveTRT

Gaudi::Property<bool> egammaTrkRefitterTool::m_RemoveTRT

private

Initial value:

{ this,
                                     "RemoveTRTHits",
                                     false,
                                     "RemoveTRT Hits" }

Option to remove TRT hits from track.

Definition at line 115 of file egammaTrkRefitterTool.h.

                                 { this,
                                     "RemoveTRTHits",
                                     false,
                                     "RemoveTRT Hits" };

◆ m_useClusterPosition

Gaudi::Property<bool> egammaTrkRefitterTool::m_useClusterPosition

private

Initial value:

{
    this,
    "useClusterPosition",
    false,
    "Switch to control use of Cluster position measurement"
  }

Definition at line 107 of file egammaTrkRefitterTool.h.

                                          {
    this,
    "useClusterPosition",
    false,
    "Switch to control use of Cluster position measurement"
  };

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Cache

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ egammaTrkRefitterTool()

◆ ~egammaTrkRefitterTool()

Member Function Documentation

◆ addPointsToTrack()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getIDHits()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ refitTrack()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_CCOTBuilder

◆ m_detStore

◆ m_evtStore

◆ m_idHelper

◆ m_ITrackFitter

◆ m_matEffects

◆ m_ParticleHypothesis

◆ m_RemoveTRT

◆ m_useClusterPosition

◆ m_varHandleArraysDeclared

◆ m_vhka