#include <HGTDTruthTrackDecorationAlg.h>

Inheritance diagram for ActsTrk::HGTDTruthTrackDecorationAlg:

Classes
struct	TruthTrackExtensionData
	Data structure to hold truth information about the HGTD track extension. More...
struct	ClusterTruthInfo

Public Member Functions
virtual	~HGTDTruthTrackDecorationAlg ()=default
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &) const override
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
using	HgtdLayerFlags = std::array<char, s_nHgtdLayers>
	Per-layer flags for a single truth particle.
using	PrimaryExpectedLookup = std::unordered_map<std::size_t, HgtdLayerFlags>
	Maps the index of a truth particle onto the HGTD layers it deposited a hit in.
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
TruthTrackExtensionData	createTruthDecoration (const xAOD::TruthParticle truthParticle, const typename ActsTrk::TrackContainer::ConstTrackProxy trackProxy, const ActsTrk::MeasurementToTruthParticleAssociation association_map) const
	Generate TruthTrackExtensionData from extension.
StatusCode	buildPrimaryExpectedLookup (const xAOD::UncalibratedMeasurementContainer &measurementContainer, const ActsTrk::MeasurementToTruthParticleAssociation *association_map, PrimaryExpectedLookup &lookup) const
	Builds, once per event, the map from truth particle index onto the set of HGTD layers in which that particle contributed to a cluster.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trackParticleContainerName {this, "TrackParticleContainerName", "", "Name of the TrackParticle container"}
