#include <TrackToTruthAssociationAlg.h>

Inheritance diagram for ActsTrk::TrackToTruthAssociationAlg:

Collaboration diagram for ActsTrk::TrackToTruthAssociationAlg:

Classes
struct	AssociationCounter

Public Member Functions
	TrackToTruthAssociationAlg (const std::string &name, ISvcLocator *pSvcLocator)

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

virtual StatusCode	execute (const EventContext &ctx) const override

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ToolHandle< IActsTrackingGeometryTool >	m_trackingGeometryTool {this, "TrackingGeometryTool", ""}

SG::ReadHandleKey< ActsTrk::TrackContainer >	m_tracksContainerKey {this, "ACTSTracksLocation", "","Track collection (ActsTrk variant)"}

SG::ReadHandleKey< MeasurementToTruthParticleAssociation >	m_pixelClustersToTruth {this, "PixelClustersToTruthAssociationMap", "", "Association map from pixel measurements to generator particles." }

SG::ReadHandleKey< MeasurementToTruthParticleAssociation >	m_stripClustersToTruth {this, "StripClustersToTruthAssociationMap", "", "Association map from strip measurements to generator particles." }

SG::WriteHandleKey< TrackToTruthParticleAssociation >	m_trackToTruthOut {this, "AssociationMapOut", "", "Output association map from measurements to generator particles." }

Gaudi::Property< float >	m_maxEnergyLoss {this, "MaxEnergyLoss", 10e12, "Stop moving up the decay chain if the energy loss is above this value." }

ElasticDecayUtil< TrackToTruthParticleAssociationDebugHists >	m_elasticDecayUtil

std::conditional< TrackToTruthParticleAssociationDebugHists, Gaudi::Property< std::vector< float > >, EmptyProperty >::type	m_energyLossBinning {this, "EnergyLossBinning", {20.,0.,5.*s_unitGeV}, "Binning to be used for the energy loss histograms." }

AssociationCounter< TrackToTruthParticleAssociationDebugHists >	m_associationCounter

std::array< std::atomic< std::size_t >, s_NCounterForAssociatedTruth > m_nTracksWithAssociatedTruth	ATLAS_THREAD_SAFE {}

std::atomic< std::size_t >	m_nIncompatibleMeasurementContainer {}

std::atomic< std::size_t >	m_nCcompatibleMeasurementContainer {}

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

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Static Private Attributes
static constexpr float	s_unitGeV = 1e3

static constexpr unsigned int	s_NCounterForAssociatedTruth = 4

Detailed Description

Definition at line 44 of file TrackToTruthAssociationAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrackToTruthAssociationAlg()

ActsTrk::TrackToTruthAssociationAlg::TrackToTruthAssociationAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 30 of file TrackToTruthAssociationAlg.cxx.

       : AthReentrantAlgorithm(name, pSvcLocator)
   {
   }

Member Function Documentation

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & 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; }

