#include <TrackCollectionCnvTool.h>

Inheritance diagram for xAODMaker::TrackCollectionCnvTool:

Collaboration diagram for xAODMaker::TrackCollectionCnvTool:

Public Member Functions
	TrackCollectionCnvTool (const std::string &type, const std::string &name, const IInterface *parent)
	Regular AlgTool constructor.
virtual StatusCode	initialize () override
	Function initialising the tool.
virtual StatusCode	convert (const TrackCollection aod, xAOD::TrackParticleContainer xaod, const xAOD::Vertex *vtx=nullptr) const override
	Function that fills an existing xAOD::TrackParticleContainer.
virtual StatusCode	convertAndAugment (const TrackCollection aod, xAOD::TrackParticleContainer xaod, const ObservedTrackMap trk_map, const xAOD::Vertex vtx=nullptr) const override
	Function that fills an existing xAOD::TrackParticleContainer and augments track particles.
virtual StatusCode	setParticleCreatorTool (ToolHandle< Trk::ITrackParticleCreatorTool > *tool) override
	allow other algorithms to pass the tool in order to preserve initialisation
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 ()
	Gaudi interface definition.

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
xAOD::TrackParticle *	createParticle (xAOD::TrackParticleContainer &xaod, const TrackCollection &container, const Trk::Track &tp, const xAOD::Vertex *vtx) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< Trk::ITrackParticleCreatorTool >	m_particleCreator
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 27 of file TrackCollectionCnvTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrackCollectionCnvTool()

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

Regular AlgTool constructor.

Definition at line 16 of file TrackCollectionCnvTool.cxx.

    : AthAlgTool( type, name, parent ),
      m_particleCreator("Trk::TrackParticleCreatorTool/TrackParticleCreatorTool")
  {
    
    // Declare the interface(s) provided by the tool:
    declareInterface< ITrackCollectionCnvTool >( this );
    declareProperty("TrackParticleCreator", m_particleCreator, "creator of xAOD::TrackParticles");
  }

Member Function Documentation

◆ convert()

StatusCode xAODMaker::TrackCollectionCnvTool::convert	(	const TrackCollection *	aod,
		xAOD::TrackParticleContainer *	xaod,
		const xAOD::Vertex *	vtx = nullptr ) const

overridevirtual

Function that fills an existing xAOD::TrackParticleContainer.

Implements xAODMaker::ITrackCollectionCnvTool.

Definition at line 36 of file TrackCollectionCnvTool.cxx.

                                                                                          {
    
    ATH_MSG_DEBUG( "Sizes of containers before conversion: aod, xaod: " << aod->size() << ", " << xaod->size() );
    
    TrackCollection::const_iterator itr = aod->begin();
    TrackCollection::const_iterator end = aod->end();
 
    for( ;itr!=end;++itr ) {
      // Create the xAOD object:
      if (!(*itr)) {
        ATH_MSG_WARNING("Empty element in container!");
        continue;
      }
      xAOD::TrackParticle* particle = createParticle(*xaod, *aod, **itr, vtx);
 
      if (!particle) {
        ATH_MSG_WARNING("Failed to create a TrackParticle");
        continue;
      }
    }
 
    ATH_MSG_DEBUG( "Sizes of containers after conversion: aod, xaod: " << aod->size() << ", " << xaod->size() );
 
    return StatusCode::SUCCESS;    
  }

◆ convertAndAugment()

StatusCode xAODMaker::TrackCollectionCnvTool::convertAndAugment	(	const TrackCollection *	aod,
		xAOD::TrackParticleContainer *	xaod,
		const ObservedTrackMap *	trk_map,
		const xAOD::Vertex *	vtx = nullptr ) const

overridevirtual

Function that fills an existing xAOD::TrackParticleContainer and augments track particles.

Implements xAODMaker::ITrackCollectionCnvTool.