SG::ReadHandleKey< ActsTrk::TrackContainer >	m_trackContainerKey {this, "ACTSTracksLocation", "HgtdTracks", "Output track collection (ActsTrk variant)"}
SG::ReadHandleKey< xAOD::UncalibratedMeasurementContainer >	m_uncalibratedMeasurementContainerKey_HGTD {this, "UncalibratedMeasurementContainerKey_HGTD", "HGTD_Clusters", "input cluster collections for HGTD"}
SG::ReadHandleKey< MeasurementToTruthParticleAssociation >	m_hgtdClustersToTruth { this, "HgtdClustersToTruthAssociationMap", "HgtdClustersToTruthParticles", "Association map from HGTD measurements to generator particles." }
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_hgtdTrackLinkKey {this, "hgtdTrackLink", m_trackParticleContainerName, "hgtdTrackLink", "Link to Hgtd track"}
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_truthParticleLinkKey {this, "truthParticleLink", m_trackParticleContainerName, "truthParticleLink", "Link to Truth particle"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_layerClusterTruthClassKey { this, "HGTD_cluster_truth_class", m_trackParticleContainerName, "HGTD_cluster_truth_class", "Decoration for cluster truth classification" }
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_layerClusterShadowedKey { this, "HGTD_cluster_shadowed", m_trackParticleContainerName, "HGTD_cluster_shadowed", "Decoration for shadowed cluster" }
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_layerClusterMergedKey { this, "HGTD_cluster_merged", m_trackParticleContainerName, "HGTD_cluster_merged", "Decoration for merged cluster" }
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_layerPrimaryExpectedKey { this, "HGTD_primary_expected", m_trackParticleContainerName, "HGTD_primary_expected", "Decoration for primary expected cluster" }
ActsTrk::detail::xAODUncalibMeasSurfAcc	m_surfAcc {}
ServiceHandle< ActsTrk::ITrackingGeometrySvc >	m_trackingGeometrySvc {this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"}
std::unique_ptr< SG::AuxElement::Accessor< int > >	m_acc_nHgtdHits
const HGTD_ID *	m_id_helper {nullptr}
	Handle to the ID helper.
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

Static Private Attributes
static constexpr std::size_t	s_nHgtdLayers = 4
	Number of HGTD layers the per-track decorations are indexed by.

Detailed Description

Definition at line 47 of file HGTDTruthTrackDecorationAlg.h.

Member Typedef Documentation

◆ HgtdLayerFlags

using ActsTrk::HGTDTruthTrackDecorationAlg::HgtdLayerFlags = std::array<char, s_nHgtdLayers>

private

Per-layer flags for a single truth particle.

Definition at line 119 of file HGTDTruthTrackDecorationAlg.h.

◆ PrimaryExpectedLookup

using ActsTrk::HGTDTruthTrackDecorationAlg::PrimaryExpectedLookup = std::unordered_map<std::size_t, HgtdLayerFlags>

private

Maps the index of a truth particle onto the HGTD layers it deposited a hit in.

Definition at line 121 of file HGTDTruthTrackDecorationAlg.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~HGTDTruthTrackDecorationAlg()

virtual ActsTrk::HGTDTruthTrackDecorationAlg::~HGTDTruthTrackDecorationAlg ( )

virtualdefault

Member Function Documentation

◆ buildPrimaryExpectedLookup()

StatusCode ActsTrk::HGTDTruthTrackDecorationAlg::buildPrimaryExpectedLookup	(	const xAOD::UncalibratedMeasurementContainer &	measurementContainer,
		const ActsTrk::MeasurementToTruthParticleAssociation *	association_map,
		PrimaryExpectedLookup &	lookup ) const

private

Builds, once per event, the map from truth particle index onto the set of HGTD layers in which that particle contributed to a cluster.

The information is a property of the measurements alone and does not depend on the track being decorated, so it is evaluated once instead of once per track. This replaces a scan of the full HGTD measurement container for every TrackParticle.

Parameters

measurementContainer	- measurement container with HGTD clusters
association_map	- hgtd cluster to truth particles map (may be nullptr)
lookup	- filled with one entry per truth particle that has an HGTD cluster

Definition at line 260 of file HGTDTruthTrackDecorationAlg.cxx.

                                         {
 
    if (association_map == nullptr) {
      return StatusCode::SUCCESS;
    }
 
    for (const xAOD::UncalibratedMeasurement* uncalibMeas : measurementContainer) {
 
      const Acts::Surface* surface = m_surfAcc.get(uncalibMeas);
      const auto* detElem = getActsDetectorElement(surface);
      if (detElem == nullptr || detElem->detectorType() != DetectorType::Hgtd) {
        continue;
      }
 
      const std::size_t layerIndex = m_id_helper->layer(detElem->identify());
 
      ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - "<<uncalibMeas->type()
                      <<", geoID: "<<surface->geometryId()<<", layerIndex: "<<layerIndex);
      if (layerIndex >= s_nHgtdLayers) {
        ATH_MSG_WARNING(__func__<<"() "<<__LINE__<<" - "<<uncalibMeas->type()
                        <<", geoID: "<<surface->geometryId()<<" results in an invalid index "<<layerIndex);
        continue;
      }
 
      for (const xAOD::TruthParticle* measTruthParticle : association_map->at(uncalibMeas->index())) {
        lookup.try_emplace(measTruthParticle->index(), HgtdLayerFlags{})
              .first->second[layerIndex] = true;
      }
    }
 
    return StatusCode::SUCCESS; 
  }

◆ createTruthDecoration()

HGTDTruthTrackDecorationAlg::TruthTrackExtensionData ActsTrk::HGTDTruthTrackDecorationAlg::createTruthDecoration	(	const xAOD::TruthParticle *	truthParticle,
		const typename ActsTrk::TrackContainer::ConstTrackProxy	trackProxy,
		const ActsTrk::MeasurementToTruthParticleAssociation *	association_map ) const

private

Generate TruthTrackExtensionData from extension.

Parameters

truthParticle	- truth particle associated with track
trackProxy	- measurement container with HGTD clusters
association_map	- hgtd cluster to truth particles map

Definition at line 185 of file HGTDTruthTrackDecorationAlg.cxx.

                                                                              {
  
    TruthTrackExtensionData data;
 
    std::vector<int> truthClassPerLayer = {-1, -1, -1, -1};
    std::vector<char> isShadowedPerLayer = {false, false, false, false};
    std::vector<char> isMergedPerLayer = {false, false, false, false};
    std::vector<char> isPrimaryExistsVec = {false, false, false, false};
 
    for (auto state : trackProxy.trackStatesReversed()) {
      auto flags = state.typeFlags();
      if (flags.isMeasurement()) {
        // Check if this is an HGTD hit 
        const auto& surface = state.referenceSurface();
        const auto* detElem = getActsDetectorElement(surface);
        if(detElem->detectorType() != DetectorType::Hgtd){
          continue;
        }
 
        Acts::GeometryIdentifier geoID = surface.geometryId();
        std::size_t layerIndex = m_id_helper->layer(detElem->identify());
 
        ClusterTruthInfo cluster_truth_info;
 
        assert( state.hasUncalibratedSourceLink() );
        auto uncalibMeas = detail::xAODUncalibMeasCalibrator::unpack(state.getUncalibratedSourceLink());
        if (association_map->at(uncalibMeas->index()).empty()) {
          cluster_truth_info.origin = ActsTrk::ClusterTruthOrigin::SECONDARY;
          ATH_MSG_DEBUG("    \\__Layer "<< layerIndex << " SECONDARY: hit doesnt have truth particle associated with it");
        }
        else if(association_map->at(uncalibMeas->index()).size() == 1) {
          const xAOD::TruthParticle *truth_particle = association_map->at(uncalibMeas->index()).at(0);
          if(truthParticle->index() == truth_particle->index()){
            cluster_truth_info.origin = ActsTrk::ClusterTruthOrigin::TRUTH_PARTICLE;
            ATH_MSG_DEBUG("    \\__Layer "<< layerIndex<< " TRUTH_PARTICLE: hit matches ITk track");
          }
          else{
            cluster_truth_info.origin = ActsTrk::ClusterTruthOrigin::UNRELATED_PARTICLE;
            ATH_MSG_DEBUG("    \\__Layer "<< layerIndex<< " UNRELATED_PARTICLE: hit doesnt match ITk track");
          }
        }
        else {
          cluster_truth_info.is_merged = true;
          cluster_truth_info.origin = ActsTrk::ClusterTruthOrigin::UNRELATED_PARTICLE;
          ATH_MSG_DEBUG("    \\__Layer "<< layerIndex<< " MERGED: hit with more than one contributing particle");
          for (const xAOD::TruthParticle *truth_particle : association_map->at(uncalibMeas->index()) ) {
            if(truthParticle->index() == truth_particle->index()){
              cluster_truth_info.origin = ActsTrk::ClusterTruthOrigin::TRUTH_PARTICLE;
              ATH_MSG_DEBUG("         \\__TRUTH_PARTICLE: hit matches ITk track");
            }   
          }
        }
      
        ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - "<<uncalibMeas->type()<<", geoID: "<<geoID<<", layerIndex: "<<layerIndex);
        if (layerIndex >= truthClassPerLayer.size()) {
          ATH_MSG_WARNING(__func__<<"() "<<__LINE__<<" - "<<uncalibMeas->type()<<", geoID: "<<geoID<<" results in an invalid index "<<layerIndex);
          continue;
        }
        truthClassPerLayer.at(layerIndex)      = Acts::toUnderlying(cluster_truth_info.origin);
        isShadowedPerLayer.at(layerIndex)      = cluster_truth_info.is_shadowed;
        isMergedPerLayer.at(layerIndex)        = cluster_truth_info.is_merged;
      }
    }
 
    // Fill the data structure with results
    data.truthClassVec      = std::move(truthClassPerLayer);
    data.isShadowedVec      = std::move(isShadowedPerLayer);
    data.isMergedVec        = std::move(isMergedPerLayer);
    data.primaryExistsVec   = std::move(isPrimaryExistsVec);
    return data;
  }

◆ 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 ActsTrk::HGTDTruthTrackDecorationAlg::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 63 of file HGTDTruthTrackDecorationAlg.cxx.

  {
    ATH_MSG_DEBUG("Executing " << name() << "...");
 
    const xAOD::TrackParticleContainer* trackParticles {nullptr};
    ATH_CHECK(SG::get(trackParticles, m_trackParticleContainerName, ctx));
 
    ATH_MSG_DEBUG("Size of trackParticles collection " << trackParticles->size());
    // ================================================== //
    // ============ RETRIEVE MEASUREMENTS =============== //
    // ================================================== //
 
    ATH_MSG_DEBUG("Reading input collection with key " << m_uncalibratedMeasurementContainerKey_HGTD.key());
 
    const xAOD::UncalibratedMeasurementContainer* uncalibratedMeasurementContainer{nullptr};
    ATH_CHECK(SG::get(uncalibratedMeasurementContainer ,m_uncalibratedMeasurementContainerKey_HGTD, ctx));
    
    ATH_MSG_DEBUG("Retrieved " << uncalibratedMeasurementContainer->size()
                    << " input elements from key " << m_uncalibratedMeasurementContainerKey_HGTD.key());
 
 
    // ================================================== //
    // ============ TRUTH MATCHING BLOCK ================ //
    // ================================================== //
 
    SG::ReadDecorHandle<xAOD::TrackParticleContainer, ElementLink<ActsTrk::TrackContainer>> hgtdTrackLink( m_hgtdTrackLinkKey, ctx );
 
    SG::ReadDecorHandle<xAOD::TrackParticleContainer, ElementLink<xAOD::TruthParticleContainer>> truthParticleLink( m_truthParticleLinkKey, ctx );
 
    std::array<const ActsTrk::MeasurementToTruthParticleAssociation *,
    Acts::toUnderlying(xAOD::UncalibMeasType::nTypes)>
    measurement_to_truth_association_maps{};
 
    if (!m_hgtdClustersToTruth.key().empty()) {
    const ActsTrk::MeasurementToTruthParticleAssociation* hgtdClustersToTruthAssociation{};
    ATH_CHECK(SG::get(hgtdClustersToTruthAssociation, m_hgtdClustersToTruth, ctx));
       measurement_to_truth_association_maps[Acts::toUnderlying(xAOD::UncalibMeasType::HGTDClusterType)]=hgtdClustersToTruthAssociation;
    }
    auto assocSize = [&measurement_to_truth_association_maps](xAOD::UncalibMeasType type) {
    const ActsTrk::MeasurementToTruthParticleAssociation *assoc = measurement_to_truth_association_maps[Acts::toUnderlying(type)];
    return assoc ? assoc->size() : 0ul;
    };
 
    ATH_MSG_DEBUG("Measurement association entries: "  << assocSize(xAOD::UncalibMeasType::PixelClusterType)
        << " + " << assocSize(xAOD::UncalibMeasType::StripClusterType)
        << " + " << assocSize(xAOD::UncalibMeasType::HGTDClusterType)
        );
 
 
    SG::ReadHandle<ActsTrk::TrackContainer> tracksContainer = SG::makeHandle( m_trackContainerKey, ctx);
    if (!tracksContainer.isValid()) {
      ATH_MSG_ERROR("No tracks for key " << m_trackContainerKey.key() );
      return StatusCode::FAILURE;
    }
    // Create WriteDecorHandles for all decorations
    SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<int>> layerClusterTruthClassHandle(m_layerClusterTruthClassKey, ctx);
    SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<char>> layerClusterShadowedHandle(m_layerClusterShadowedKey, ctx);
    SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<char>> layerClusterMergedHandle(m_layerClusterMergedKey, ctx);
    SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<char>> layerPrimaryExpectedHandle(m_layerPrimaryExpectedKey, ctx);
 
    // The HGTD layers in which a given truth particle left a cluster depend only on the
    // measurements, not on the track being decorated. Evaluate it once per event instead
    // of rescanning the whole HGTD measurement container for every TrackParticle.
    PrimaryExpectedLookup primaryExpectedLookup;
    ATH_CHECK(buildPrimaryExpectedLookup(
        *uncalibratedMeasurementContainer,
        measurement_to_truth_association_maps[Acts::toUnderlying(xAOD::UncalibMeasType::HGTDClusterType)],
        primaryExpectedLookup));
 
    TruthTrackExtensionData data;
 
    for (const xAOD::TrackParticle* trackParticle : *trackParticles) {
 
      // get the truth particle
      ElementLink<xAOD::TruthParticleContainer> link_to_truth = truthParticleLink(*trackParticle);
      const xAOD::TruthParticle* truthParticle = nullptr;
      if (!link_to_truth.isValid()) {
        layerClusterTruthClassHandle(*trackParticle) = {-1, -1, -1, -1};
        layerClusterShadowedHandle(*trackParticle) = {false, false, false, false};
        layerClusterMergedHandle(*trackParticle)  = {false, false, false, false};
        layerPrimaryExpectedHandle(*trackParticle) = {false, false, false, false};
        ATH_MSG_DEBUG("TrackParticle " << trackParticle->index() << ": invalid truth link");
        continue;
      }
      else {
        truthParticle = *link_to_truth;
      }
      // Check if the TrackParticle has a link to an hgtd extension track
      if(hgtdTrackLink.isAvailable()){
        ElementLink<ActsTrk::TrackContainer> link_to_track = hgtdTrackLink(*trackParticle);
        if (!link_to_track.isValid()) {
          ATH_MSG_DEBUG("TrackParticle " << trackParticle->index() << ": invalid extension link");
          data.truthClassVec = {-1, -1, -1, -1};
          data.isShadowedVec = {false, false, false, false};
          data.isMergedVec   = {false, false, false, false};
        }
        else{
          std::optional<ActsTrk::TrackContainer::ConstTrackProxy> optional_track = *link_to_track;
          const ActsTrk::TrackContainer::ConstTrackProxy& track = optional_track.value();
          ATH_MSG_DEBUG("TrackParticle " << trackParticle->index() << ": extension  with  chi2 " <<  track.chi2() << " and nHits " << track.nMeasurements());
          data = createTruthDecoration(truthParticle, track, measurement_to_truth_association_maps[Acts::toUnderlying(xAOD::UncalibMeasType::HGTDClusterType)]);
        }
      }
      
 
      data.primaryExistsVec.assign(s_nHgtdLayers, false);
      if (auto itr = primaryExpectedLookup.find(truthParticle->index());
          itr != primaryExpectedLookup.end()) {
        std::copy(itr->second.begin(), itr->second.end(), data.primaryExistsVec.begin());
      }
 
      layerClusterTruthClassHandle(*trackParticle) = data.truthClassVec;
      layerClusterShadowedHandle(*trackParticle) = data.isShadowedVec;
      layerClusterMergedHandle(*trackParticle) = data.isMergedVec;
      layerPrimaryExpectedHandle(*trackParticle) = data.primaryExistsVec;
 
    }
    ATH_MSG_DEBUG("Finshed truth matching");
  
    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 ActsTrk::HGTDTruthTrackDecorationAlg::initialize ( )

overridevirtual

Definition at line 39 of file HGTDTruthTrackDecorationAlg.cxx.

  {
    ATH_MSG_DEBUG("Initializing " << name() << "...");
 
    ATH_CHECK( m_trackParticleContainerName.initialize() );
 
    ATH_CHECK( m_layerClusterTruthClassKey.initialize() );
    ATH_CHECK( m_layerClusterShadowedKey.initialize() );
    ATH_CHECK( m_layerClusterMergedKey.initialize() );
    ATH_CHECK( m_layerPrimaryExpectedKey.initialize() );
    ATH_CHECK( m_trackContainerKey.initialize() );
    ATH_CHECK( m_hgtdTrackLinkKey.initialize() );
    ATH_CHECK( m_truthParticleLinkKey.initialize() );
    ATH_CHECK( m_trackingGeometrySvc.retrieve());
    ATH_CHECK(detStore()->retrieve(m_id_helper, "HGTD_ID"));
    ATH_CHECK( m_uncalibratedMeasurementContainerKey_HGTD.initialize() );
 
    // Initialize surface accessor
    m_surfAcc = ActsTrk::detail::xAODUncalibMeasSurfAcc{m_trackingGeometrySvc.get()};
     ATH_CHECK(m_hgtdClustersToTruth.initialize(SG::AllowEmpty));
 
    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_acc_nHgtdHits

std::unique_ptr<SG::AuxElement::Accessor<int> > ActsTrk::HGTDTruthTrackDecorationAlg::m_acc_nHgtdHits

private

Definition at line 77 of file HGTDTruthTrackDecorationAlg.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_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_hgtdClustersToTruth

SG::ReadHandleKey<MeasurementToTruthParticleAssociation> ActsTrk::HGTDTruthTrackDecorationAlg::m_hgtdClustersToTruth { this, "HgtdClustersToTruthAssociationMap", "HgtdClustersToTruthParticles", "Association map from HGTD measurements to generator particles." }

private

Definition at line 63 of file HGTDTruthTrackDecorationAlg.h.

63{ this, "HgtdClustersToTruthAssociationMap", "HgtdClustersToTruthParticles", "Association map from HGTD measurements to generator particles." };

◆ m_hgtdTrackLinkKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_hgtdTrackLinkKey {this, "hgtdTrackLink", m_trackParticleContainerName, "hgtdTrackLink", "Link to Hgtd track"}

private

Definition at line 65 of file HGTDTruthTrackDecorationAlg.h.

65{this, "hgtdTrackLink", m_trackParticleContainerName, "hgtdTrackLink", "Link to Hgtd track"};

◆ m_id_helper

const HGTD_ID* ActsTrk::HGTDTruthTrackDecorationAlg::m_id_helper {nullptr}

private

Handle to the ID helper.

Definition at line 79 of file HGTDTruthTrackDecorationAlg.h.

79{nullptr};

◆ m_layerClusterMergedKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_layerClusterMergedKey { this, "HGTD_cluster_merged", m_trackParticleContainerName, "HGTD_cluster_merged", "Decoration for merged cluster" }

private

Definition at line 71 of file HGTDTruthTrackDecorationAlg.h.

71{ this, "HGTD_cluster_merged", m_trackParticleContainerName, "HGTD_cluster_merged", "Decoration for merged cluster" };

◆ m_layerClusterShadowedKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_layerClusterShadowedKey { this, "HGTD_cluster_shadowed", m_trackParticleContainerName, "HGTD_cluster_shadowed", "Decoration for shadowed cluster" }

private

Definition at line 70 of file HGTDTruthTrackDecorationAlg.h.

70{ this, "HGTD_cluster_shadowed", m_trackParticleContainerName, "HGTD_cluster_shadowed", "Decoration for shadowed cluster" };

◆ m_layerClusterTruthClassKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_layerClusterTruthClassKey { this, "HGTD_cluster_truth_class", m_trackParticleContainerName, "HGTD_cluster_truth_class", "Decoration for cluster truth classification" }

private

Definition at line 69 of file HGTDTruthTrackDecorationAlg.h.

69{ this, "HGTD_cluster_truth_class", m_trackParticleContainerName, "HGTD_cluster_truth_class", "Decoration for cluster truth classification" };

◆ m_layerPrimaryExpectedKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_layerPrimaryExpectedKey { this, "HGTD_primary_expected", m_trackParticleContainerName, "HGTD_primary_expected", "Decoration for primary expected cluster" }

private

Definition at line 72 of file HGTDTruthTrackDecorationAlg.h.

72{ this, "HGTD_primary_expected", m_trackParticleContainerName, "HGTD_primary_expected", "Decoration for primary expected cluster" };

◆ m_surfAcc

ActsTrk::detail::xAODUncalibMeasSurfAcc ActsTrk::HGTDTruthTrackDecorationAlg::m_surfAcc {}

private

Definition at line 74 of file HGTDTruthTrackDecorationAlg.h.

74{};

◆ m_trackContainerKey

SG::ReadHandleKey<ActsTrk::TrackContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_trackContainerKey {this, "ACTSTracksLocation", "HgtdTracks", "Output track collection (ActsTrk variant)"}

private

Definition at line 61 of file HGTDTruthTrackDecorationAlg.h.

61{this, "ACTSTracksLocation", "HgtdTracks", "Output track collection (ActsTrk variant)"};

◆ m_trackingGeometrySvc

ServiceHandle<ActsTrk::ITrackingGeometrySvc> ActsTrk::HGTDTruthTrackDecorationAlg::m_trackingGeometrySvc {this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"}

private

Definition at line 75 of file HGTDTruthTrackDecorationAlg.h.

75{this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"};

◆ m_trackParticleContainerName

SG::ReadHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_trackParticleContainerName {this, "TrackParticleContainerName", "", "Name of the TrackParticle container"}

private

Definition at line 60 of file HGTDTruthTrackDecorationAlg.h.

60{this, "TrackParticleContainerName", "", "Name of the TrackParticle container"};

◆ m_truthParticleLinkKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_truthParticleLinkKey {this, "truthParticleLink", m_trackParticleContainerName, "truthParticleLink", "Link to Truth particle"}

private

Definition at line 66 of file HGTDTruthTrackDecorationAlg.h.

66{this, "truthParticleLink", m_trackParticleContainerName, "truthParticleLink", "Link to Truth particle"};

◆ m_uncalibratedMeasurementContainerKey_HGTD

SG::ReadHandleKey<xAOD::UncalibratedMeasurementContainer> ActsTrk::HGTDTruthTrackDecorationAlg::m_uncalibratedMeasurementContainerKey_HGTD {this, "UncalibratedMeasurementContainerKey_HGTD", "HGTD_Clusters", "input cluster collections for HGTD"}

private

Definition at line 62 of file HGTDTruthTrackDecorationAlg.h.

62{this, "UncalibratedMeasurementContainerKey_HGTD", "HGTD_Clusters", "input cluster collections for HGTD"};

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

std::size_t ActsTrk::HGTDTruthTrackDecorationAlg::s_nHgtdLayers = 4

staticconstexprprivate

Number of HGTD layers the per-track decorations are indexed by.

Definition at line 117 of file HGTDTruthTrackDecorationAlg.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

◆ HgtdLayerFlags

◆ PrimaryExpectedLookup

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~HGTDTruthTrackDecorationAlg()

Member Function Documentation

◆ buildPrimaryExpectedLookup()

◆ createTruthDecoration()

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

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_hgtdClustersToTruth

◆ m_hgtdTrackLinkKey

◆ m_id_helper

◆ m_layerClusterMergedKey

◆ m_layerClusterShadowedKey

◆ m_layerClusterTruthClassKey

◆ m_layerPrimaryExpectedKey

◆ m_surfAcc

◆ m_trackContainerKey

◆ m_trackingGeometrySvc

◆ m_trackParticleContainerName

◆ m_truthParticleLinkKey

◆ m_uncalibratedMeasurementContainerKey_HGTD

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_nHgtdLayers