◆ evtStore() [1/2]

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; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode ActsTrk::TrackToTruthAssociationAlg::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 111 of file TrackToTruthAssociationAlg.cxx.

   {
     std::unique_ptr<TrackToTruthParticleAssociation>
        track_association( std::make_unique<TrackToTruthParticleAssociation>() );
  
     SG::ReadHandle<ActsTrk::MeasurementToTruthParticleAssociation> pixelClustersToTruthAssociation = SG::makeHandle(m_pixelClustersToTruth, ctx);
     if (!pixelClustersToTruthAssociation.isValid()) {
        ATH_MSG_ERROR("No pixel clusterss for key " << m_pixelClustersToTruth.key() );
        return StatusCode::FAILURE;
     }
     SG::ReadHandle<ActsTrk::MeasurementToTruthParticleAssociation> stripClustersToTruthAssociation = SG::makeHandle(m_stripClustersToTruth, ctx);
     if (!stripClustersToTruthAssociation.isValid()) {
        ATH_MSG_ERROR("No strip clusterss for key " << m_stripClustersToTruth.key() );
        return StatusCode::FAILURE;
     }
     SG::ReadHandle<ActsTrk::TrackContainer> tracksContainer = SG::makeHandle( m_tracksContainerKey, ctx);
     if (!tracksContainer.isValid()) {
        ATH_MSG_ERROR("No tracks for key " << m_tracksContainerKey.key() );
        return StatusCode::FAILURE;
     }
     track_association->resize( tracksContainer->size() );
     track_association->setSourceContainer(DataLink<ActsTrk::TrackContainer>(*tracksContainer,ctx));
     Acts::GeometryContext tgContext = m_trackingGeometryTool->getGeometryContext(ctx).context();
  
     std::array<const ActsTrk::MeasurementToTruthParticleAssociation *,
                static_cast< std::underlying_type<xAOD::UncalibMeasType>::type >(xAOD::UncalibMeasType::nTypes)>
        measurement_to_truth_association_maps{};
     measurement_to_truth_association_maps[to_underlying(xAOD::UncalibMeasType::PixelClusterType)]=pixelClustersToTruthAssociation.cptr();
     measurement_to_truth_association_maps[to_underlying(xAOD::UncalibMeasType::StripClusterType)]=stripClustersToTruthAssociation.cptr();
     ATH_MSG_DEBUG("Measurement association entries: "  << measurement_to_truth_association_maps[to_underlying(xAOD::UncalibMeasType::PixelClusterType)]->size()
                  << " + " << measurement_to_truth_association_maps[to_underlying(xAOD::UncalibMeasType::StripClusterType)]->size()
                  );
     unsigned int track_i=0;
     std::array<unsigned int,s_NCounterForAssociatedTruth> tracks_with_associated_truth{};
     std::pair<unsigned int, unsigned int> compatible_assoc_container_counts{};
     if (m_nIncompatibleMeasurementContainer>0) {
        // used to suppress reoccurring error messages
        --m_nIncompatibleMeasurementContainer;
        ++compatible_assoc_container_counts.second;
     }
  
     std::vector<unsigned int> counted_truth_particles;
     counted_truth_particles.reserve(10);
     --track_i; // to have track_i at the begining of the loop
     for (const typename ActsTrk::TrackContainer::ConstTrackProxy track : *tracksContainer) {
        ++track_i;
        const auto lastMeasurementIndex = track.tipIndex();
  
        unsigned int n_measurements=0u;
  
        HitCounterArray &reco_hits = track_association->at(track_i).totalCounts();
        HitCounterArray &noise_hits = track_association->at(track_i).noiseCounts();
        ActsTrk::HitCountsPerTrack::container  &truth_particle_counts = track_association->at(track_i).countsPerTruthParticle();
        tracksContainer->trackStateContainer().visitBackwards(
           lastMeasurementIndex,
           [this,
            &n_measurements,
            &measurement_to_truth_association_maps,
            &truth_particle_counts,
            &reco_hits,
            &noise_hits,
            &counted_truth_particles,
            &compatible_assoc_container_counts
            ](const typename ActsTrk::TrackStateBackend::ConstTrackStateProxy &state) -> void
           {
             if (!state.typeFlags().test(Acts::TrackStateFlag::OutlierFlag) && state.hasUncalibratedSourceLink()) {
               auto sl = state.getUncalibratedSourceLink().template get<ATLASUncalibSourceLink>();
               assert( sl != nullptr );
               const xAOD::UncalibratedMeasurement &uncalibMeas = getUncalibratedMeasurement(sl);
  
  
               const ActsTrk::MeasurementToTruthParticleAssociation *association_map = measurement_to_truth_association_maps.at(to_underlying(uncalibMeas.type()));
               if (association_map) {
                  if (!association_map->isCompatibleWith(dynamic_cast< const xAOD::UncalibratedMeasurementContainer *>(uncalibMeas.container()))) {
                     if (compatible_assoc_container_counts.second==0) {
                        ATH_MSG_ERROR("MeasurementToTruthParticleAssociation for measurement type " << to_underlying(uncalibMeas.type())
                                      << " is not compatible with the measurement on track.");
                     }
                     ++compatible_assoc_container_counts.second;
                     return;
                  }
                  else {
                     ++compatible_assoc_container_counts.first;
                  }
                  ++n_measurements;
                  counted_truth_particles.clear();
                  for (const xAOD::TruthParticle *truth_particle : association_map->at(uncalibMeas.index()) ) {
                     const xAOD::TruthParticle *mother_particle = m_elasticDecayUtil.getMother(*truth_particle, m_maxEnergyLoss.value());
  
                     // do not count hits of associated truth particles again if they are associated to the same elastic decay chain:
                     if (std::find(counted_truth_particles.begin(), counted_truth_particles.end(), mother_particle->index())
                         ==counted_truth_particles.end()) {
                        counted_truth_particles.push_back(mother_particle->index());
  
                        ActsTrk::HitCountsPerTrack::container::iterator
                           hit_count_iter = std::find_if(truth_particle_counts.begin(),
                                                         truth_particle_counts.end(),
                                                         [mother_particle](const std::pair<const xAOD::TruthParticle *, HitCounterArray > &a) {
                                                            return a.first == mother_particle;
                                                         });
                        if (hit_count_iter == truth_particle_counts.end()) {
                           truth_particle_counts.push_back( std::make_pair(mother_particle, HitCounterArray{}));
                           hit_count_iter = truth_particle_counts.end()-1;
                        }
                        ++(hit_count_iter->second.at( to_underlying(uncalibMeas.type())));
                     }
                  }
                  if (association_map->at(uncalibMeas.index()).empty()) {
                     ++noise_hits.at( to_underlying(uncalibMeas.type()));
                  }
               }
               ++reco_hits.at( to_underlying(uncalibMeas.type()));
             }
  
           });
        std::sort( truth_particle_counts.begin(),
                   truth_particle_counts.end(),
                   [](const std::pair<const xAOD::TruthParticle *, HitCounterArray > &a,
                      const std::pair<const xAOD::TruthParticle *, HitCounterArray > &b) {
                      return std::accumulate(a.second.begin(),a.second.end(),0u) > std::accumulate(b.second.begin(),b.second.end(),0u);
                   });
        m_associationCounter.fillStatistics(n_measurements, truth_particle_counts.size());
        ++(tracks_with_associated_truth[std::min(truth_particle_counts.size(),tracks_with_associated_truth.size()-1u)]);
     }
     unsigned int idx=0;
     for (unsigned int elm : tracks_with_associated_truth) {
        m_nTracksWithAssociatedTruth[idx] += elm;
        ++idx;
     }
     m_nIncompatibleMeasurementContainer += compatible_assoc_container_counts.second;
     m_nCcompatibleMeasurementContainer += compatible_assoc_container_counts.first;
  
     SG::WriteHandle<TrackToTruthParticleAssociation> associationOutHandle(m_trackToTruthOut, ctx);
     if (associationOutHandle.record( std::move(track_association)).isFailure()) {
        ATH_MSG_ERROR("Failed to record track to truth assocition with key " << m_trackToTruthOut.key() );
        return StatusCode::FAILURE;
     }
     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 & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.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 Algorithm::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

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

◆ finalize()

StatusCode ActsTrk::TrackToTruthAssociationAlg::finalize ( )

overridevirtual

Definition at line 76 of file TrackToTruthAssociationAlg.cxx.

   {
      if (m_nIncompatibleMeasurementContainer>0) {
         ATH_MSG_WARNING( "Encountered measurements not compaible with provided association maps in "
                          << m_nIncompatibleMeasurementContainer << " of " << (m_nCcompatibleMeasurementContainer+m_nIncompatibleMeasurementContainer) << " cases.");
      }
      if (msgLvl(MSG::INFO)) {
         msg(MSG::INFO) << "-- Statistics:" << std::endl;
         unsigned int idx=0;
         for (const std::atomic<std::size_t> &elm : m_nTracksWithAssociatedTruth) {
            msg() << std::setw(20) << elm << " "
                  << (idx==0
                      ? std::string(" tracks without associated truth particles.")
                      : (idx==m_nTracksWithAssociatedTruth.size()-1
                         ? makeLabel(" tracks with more than",
                                     m_nTracksWithAssociatedTruth.size()-1,
                                     "associated truth particles.")
                         : makeLabel(" tracks with",
                                     idx,
                                     "associated truth particle(s).")));
            if (idx!=m_nTracksWithAssociatedTruth.size()-1 || TrackToTruthParticleAssociationDebugHists) {
               msg() << std::endl;
            }
            ++idx;
         }
         if constexpr(TrackToTruthParticleAssociationDebugHists) {
            m_elasticDecayUtil.dumpStatistics(msg());
            msg() << std::endl;
            m_associationCounter.dumpStatistics(msg());
         }
         msg() << endmsg;
      }
      return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode ActsTrk::TrackToTruthAssociationAlg::initialize ( )

overridevirtual

Definition at line 36 of file TrackToTruthAssociationAlg.cxx.

   {
      ATH_CHECK( m_trackingGeometryTool.retrieve() );
      ATH_CHECK( m_tracksContainerKey.initialize() );
      ATH_CHECK( m_pixelClustersToTruth.initialize() );
      ATH_CHECK( m_stripClustersToTruth.initialize() );
  
      ATH_CHECK( m_trackToTruthOut.initialize() );
  
      m_elasticDecayUtil.setEnergyLossBinning(m_energyLossBinning.value());
      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()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ 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 AthReentrantAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

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

◆ sysExecute()

StatusCode AthReentrantAlgorithm::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.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

 {
   return Gaudi::Algorithm::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::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 InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                 {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::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

◆ ATLAS_THREAD_SAFE

std::array<std::atomic<std::size_t>,s_NCounterForAssociatedTruth> m_nTracksWithAssociatedTruth ActsTrk::TrackToTruthAssociationAlg::ATLAS_THREAD_SAFE {}

mutableprivate

Definition at line 101 of file TrackToTruthAssociationAlg.h.

◆ m_associationCounter

AssociationCounter<TrackToTruthParticleAssociationDebugHists> ActsTrk::TrackToTruthAssociationAlg::m_associationCounter

private

Definition at line 99 of file TrackToTruthAssociationAlg.h.

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

ElasticDecayUtil<TrackToTruthParticleAssociationDebugHists> ActsTrk::TrackToTruthAssociationAlg::m_elasticDecayUtil

private

Definition at line 72 of file TrackToTruthAssociationAlg.h.

◆ m_energyLossBinning

std::conditional<TrackToTruthParticleAssociationDebugHists, Gaudi::Property<std::vector<float> >, EmptyProperty >::type ActsTrk::TrackToTruthAssociationAlg::m_energyLossBinning {this, "EnergyLossBinning", {20.,0.,5.*s_unitGeV}, "Binning to be used for the energy loss histograms." }

private

Definition at line 76 of file TrackToTruthAssociationAlg.h.

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

privateinherited

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

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_maxEnergyLoss

Gaudi::Property<float> ActsTrk::TrackToTruthAssociationAlg::m_maxEnergyLoss {this, "MaxEnergyLoss", 10e12, "Stop moving up the decay chain if the energy loss is above this value." }

private

Definition at line 69 of file TrackToTruthAssociationAlg.h.

◆ m_nCcompatibleMeasurementContainer

std::atomic<std::size_t> ActsTrk::TrackToTruthAssociationAlg::m_nCcompatibleMeasurementContainer {}

mutableprivate

Definition at line 103 of file TrackToTruthAssociationAlg.h.

◆ m_nIncompatibleMeasurementContainer

std::atomic<std::size_t> ActsTrk::TrackToTruthAssociationAlg::m_nIncompatibleMeasurementContainer {}

mutableprivate

Definition at line 102 of file TrackToTruthAssociationAlg.h.

◆ m_pixelClustersToTruth

SG::ReadHandleKey<MeasurementToTruthParticleAssociation> ActsTrk::TrackToTruthAssociationAlg::m_pixelClustersToTruth {this, "PixelClustersToTruthAssociationMap", "", "Association map from pixel measurements to generator particles." }

private

Definition at line 61 of file TrackToTruthAssociationAlg.h.

◆ m_stripClustersToTruth

SG::ReadHandleKey<MeasurementToTruthParticleAssociation> ActsTrk::TrackToTruthAssociationAlg::m_stripClustersToTruth {this, "StripClustersToTruthAssociationMap", "", "Association map from strip measurements to generator particles." }

private

Definition at line 63 of file TrackToTruthAssociationAlg.h.

◆ m_trackingGeometryTool

ToolHandle<IActsTrackingGeometryTool> ActsTrk::TrackToTruthAssociationAlg::m_trackingGeometryTool {this, "TrackingGeometryTool", ""}

private

Definition at line 55 of file TrackToTruthAssociationAlg.h.

◆ m_tracksContainerKey

SG::ReadHandleKey<ActsTrk::TrackContainer> ActsTrk::TrackToTruthAssociationAlg::m_tracksContainerKey {this, "ACTSTracksLocation", "","Track collection (ActsTrk variant)"}

private

Definition at line 58 of file TrackToTruthAssociationAlg.h.

◆ m_trackToTruthOut

SG::WriteHandleKey<TrackToTruthParticleAssociation> ActsTrk::TrackToTruthAssociationAlg::m_trackToTruthOut {this, "AssociationMapOut", "", "Output association map from measurements to generator particles." }

private

Definition at line 66 of file TrackToTruthAssociationAlg.h.

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

◆ s_NCounterForAssociatedTruth

constexpr unsigned int ActsTrk::TrackToTruthAssociationAlg::s_NCounterForAssociatedTruth = 4

staticconstexprprivate

Definition at line 100 of file TrackToTruthAssociationAlg.h.

◆ s_unitGeV

constexpr float ActsTrk::TrackToTruthAssociationAlg::s_unitGeV = 1e3

staticconstexprprivate

Definition at line 73 of file TrackToTruthAssociationAlg.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrackToTruthAssociationAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_associationCounter

◆ m_detStore

◆ m_elasticDecayUtil

◆ m_energyLossBinning

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_maxEnergyLoss

◆ m_nCcompatibleMeasurementContainer

◆ m_nIncompatibleMeasurementContainer

◆ m_pixelClustersToTruth

◆ m_stripClustersToTruth

◆ m_trackingGeometryTool

◆ m_tracksContainerKey

◆ m_trackToTruthOut

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_NCounterForAssociatedTruth

◆ s_unitGeV