Definition at line 63 of file TrackCollectionCnvTool.cxx.

                                                                                                                           {
        
    ATH_MSG_DEBUG( "convertAndAugment: Sizes of containers before conversion: aod, xaod: " << aod->size() << ", " << xaod->size() );
    ATH_MSG_DEBUG( "convertAndAugment: Size of track map: " << trk_map->size() );
    
    TrackCollection::const_iterator itr = aod->begin();
    TrackCollection::const_iterator end = aod->end();
    ObservedTrackMap::const_iterator itrMap = trk_map->begin();
 
    // Check size of track collection matches size of observed tracks map
    if(aod->size() != trk_map->size()){
      ATH_MSG_ERROR("convertAndAugment: Number of tracks different in collection to convert vs. observed tracks map: "<<aod->size()<<" vs. "<<trk_map->size());
      return StatusCode::FAILURE;
    }
 
    for( ;itr!=end;++itr ) {
      // Create the xAOD object:
      if (!(*itr)) {
        ATH_MSG_WARNING("convertAndAugment: Empty element in container!");
        continue;
      }
      xAOD::TrackParticle* particle = createParticle(*xaod, *aod, **itr, vtx);
      if(!particle){
        ATH_MSG_WARNING("convertAndAugment: Failed to create a TrackParticle");
        ++itrMap;
        continue;
      }
      // Augment xAOD object with information from track map
      static const SG::Decorator<long int> IdDec           ("Id");
      IdDec (*particle)                = (*itrMap).first;
 
#define DECORATE2(NAME, SEL, TYPE)                                      \
      static const SG::Decorator<TYPE> NAME##Dec (#NAME);               \
        NAME##Dec(*particle) = std::get<xAOD::ObserverToolIndex::SEL>((*itrMap).second)
#define DECORATE(NAME, TYPE) DECORATE2(NAME, NAME, TYPE)
      DECORATE(score, double);
      DECORATE(rejectStep, int);
      DECORATE(rejectReason, int);
      DECORATE(parentId, long int);
      DECORATE(numPixelHoles, int);
      DECORATE(numSCTHoles, int);
      DECORATE(numSplitSharedPixel, int);
      DECORATE(numSplitSharedSCT, int);
      DECORATE(numSharedOrSplit, int);
      DECORATE(numSharedOrSplitPixels, int);
      DECORATE(numShared, int);
      DECORATE(isPatternTrack, int);
      DECORATE(totalSiHits, int);
      DECORATE(inROI, int);
      DECORATE2(thishasblayer, hasIBLHit, int);
      DECORATE2(hassharedblayer, hasSharedIBLHit, int);
      DECORATE2(hassharedpixel, hasSharedPixel, int);
      DECORATE2(firstisshared, firstPixIsShared, int);
      DECORATE(numPixelDeadSensor, int);
      DECORATE(numSCTDeadSensor, int);
      DECORATE(numPixelHits, int);
      DECORATE(numSCTHits, int);
      DECORATE(numUnused, int);
      DECORATE(numTRT_Unused, int);
      DECORATE(numSCT_Unused, int);
      DECORATE(numPseudo, int);
      DECORATE(averageSplit1, int);
      DECORATE(averageSplit2, int);
      DECORATE(numWeightedShared, int);
#undef DECORATE
#undef DECORATE2
 
      const std::vector<xAOD::RejectionStep>& v_rejectStep =
        std::get<xAOD::ObserverToolIndex::rejectStep_full>((*itrMap).second);
      const std::vector<xAOD::RejectionReason>& v_rejectReason =
        std::get<xAOD::ObserverToolIndex::rejectReason_full>((*itrMap).second);
      static const SG::Decorator<std::vector<int> > rejectStep_fullDec ("rejectStep_full");
      static const SG::Decorator<std::vector<int> > rejectReason_fullDec ("rejectReason_full");
      rejectStep_fullDec(*particle).assign (v_rejectStep.begin(), v_rejectStep.end());
      rejectReason_fullDec(*particle).assign (v_rejectReason.begin(), v_rejectReason.end());
      ATH_MSG_DEBUG("convertAndAugment: Augmenting TrackParticle with id "
                    << IdDec(*particle) << " and rejectReason "
                    << rejectReasonDec(*particle)
                    << " (has chi2 = " << particle->chiSquared() << ")");
      ++itrMap;
    }
    ATH_MSG_DEBUG(
      "convertAndAugment: Sizes of containers after conversion: aod, xaod: "
      << aod->size() << ", " << xaod->size());
    return StatusCode::SUCCESS;    
  }

◆ createParticle()

xAOD::TrackParticle * xAODMaker::TrackCollectionCnvTool::createParticle	(	xAOD::TrackParticleContainer &	xaod,
		const TrackCollection &	container,
		const Trk::Track &	tp,
		const xAOD::Vertex *	vtx ) const

inlineprivate

Definition at line 151 of file TrackCollectionCnvTool.cxx.

                                                 {
    // create the xAOD::TrackParticle, the pointer is added to the container in the function
    ElementLink<TrackCollection> trackLink( &tp, container );
    return m_particleCreator->createParticle( trackLink, &xaod , vtx);
    //no!    return m_particleCreator->createParticle( tp, &xaod );
  }

◆ 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

◆ initialize()

StatusCode xAODMaker::TrackCollectionCnvTool::initialize ( )

overridevirtual

Function initialising the tool.

Definition at line 28 of file TrackCollectionCnvTool.cxx.

                                                {
    // Greet the user:
    ATH_MSG_INFO( "Initializing TrackCollectionCnvTool with " << m_particleCreator.name() );
    ATH_CHECK( m_particleCreator.retrieve() );
    
    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 & xAODMaker::ITrackCollectionCnvTool::interfaceID ( )

inlinestaticinherited

Gaudi interface definition.

Definition at line 47 of file ITrackCollectionCnvTool.h.

                                            {
      return IID_ITrackCollectionCnvTool;
    }

◆ 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.

◆ 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();
  }

◆ setParticleCreatorTool()

StatusCode xAODMaker::TrackCollectionCnvTool::setParticleCreatorTool ( ToolHandle< Trk::ITrackParticleCreatorTool > * tool )

overridevirtual

allow other algorithms to pass the tool in order to preserve initialisation

Implements xAODMaker::ITrackCollectionCnvTool.

Definition at line 161 of file TrackCollectionCnvTool.cxx.

  {
    ATH_MSG_DEBUG( "In setParticleCreatorTool" );
    m_particleCreator = *tool;
 
    return StatusCode::SUCCESS;
  }

◆ 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_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_particleCreator

ToolHandle<Trk::ITrackParticleCreatorTool> xAODMaker::TrackCollectionCnvTool::m_particleCreator

private

Definition at line 50 of file TrackCollectionCnvTool.h.

◆ 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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrackCollectionCnvTool()

Member Function Documentation

◆ convert()

◆ convertAndAugment()

◆ createParticle()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setParticleCreatorTool()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_particleCreator

◆ m_varHandleArraysDeclared

◆ m_vhka