Algorithm creating xAOD::TrackParticles from TrackParticles. More...

#include <TrackParticleCnvAlg.h>

Inheritance diagram for xAODMaker::TrackParticleCnvAlg:

Collaboration diagram for xAODMaker::TrackParticleCnvAlg:

Public Member Functions
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute (const EventContext &ctx) const
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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	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

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
StatusCode	convert (const EventContext &ctx, const TrackCollection &trackColl, const TrackTruthCollection assocTruthColl, xAOD::TrackParticleContainer &outTrackCont, const xAODTruthParticleLinkVector , const xAOD::Vertex primaryVertex, const ObservedTrackMap obs_track_map) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< bool >	m_addTruthLink {this,"AddTruthLink", false }
	toggle on adding truth links
ToolHandle< Trk::ITrackParticleCreatorTool >	m_particleCreator {this, "TrackParticleCreator", "Trk::TrackParticleCreatorTool/TrackParticleCreatorTool" }
	The key for the input TrackParticleTruthCollection.
ToolHandle< IMCTruthClassifier >	m_truthClassifier
	ToolHandle to truth classifier.
ToolHandle< xAODMaker::ITrackCollectionCnvTool >	m_TrackCollectionCnvTool {this, "TrackCollectionCnvTool", "xAODMaker::TrackCollectionCnvTool/TrackCollectionCnvTool"}
SG::ReadHandleKey< TrackCollection >	m_tracks {this, "TrackContainerName", "Tracks"}
SG::ReadHandleKey< xAOD::VertexContainer >	m_primaryVertexContainer { this, "PrimaryVerticesName", "", "Name of primary vertex container is case the parameters should be calculated with respect to the primary vertex"}
SG::WriteHandleKey< xAOD::TrackParticleContainer >	m_xaodout {this, "xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_truthTypeKey {this, "TruthTypeKey", m_xaodout, "truthType"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_truthOriginKey {this, "TruthOriginKey", m_xaodout, "truthOrigin"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_truthClassKey {this, "TruthClassKey", m_xaodout, "truthClassification"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_truthProbKey {this, "TruthMatchProbKey", m_xaodout, "truthMatchProbability"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_trackLinkKey {this, "TrackLinkKey", m_xaodout, "trackLink"}
SG::ReadHandleKey< xAODTruthParticleLinkVector >	m_truthParticleLinkVec {this, "xAODTruthLinkVector", "xAODTruthLinks"}
SG::ReadHandleKey< TrackTruthCollection >	m_trackTruth {this, "TrackTruthContainerName", ""}
Gaudi::Property< bool >	m_doMonitoring {this, "DoMonitoring", false}
ToolHandle< ITrackParticleMonitoring >	m_trackMonitoringTool { this, "TrkMonTool", "", "Tracking Monitoring tool" }
ToolHandle< GenericMonitoringTool >	m_monTool { this, "MonTool", "", "Monitoring tool" }
Gaudi::Property< bool >	m_augmentObservedTracks {this, "AugmentObservedTracks", false, "augment observed tracks"}
SG::ReadHandleKey< ObservedTrackMap >	m_tracksMap {this, "TracksMapName", "" , "name of observed tracks map saved in store"}
Gaudi::Property< bool >	m_convertTracks {this, "ConvertTracks", false}
	toggle on converting tracks to xAOD
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Algorithm creating xAOD::TrackParticles from TrackParticles.

   This algorithm can be used to translate the TrackParticles coming
   from an AOD, and create xAOD::TrackParticle objects out of them
   for an output xAOD.

Author: Edward Moyse Edwar.nosp@m.d.Mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 48 of file TrackParticleCnvAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ convert()

StatusCode xAODMaker::TrackParticleCnvAlg::convert	(	const EventContext &	ctx,
		const TrackCollection &	trackColl,
		const TrackTruthCollection *	assocTruthColl,
		xAOD::TrackParticleContainer &	outTrackCont,
		const xAODTruthParticleLinkVector *	truthLinkVec,
		const xAOD::Vertex *	primaryVertex,
		const ObservedTrackMap *	obs_track_map ) const

private

Definition at line 121 of file TrackParticleCnvAlg.cxx.

                                                                                    {
  // Augment track particles using track map if available
  if (obs_track_map){
    ATH_CHECK(m_TrackCollectionCnvTool->convertAndAugment(ctx, &trackColl, &outTrackCont, obs_track_map, primaryVertex));
  } else{
    ATH_CHECK(m_TrackCollectionCnvTool->convert(ctx, &trackColl, &outTrackCont, primaryVertex));
  }
  // Create the xAOD objects:
 
   unsigned int trackCounter{0};
  // loop over AOD and converted xAOD for summary info and truth links
  for (xAOD::TrackParticle* particle: outTrackCont) {
    // protect if something went wrong and there is no converted xaod equivalent
 
    if (!particle) {
      ATH_MSG_ERROR("Failed to get an xAOD::TrackParticle");
      return StatusCode::FAILURE;
    }
 
    trackCounter++;
    if(msgLvl(MSG::DEBUG)){
      int npix{-1}, nsct{-1}, ntrt{-1}, npixh{-1}, nscth{-1};
      const Trk::Track *tr = particle->track();
      if (tr){
        const Trk::TrackSummary* ts = tr->trackSummary();
        if (ts) {
          npix = ts->get(Trk::numberOfPixelHits);
          nsct = ts->get(Trk::numberOfSCTHits);
          ntrt = ts->get(Trk::numberOfTRTHits);
          nscth = ts->get(Trk::numberOfSCTHoles);
          npixh = ts->get(Trk::numberOfPixelHoles);
        }
      }
      ATH_MSG_DEBUG("REGTEST: " << std::setw(5) << trackCounter
                    << "  pT:  " << std::setw(10) << particle->pt()
                    << "  eta: " << particle->eta() << "  phi: " << particle->phi()
                    << "  d0:  " << particle->d0()  << "  z0:  " << particle->z0()
                    << "\t" << npix << "/" << nsct << "/" << ntrt << "/holes/" << npixh << "/" << nscth);
    }
    //
    // --------- statistics
    //
    if (m_addTruthLink) {
      MCTruthPartClassifier::ParticleType type = MCTruthPartClassifier::Unknown;
      MCTruthPartClassifier::ParticleOrigin origin =
        MCTruthPartClassifier::NonDefined;
      unsigned int classification = 0; // Better default value here?
      float probability = -1.0;
      ElementLink<xAOD::TruthParticleContainer> link;
 
      ElementLink<TrackCollection> tpLink{trackColl, trackCounter -1};
      if (!tpLink.isValid()) {
        ATH_MSG_WARNING("Failed to create ElementLink to Track/TrackParticle");
      } else if(assocTruthColl->empty()){
        // This can happen if there is no HS track
        ATH_MSG_DEBUG("No truth available");
      } else {
        auto result = assocTruthColl->find(tpLink);
        if (result == assocTruthColl->end()) {
          ATH_MSG_WARNING("Failed find truth associated with Track/TrackParticle");
        } else {
          // setTruthLink(link,result->second, type, origin);
          ATH_MSG_VERBOSE("Found track Truth: uniqueID  "
                          << HepMC::uniqueID(result->second.particleLink()) << " evt "
                          << result->second.particleLink().eventIndex());
          probability = result->second.probability();
          link = truthLinkVec->find(result->second.particleLink());
          if (link.isValid()) {
            ATH_MSG_DEBUG("Found matching xAOD Truth: uniqueID "
                          << HepMC::uniqueID(*link) << " pt " << (*link)->pt()
                          << " eta " << (*link)->eta() << " phi "
                          << (*link)->phi());
            // if configured also get truth classification
            if (result->second.particleLink().cptr() &&
                !m_truthClassifier.empty()) {
              auto truthClass = m_truthClassifier->particleHepMCTruthClassifier(
                result->second.particleLink());
              type = truthClass.first;
              origin = truthClass.second;
              classification = std::get<0>(MCTruthPartClassifier::defOrigOfParticle(result->second.particleLink().cptr())); // See AGENE-2351
              ATH_MSG_VERBOSE("Got truth type  " << static_cast<int>(type)
                                                 << "  origin "
                                                 << static_cast<int>(origin)
                                                 << "  classification "
                                                 << static_cast<unsigned int>(classification));
            }
          } else {
            if (HepMC::uniqueID(result->second.particleLink()) > 0) {
              ATH_MSG_WARNING("No associated xAOD truth for valid truth link "
                              << result->second.particleLink());
            }
          }
        }
      }
      //This is the Algorithm creating TrackParticles
      //
      static const SG::AuxElement::Accessor<
        ElementLink<xAOD::TruthParticleContainer>>
        theLink("truthParticleLink");
      static const SG::AuxElement::Accessor<float> theProbability(
        "truthMatchProbability");
      theLink(*particle) = link;
      theProbability(*particle) = probability;
      if (!m_truthClassifier.empty()) {
        static const SG::AuxElement::Accessor<int> theType("truthType");
        static const SG::AuxElement::Accessor<int> theOrigin("truthOrigin");
        static const SG::AuxElement::Accessor<unsigned int> theClassification("truthClassification");
        theType(*particle) = static_cast<int>(type);
        theOrigin(*particle) = static_cast<int>(origin);
        theClassification(*particle) = static_cast<unsigned int>(classification);
      }
    }
  } // loop over aod tracks
 
  ATH_MSG_DEBUG("Converted [" << trackColl.size() << " -> " << outTrackCont.size()
                              << "] TrackParticles");
  if (trackColl.size() != outTrackCont.size()) {
    ATH_MSG_ERROR("number of items in the AOD container: "
                    << trackColl.size()
                    << " is not equal to the number of items in its converted "
                       "xAOD equivalent: "
                    << outTrackCont.size());
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode xAODMaker::TrackParticleCnvAlg::execute ( const EventContext & ctx ) const

virtual

Function executing the algorithm.

Definition at line 56 of file TrackParticleCnvAlg.cxx.

                                                                     {
 
  const TrackCollection* tracks{};
  const xAODTruthParticleLinkVector* truthLinks{};
  const TrackTruthCollection* trackTruth{};
  const ObservedTrackMap* tracksMap{};
  const xAOD::Vertex* primaryVertex{};
 
  //timer object for total execution time
  auto mnt_timer_Total  = Monitored::Timer<std::chrono::milliseconds>("TIME_Total");
 
  // Retrieve the AOD particles:
 
  ATH_CHECK(SG::get(tracks, m_tracks, ctx));
  ATH_CHECK(SG::get(trackTruth, m_trackTruth, ctx));
  ATH_CHECK(SG::get(truthLinks, m_truthParticleLinkVec, ctx));
  ATH_CHECK(SG::get(tracksMap, m_tracksMap, ctx));
  // Retrieve the Tracks:
  
  if(!m_primaryVertexContainer.key().empty()) {
    const xAOD::VertexContainer* vtx_container{nullptr};
    ATH_CHECK(SG::get(vtx_container, m_primaryVertexContainer, ctx));
    const xAOD::Vertex* dummyVertex{};
    for(auto vtx : *vtx_container) {
      if(vtx->vertexType()==xAOD::VxType::PriVtx) {
        primaryVertex = vtx;
        break;
      }
      if(vtx->vertexType()==xAOD::VxType::NoVtx) {
        // in case of no primary vertex
        dummyVertex = vtx;
      }
    }
    if(!primaryVertex) {
      if(dummyVertex)
      {
        ATH_MSG_INFO("No primary vertex found, will use dummy vertex at "
                     << dummyVertex->x() << "," << dummyVertex->y() << ","
                     << dummyVertex->z());
        primaryVertex = dummyVertex;
      }
      else {
        ATH_MSG_WARNING("Neither primary nor dummy vertex found. Do Nothing.");
        return StatusCode::SUCCESS;
      }
    }
  }
 
  
  SG::WriteHandle wh_xaodout(m_xaodout, ctx);
  ATH_CHECK(wh_xaodout.record(std::make_unique<xAOD::TrackParticleContainer>(),
                              std::make_unique<xAOD::TrackParticleAuxContainer>()));
  ATH_CHECK(convert(ctx, (*tracks), trackTruth, *wh_xaodout, truthLinks, primaryVertex, tracksMap));
 
    // Monitor track parameters
    if (m_doMonitoring)
      m_trackMonitoringTool->monitor_tracks("Track", "Pass", *wh_xaodout);
  
 
  //extra scope needed to trigger the monitoring
  {auto monTime = Monitored::Group(m_monTool, mnt_timer_Total);}
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

◆ initialize()

StatusCode xAODMaker::TrackParticleCnvAlg::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 24 of file TrackParticleCnvAlg.cxx.

{
 
  ATH_MSG_DEBUG("Initializing TrackParticleCnvAlg");
  ATH_CHECK(m_particleCreator.retrieve());
  ATH_CHECK(m_truthClassifier.retrieve(EnableTool{m_addTruthLink}));
  ATH_CHECK(m_TrackCollectionCnvTool.retrieve());
  // to preserve the inisialised parameters of the ParticleCreatorTool:
  ATH_MSG_DEBUG("Overriding particle creator tool settings.");
  ATH_CHECK(m_TrackCollectionCnvTool->setParticleCreatorTool(&m_particleCreator));
  ATH_CHECK(m_xaodout.initialize(m_convertTracks));
  ATH_CHECK(m_tracks.initialize(m_convertTracks));
  ATH_CHECK(m_primaryVertexContainer.initialize(!m_primaryVertexContainer.key().empty()));
  ATH_CHECK(m_truthParticleLinkVec.initialize(m_addTruthLink));
  ATH_CHECK(m_trackTruth.initialize(m_addTruthLink && m_convertTracks));
 
  ATH_CHECK(m_truthTypeKey.initialize(m_addTruthLink));
  ATH_CHECK(m_truthOriginKey.initialize(m_addTruthLink));
  ATH_CHECK(m_truthClassKey.initialize(m_addTruthLink));
  ATH_CHECK(m_truthProbKey.initialize(m_addTruthLink));
  ATH_CHECK(m_trackLinkKey.initialize());
 
  // Retrieve monitoring tools if provided
  ATH_CHECK(m_trackMonitoringTool.retrieve(DisableTool{ !m_doMonitoring }));
  ATH_CHECK(m_monTool.retrieve(DisableTool{ !m_doMonitoring }));
 
  ATH_CHECK(m_tracksMap.initialize(m_augmentObservedTracks));
 
  // Return gracefully:
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

◆ sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_addTruthLink

Gaudi::Property<bool> xAODMaker::TrackParticleCnvAlg::m_addTruthLink {this,"AddTruthLink", false }

private

toggle on adding truth links

Definition at line 62 of file TrackParticleCnvAlg.h.

62{this,"AddTruthLink", false };

◆ m_augmentObservedTracks

Gaudi::Property<bool> xAODMaker::TrackParticleCnvAlg::m_augmentObservedTracks {this, "AugmentObservedTracks", false, "augment observed tracks"}

private

Definition at line 99 of file TrackParticleCnvAlg.h.

99{this, "AugmentObservedTracks", false, "augment observed tracks"};

◆ m_convertTracks

Gaudi::Property<bool> xAODMaker::TrackParticleCnvAlg::m_convertTracks {this, "ConvertTracks", false}

private

toggle on converting tracks to xAOD

Definition at line 103 of file TrackParticleCnvAlg.h.

103{this, "ConvertTracks", false};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doMonitoring

Gaudi::Property<bool> xAODMaker::TrackParticleCnvAlg::m_doMonitoring {this, "DoMonitoring", false}

private

Definition at line 92 of file TrackParticleCnvAlg.h.

92{this, "DoMonitoring", false};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_monTool

ToolHandle<GenericMonitoringTool > xAODMaker::TrackParticleCnvAlg::m_monTool { this, "MonTool", "", "Monitoring tool" }

private

Definition at line 96 of file TrackParticleCnvAlg.h.

96{ this, "MonTool", "", "Monitoring tool" };

◆ m_particleCreator

ToolHandle<Trk::ITrackParticleCreatorTool> xAODMaker::TrackParticleCnvAlg::m_particleCreator {this, "TrackParticleCreator", "Trk::TrackParticleCreatorTool/TrackParticleCreatorTool" }

private

The key for the input TrackParticleTruthCollection.

ToolHandle to particle creator

Definition at line 67 of file TrackParticleCnvAlg.h.

67{this, "TrackParticleCreator", "Trk::TrackParticleCreatorTool/TrackParticleCreatorTool" };

◆ m_primaryVertexContainer

SG::ReadHandleKey<xAOD::VertexContainer> xAODMaker::TrackParticleCnvAlg::m_primaryVertexContainer { this, "PrimaryVerticesName", "", "Name of primary vertex container is case the parameters should be calculated with respect to the primary vertex"}

private

Definition at line 77 of file TrackParticleCnvAlg.h.

77{ this, "PrimaryVerticesName", "", "Name of primary vertex container is case the parameters should be calculated with respect to the primary vertex"};

◆ m_TrackCollectionCnvTool

ToolHandle<xAODMaker::ITrackCollectionCnvTool> xAODMaker::TrackParticleCnvAlg::m_TrackCollectionCnvTool {this, "TrackCollectionCnvTool", "xAODMaker::TrackCollectionCnvTool/TrackCollectionCnvTool"}

private

Definition at line 73 of file TrackParticleCnvAlg.h.

73{this, "TrackCollectionCnvTool", "xAODMaker::TrackCollectionCnvTool/TrackCollectionCnvTool"};

◆ m_trackLinkKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_trackLinkKey {this, "TrackLinkKey", m_xaodout, "trackLink"}

private

Definition at line 86 of file TrackParticleCnvAlg.h.

86{this, "TrackLinkKey", m_xaodout, "trackLink"};

◆ m_trackMonitoringTool

ToolHandle<ITrackParticleMonitoring> xAODMaker::TrackParticleCnvAlg::m_trackMonitoringTool { this, "TrkMonTool", "", "Tracking Monitoring tool" }

private

Definition at line 93 of file TrackParticleCnvAlg.h.

93{ this, "TrkMonTool", "", "Tracking Monitoring tool" };

◆ m_tracks

SG::ReadHandleKey<TrackCollection> xAODMaker::TrackParticleCnvAlg::m_tracks {this, "TrackContainerName", "Tracks"}

private

Definition at line 75 of file TrackParticleCnvAlg.h.

75{this, "TrackContainerName", "Tracks"};

◆ m_tracksMap

SG::ReadHandleKey<ObservedTrackMap> xAODMaker::TrackParticleCnvAlg::m_tracksMap {this, "TracksMapName", "" , "name of observed tracks map saved in store"}

private

Definition at line 100 of file TrackParticleCnvAlg.h.

100{this, "TracksMapName", "" , "name of observed tracks map saved in store"};

◆ m_trackTruth

SG::ReadHandleKey<TrackTruthCollection> xAODMaker::TrackParticleCnvAlg::m_trackTruth {this, "TrackTruthContainerName", ""}

private

Definition at line 89 of file TrackParticleCnvAlg.h.

89{this, "TrackTruthContainerName", ""};

◆ m_truthClassifier

ToolHandle<IMCTruthClassifier> xAODMaker::TrackParticleCnvAlg::m_truthClassifier

private

Initial value:

{this, "MCTruthClassifier", "MCTruthClassifier/MCTruthClassifier",

" MCTruthClassifier Instance to use "}

ToolHandle to truth classifier.

Definition at line 69 of file TrackParticleCnvAlg.h.

69 {this, "MCTruthClassifier", "MCTruthClassifier/MCTruthClassifier",

70 " MCTruthClassifier Instance to use "};

◆ m_truthClassKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_truthClassKey {this, "TruthClassKey", m_xaodout, "truthClassification"}

private

Definition at line 84 of file TrackParticleCnvAlg.h.

84{this, "TruthClassKey", m_xaodout, "truthClassification"};

◆ m_truthOriginKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_truthOriginKey {this, "TruthOriginKey", m_xaodout, "truthOrigin"}

private

Definition at line 83 of file TrackParticleCnvAlg.h.

83{this, "TruthOriginKey", m_xaodout, "truthOrigin"};

◆ m_truthParticleLinkVec

SG::ReadHandleKey<xAODTruthParticleLinkVector> xAODMaker::TrackParticleCnvAlg::m_truthParticleLinkVec {this, "xAODTruthLinkVector", "xAODTruthLinks"}

private

Definition at line 88 of file TrackParticleCnvAlg.h.

88{this, "xAODTruthLinkVector", "xAODTruthLinks"};

◆ m_truthProbKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_truthProbKey {this, "TruthMatchProbKey", m_xaodout, "truthMatchProbability"}

private

Definition at line 85 of file TrackParticleCnvAlg.h.

85{this, "TruthMatchProbKey", m_xaodout, "truthMatchProbability"};

◆ m_truthTypeKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_truthTypeKey {this, "TruthTypeKey", m_xaodout, "truthType"}

private

Definition at line 82 of file TrackParticleCnvAlg.h.

82{this, "TruthTypeKey", m_xaodout, "truthType"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_xaodout

SG::WriteHandleKey<xAOD::TrackParticleContainer> xAODMaker::TrackParticleCnvAlg::m_xaodout {this, "xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles"}

private

Definition at line 79 of file TrackParticleCnvAlg.h.

79{this, "xAODTrackParticlesFromTracksContainerName", "InDetTrackParticles"};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ convert()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_addTruthLink

◆ m_augmentObservedTracks

◆ m_convertTracks

◆ m_detStore

◆ m_doMonitoring

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_monTool

◆ m_particleCreator

◆ m_primaryVertexContainer

◆ m_TrackCollectionCnvTool

◆ m_trackLinkKey

◆ m_trackMonitoringTool

◆ m_tracks

◆ m_tracksMap

◆ m_trackTruth

◆ m_truthClassifier

◆ m_truthClassKey

◆ m_truthOriginKey

◆ m_truthParticleLinkVec

◆ m_truthProbKey

◆ m_truthTypeKey

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xaodout