The CaloExtensionAlg takes the ID / ITk tracks from their track state of their last measurement and propagates them to the exit portal of the calorimeter tracking volume. More...

#include <CaloExtensionAlg.h>

Inheritance diagram for ActsTrk::CaloExtensionAlg:

Public Member Functions
virtual StatusCode	initialize () override final
virtual StatusCode	execute (const EventContext &ctx) const override final
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	ClusterVec_t = std::vector<const xAOD::CaloCluster*>
	Use an Acts::Grid to segment the cluster in eta / phi space to reduce the matching combinatorics between tracks and clusters First define some abrivations to compactify the syntax --> Abrivation of the CaloClusters per grid cell.
using	EtaAxis_t
	Along eta define an equidistance binning without any overflow bin.
using	PhiAxis_t
	Along phi define an equidistance binning but with a circular wrapping connection between the two edge bins.
using	SortedCluster_t = Acts::Grid<ClusterVec_t, EtaAxis_t, PhiAxis_t>
	Define the segmen cluster grid made out of calo cluster containers segmented in eta & phi.
using	CurvedStepper_t = Acts::EigenStepper<Acts::EigenStepperDefaultExtension>
	Setup an own instance of the Acts Prpoagator to schedule the BoundTrackParameter recording & to define a more prope abort condition.
using	CurvedPropagator_t = Acts::Propagator<CurvedStepper_t, Acts::Navigator>
using	CaloSample = xAOD::CaloCluster::CaloSample
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
SortedCluster_t	selectAndSort (const xAOD::CaloClusterContainer &clusters, const CaloDetDescrManager *detMgr) const
	Selects the calo clusters for the matching to the ID tracks based on the eta range and on a minimum threshold on the energy.
std::unique_ptr< CaloExtension >	propagateToCaloExit (const EventContext &ctx, const xAOD::TrackParticle *track) const
	Propagates the Track from the last track measurement to the calorimeter exit and records all surface crossings between as Acts::BoundTrackParameters.
void	matchClusters (const Acts::GeometryContext &tgContext, std::span< const xAOD::CaloCluster *const > clusterContainer, CaloExtension &caloExtension) const
	Match the selected calorimeter clusters to the calo extension.
bool	checkBroadCriteria (const Acts::GeometryContext &tgContext, const xAOD::CaloCluster &cluster, const Acts::BoundTrackParameters &lastTrkPars) const
	Checks whether the track @ its last measurement state is roughly compatible with the calorimeter cluster.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::unique_ptr< CurvedPropagator_t >	m_propagator {}
	The instance of the propagator.
ToolHandle< InDet::IInDetTrackSelectionTool >	m_trackSelector {this, "TrackSelectionTool" , ""}
	Track quality selection tool (optional).
ToolHandle< IegammaCaloClusterSelector >	m_clusterSelector
	Tool to filter the calo clusters.
ServiceHandle< ActsTrk::ITrackingGeometrySvc >	m_trackingGeometrySvc {this, "TrackingGeometrySvc", "ActsTrackingGeometrySvc"}
	Tracking geometry service.
ActsTrk::ContextUtility	m_ctxProvider {this}
	Context provider for geometry, magnetic field and calibration contexts.
ToolHandle< IExtrapolationTool >	m_extrapolationTool {this, "ExtrapolationTool", ""}
	Acts extrapolation tool to record the surface intersections.
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clusterContainerKey {this, "ClusterContainerName", "CaloCalTopoClusters"}
	The input calorimeter cluster collection.
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trackParticleContainerKey
	The input track particle collection.
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_extensionDecorKey
	Decorate the link to the associated CaloExtension directly onto the ID / ITk track.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey {this, "CaloDetDescrManager", "CaloDetDescrManager"}
	Calo description manager.
SG::WriteHandleKey< CaloExtensionContainer >	m_caloExtensionKey {this, "CaloExtensionName", "CaloExtension"}
Gaudi::Property< float >	m_trackPt {this, "minPt", 2.5*Gaudi::Units::GeV}
	The minimum momentum cut applied on the ID tracks to be considered.
Gaudi::Property< float >	m_broadDeltaEta {this, "broadDeltaEta", 0.2, "Value of broad cut for delta eta" }
	Broad windowsto initially match the calo cluster with the track exit parameters.
Gaudi::Property< float >	m_broadDeltaPhi {this, "broadDeltaPhi", 0.3, "Value of broad cut for delta phi" }
Gaudi::Property< float >	m_minClustEt {this, "minClusterEt", 10.*Gaudi::Units::MeV}
	Minimum requirement on the cluster's transversal energy in order to be considered.
Gaudi::Property< float >	m_maxClustEta {this, "maxClustEta", 10.}
	Maximum cut on the cluster's eta in order to be considered.
Gaudi::Property< float >	m_narrowDeltaEta {this, "narrowDeltaEta", 0.05}
	Narrow windows.
Gaudi::Property< float >	m_narrowDeltaPhi {this, "narrowDeltaPhi", 0.05}
std::unordered_map< Acts::GeometryIdentifier, CaloSample >	m_geoLayerIds {}
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

The CaloExtensionAlg takes the ID / ITk tracks from their track state of their last measurement and propagates them to the exit portal of the calorimeter tracking volume.

Surface crossing along the track are recorded as Acts::BoundTrackParameters and then stored in the CaloExtension object which is written to StoreGate but also decorated to the TrackParticle via an ElementLink.

CaloClusters are then sorted into an eta/phi grid to speed-up the matching with the ITk tracks. Coarsely matched clusters are then matched to particular track parameters that have been recorded before.

Definition at line 46 of file CaloExtensionAlg.h.

Member Typedef Documentation

◆ CaloSample

using ActsTrk::CaloExtensionAlg::CaloSample = xAOD::CaloCluster::CaloSample

private

Definition at line 154 of file CaloExtensionAlg.h.

◆ ClusterVec_t

using ActsTrk::CaloExtensionAlg::ClusterVec_t = std::vector<const xAOD::CaloCluster*>

private

Use an Acts::Grid to segment the cluster in eta / phi space to reduce the matching combinatorics between tracks and clusters First define some abrivations to compactify the syntax --> Abrivation of the CaloClusters per grid cell.

Definition at line 57 of file CaloExtensionAlg.h.

◆ CurvedPropagator_t

using ActsTrk::CaloExtensionAlg::CurvedPropagator_t = Acts::Propagator<CurvedStepper_t, Acts::Navigator>

private

Definition at line 112 of file CaloExtensionAlg.h.

◆ CurvedStepper_t

using ActsTrk::CaloExtensionAlg::CurvedStepper_t = Acts::EigenStepper<Acts::EigenStepperDefaultExtension>

private

Setup an own instance of the Acts Prpoagator to schedule the BoundTrackParameter recording & to define a more prope abort condition.

Definition at line 111 of file CaloExtensionAlg.h.

◆ EtaAxis_t

using ActsTrk::CaloExtensionAlg::EtaAxis_t

private

Initial value:

Acts::Axis<Acts::AxisType::Equidistant,

Acts::AxisBoundaryType::Bound>

Along eta define an equidistance binning without any overflow bin.

Definition at line 59 of file CaloExtensionAlg.h.

◆ PhiAxis_t

using ActsTrk::CaloExtensionAlg::PhiAxis_t

private

Initial value:

Acts::Axis<Acts::AxisType::Equidistant,

Acts::AxisBoundaryType::Closed>

Along phi define an equidistance binning but with a circular wrapping connection between the two edge bins.

Definition at line 63 of file CaloExtensionAlg.h.

◆ SortedCluster_t

using ActsTrk::CaloExtensionAlg::SortedCluster_t = Acts::Grid<ClusterVec_t, EtaAxis_t, PhiAxis_t>

private

Define the segmen cluster grid made out of calo cluster containers segmented in eta & phi.

Definition at line 67 of file CaloExtensionAlg.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ checkBroadCriteria()

bool ActsTrk::CaloExtensionAlg::checkBroadCriteria	(	const Acts::GeometryContext &	tgContext,
		const xAOD::CaloCluster &	cluster,
		const Acts::BoundTrackParameters &	lastTrkPars ) const

private

Checks whether the track @ its last measurement state is roughly compatible with the calorimeter cluster.

Parameters

tgContext	The geometry context to align the bound track parameters
cluster	Calorimeter cluster to consider
lastTrkPars	The last track parameters of the ID track

Broad eta check

Definition at line 230 of file CaloExtensionAlg.cxx.

                                                                                                 {
        using namespace CandidateMatchHelpers; 
        // Get Cluster parameters.
        const double etaClust = clusterEta(cluster);
        const bool isEndCap = !xAOD::EgammaHelpers::isBarrel(&cluster);
 
        const Amg::Vector3D globTrkPos = lastTrkPars.position(tgContext);
        const double trkEta = Acts::VectorHelpers::eta(lastTrkPars);
        // Calculate the eta/phi of the cluster as would be seen from the perigee
        // position of the Track.
        const Amg::Vector3D globalClusterPosWrtPerigee = approxXYZwrtPoint(cluster, globTrkPos, isEndCap);
 
        auto passDeltaPhi = [&]() -> bool {
            using namespace P4Helpers;
            const double clusterPhi = globalClusterPosWrtPerigee.phi();
            const double trkPhi = lastTrkPars.phi();
            if (std::abs(deltaPhi(trkPhi, clusterPhi)) < m_broadDeltaPhi) {
                return true;
            }
            // Calculate the possible rotation of the track.
            // Once assuming the cluster Et being the better estimate (e.g big brem).
            const double phiRotRescaled = PhiROT(cluster.et(), trkEta, 
                                                 lastTrkPars.charge(), 
                                                 globTrkPos.perp(), isEndCap);
 
             // DeltaPhi between the track and the cluster accounting for rotation assuming
            if (std::abs(deltaPhi(clusterPhi, deltaPhi(trkPhi, phiRotRescaled))) < m_broadDeltaPhi) {
                return true;
            }
            // And also assuming the track Pt being correct.
            const double phiRotTrack = PhiROT(lastTrkPars.transverseMomentum(), trkEta, 
                                              lastTrkPars.charge(), globTrkPos.perp(), isEndCap);
 
            
            // DeltaPhi between the track and the cluster accounting for rotation.
            if (std::abs(deltaPhi(clusterPhi, deltaPhi(trkPhi, phiRotTrack))) < m_broadDeltaPhi) {
                return true;
            }
            ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - broad dPhi matching fails with track phi: "<<
                trkPhi<<", phiRotCluster: "<<phiRotRescaled<<", phiRotTrack: "<<phiRotTrack<<", "
                "cluster phi: "<<cluster.phi()<<", phi corrected: "<<clusterPhi);
            return false;
        };
 
        if (!passDeltaPhi()) {
            return false;
        }
        if (std::abs(etaClust - trkEta) < m_broadDeltaEta || 
            std::abs(globalClusterPosWrtPerigee.eta() - trkEta) < m_broadDeltaEta) {
            return true;
        }
        ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" broad dEta matching fails with track eta: "
            <<trkEta<<", cluster eta: "<<etaClust<<", corrected eta: "<<globalClusterPosWrtPerigee.eta());
        return false;
    }

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

finaloverridevirtual

Retrieve the input

Prepare the clusters to match

Loop over the track particles

Definition at line 149 of file CaloExtensionAlg.cxx.

                                                                      {
 
        const xAOD::TrackParticleContainer* idTracks{nullptr};
        const xAOD::CaloClusterContainer* caloClusters{nullptr};
        const CaloDetDescrManager* detMgr{nullptr};
        ATH_CHECK(SG::get(idTracks, m_trackParticleContainerKey,ctx));
        ATH_CHECK(SG::get(caloClusters, m_clusterContainerKey, ctx));
        ATH_CHECK(SG::get(detMgr, m_caloDetDescrMgrKey, ctx));
        
        const Acts::GeometryContext tgContext = m_ctxProvider.getGeometryContext(ctx);
        const SortedCluster_t coneClusters = selectAndSort(*caloClusters, detMgr);   
  
        SG::WriteHandle writeHandle{m_caloExtensionKey, ctx};
        ATH_CHECK(writeHandle.record(std::make_unique<CaloExtensionContainer>()));
        
        using Link_t = ElementLink<CaloExtensionContainer>;
        SG::WriteDecorHandle<xAOD::TrackParticleContainer, Link_t> decorHandle{m_extensionDecorKey, ctx};
        
        for (const xAOD::TrackParticle* track : *idTracks) {
            Link_t& extensionLink = decorHandle(*track);
            if (track->pt() < m_trackPt ||
                (m_trackSelector.isEnabled() && !m_trackSelector->accept(*track))){
                continue;
            }
            auto extension = propagateToCaloExit(ctx, track);
            if (!extension) {
                continue;
            }
            // Loop over the neighbour bins corresponding to the track eta, phi
            // and match the clusters in that bin to the track
            for (const auto binIdx : coneClusters.neighborHoodIndices(
                                        coneClusters.localBinsFromPosition(pack(track->eta(), track->phi())))){
                ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<"() - Try to match "<<coneClusters.at(binIdx).size()<<
                             " clusters from bin "<<binIdx<<". Central bin "
                <<coneClusters.globalBinFromPosition(pack(track->eta(), track->phi())));
                matchClusters(tgContext, coneClusters.at(binIdx), *extension);
            }
 
            extensionLink = Link_t{writeHandle.cptr(), writeHandle->size()};
            writeHandle->push_back(std::move(extension));
        }
 
        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::CaloExtensionAlg::initialize ( )

finaloverridevirtual

Definition at line 49 of file CaloExtensionAlg.cxx.

                                            {
        ATH_CHECK(m_clusterSelector.retrieve(EnableTool{!m_clusterSelector.empty()}));
        ATH_CHECK(m_trackSelector.retrieve(EnableTool{!m_trackSelector.empty()}));
        ATH_CHECK(m_trackingGeometrySvc.retrieve());
        ATH_CHECK(m_extrapolationTool.retrieve());
 
        ATH_CHECK(m_clusterContainerKey.initialize());
        ATH_CHECK(m_trackParticleContainerKey.initialize());
        ATH_CHECK(m_ctxProvider.initialize());
        ATH_CHECK(m_extensionDecorKey.initialize());
        ATH_CHECK(m_caloDetDescrMgrKey.initialize(m_clusterSelector.isEnabled()));
        ATH_CHECK(m_caloExtensionKey.initialize());
 
        // Here we extract the geometry identifiers of the 4 calo volumes in the ACTS geometry
        // It seems more robust to do the matching with the volume name, since the geometry ID
        // can change if details of the geometry change.
        std::vector<std::pair<std::string, CaloSample>> volIndexNames{};
        for (std::size_t id = 0 ; id < Acts::toUnderlying(CaloSample::Unknown); ++id){
            const auto smpId = static_cast<CaloSample>(id);
            volIndexNames.emplace_back(std::make_pair(CaloSampling::getSamplingName(smpId), smpId));
            ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" - "<<volIndexNames.back().first<<" -> "
                <<volIndexNames.back().second);
        }
        const Acts::TrackingVolume* caloExit = m_trackingGeometrySvc->getEnvelope(SystemEnvelope::CaloExit);
        
        caloExit->visitVolumes([&](const Acts::TrackingVolume *vol) {
            ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" - Check volume: "<<vol->volumeName()<<".");
            auto smpItr = std::ranges::find_if(volIndexNames, [&](const auto& sampleID) {
                return vol->volumeName().starts_with(sampleID.first);
            });
            if (smpItr != volIndexNames.end()) {
                m_geoLayerIds[vol->geometryId()] = smpItr->second;
                ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" - Assign geometryID "<<vol->geometryId()
                     <<"volume: "<<vol->volumeName()<<", to "<<smpItr->second<<".");
            }
        });
      
       
        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;
  }

◆ matchClusters()

void ActsTrk::CaloExtensionAlg::matchClusters	(	const Acts::GeometryContext &	tgContext,
		std::span< const xAOD::CaloCluster *const >	clusterContainer,
		CaloExtension &	caloExtension ) const

private

Match the selected calorimeter clusters to the calo extension.

Parameters

tgContext	The geometry context to align the bound track parameters
clusterContainer	List of pre-selected clusters
caloExtension	Mutable reference to the calo extension where the calorimeter clusters are appended if they satisfiy the dR distance criteria

Definition at line 196 of file CaloExtensionAlg.cxx.

                                                                             {
        
        const auto exitPars = caloExtension.lastTrackParameters();
        
        for (const xAOD::CaloCluster* matchMe : clusterContainer) {
            if (!checkBroadCriteria(tgContext, *matchMe, *exitPars)) {
                continue;
            }
            for (const Acts::BoundTrackParameters& recordedPars: caloExtension.parameters()) {
                const Acts::Surface& surf = recordedPars.referenceSurface();
 
                ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - Try to match "<<recordedPars
                    <<",\nsurface:"<<surf.geometryId()<<", bounds: "<<surf.bounds());
                const Acts::GeometryIdentifier volId = surf.geometryId().withSensitive(0).withBoundary(0);
                
                auto layerItr = m_geoLayerIds.find(volId);
                if (layerItr == m_geoLayerIds.end()){
                    continue;
                }
                const float dEta = clusterEta(*matchMe) - Acts::VectorHelpers::eta(recordedPars);
                const float dPhi = P4Helpers::deltaPhi(matchMe->phi(), recordedPars.phi());
                ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - dEta: "<<dEta<<", dPhi: "<<dPhi<<".");
                if (std::abs(dEta) < m_narrowDeltaEta && 
                    std::abs(dPhi) < m_narrowDeltaPhi) {
                    caloExtension.associateCluster(matchMe);
                    break;
                }
            }
        }
        ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" -  Associated: "<<caloExtension.associatedClusters().size()
                      <<" clusters: "<<clusterContainer.size()<<".");
    }

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

◆ propagateToCaloExit()

std::unique_ptr< CaloExtension > ActsTrk::CaloExtensionAlg::propagateToCaloExit	(	const EventContext &	ctx,
		const xAOD::TrackParticle *	track ) const

private

Propagates the Track from the last track measurement to the calorimeter exit and records all surface crossings between as Acts::BoundTrackParameters.

If one record happened, the result is packed into a CaloExtension object and returned. A nullptr is given back otherwise.

Parameters

ctx	The ATLAS event context to access geometry & magnetic field
track	The ID track particle to be propagated to the exit

Retrieve the last track parameters with a measurement state

Loop over the recorded bound track parameters to append them onto the surface

Definition at line 116 of file CaloExtensionAlg.cxx.

                                                                                                              {
  
        const Acts::TrackingVolume* caloExit = m_trackingGeometrySvc->getEnvelope(SystemEnvelope::CaloExit);
       
        auto extension = std::make_unique<CaloExtension>(track);
        auto lastTrackPars = extension->lastParameters();
        using SurfaceRecordOptions = IExtrapolationTool::SurfaceRecordOptions;
        SurfaceRecordOptions propOpts{caloExit, IExtrapolationTool::VolumeAbort::atExit};
        propOpts.recordMaterial = true;
        propOpts.recordPassive = true;
        propOpts.recordSensitive = true;
 
        auto surfaceRecord = m_extrapolationTool->propagateAndRecord(ctx, *lastTrackPars, propOpts);
        if (!surfaceRecord.ok()) {
            ATH_MSG_WARNING(__func__<<"() "<<__LINE__<<" - Propagation through calorimeter did not succeed");
            return nullptr;
        }
        for (Acts::BoundTrackParameters& record : *surfaceRecord) {
            if (&record.referenceSurface()  == &(lastTrackPars->referenceSurface())) {
                continue;
            }
            ATH_MSG_VERBOSE(__func__<<"() "<<__LINE__<<" - Append calorimeter parameters: "
                <<record<<",\n surface: "<<record.referenceSurface().bounds()<<".");
            extension->appendParameters(std::move(record));
        }
        if (extension->empty()){
            extension.reset();
        }
        return extension;
    }

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

◆ selectAndSort()

CaloExtensionAlg::SortedCluster_t ActsTrk::CaloExtensionAlg::selectAndSort	(	const xAOD::CaloClusterContainer &	clusters,
		const CaloDetDescrManager *	detMgr ) const

private

Selects the calo clusters for the matching to the ID tracks based on the eta range and on a minimum threshold on the energy.

Optionally, the selection tool can be used which requires the use of the CaloDetDescrManager. The Clusters are sorted into a grid which dimension in eta is defined by m_maxClustEta. The number of bins in the two dimensions are determined by the m_broadDeltaEta and m_broadDeltaPhi windows, respectively.

Parameters

clusters	The calorimeter cluster vector to sort into the grid
detMgr	Calo description manager needed if the calo selection tool is used.

Definition at line 91 of file CaloExtensionAlg.cxx.

                                                                               {
        const std::size_t nEtaBins = std::ceil((2. * m_maxClustEta) / m_broadDeltaEta);
        const std::size_t nPhiBins = std::ceil((2.*std::numbers::pi) / m_broadDeltaPhi);
        ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" - Create grid to sort the clusters with "<<nEtaBins
                     <<" bins in eta and "<<nPhiBins<<" bins in phi.");
        SortedCluster_t grid{EtaAxis_t{-m_maxClustEta, m_maxClustEta,nEtaBins},
                            PhiAxis_t{-std::numbers::pi, std::numbers::pi, nPhiBins}};
       
        std::size_t selected{0ul};
        for (const xAOD::CaloCluster* cluster : clusters) {
            if(cluster->et() < m_minClustEt ||
               std::abs(clusterEta(*cluster)) > m_maxClustEta ||
              (m_clusterSelector.isEnabled()  && !m_clusterSelector->passSelection(cluster, *detMgr))) {
              continue;
            }
            ClusterVec_t& bin = grid.atPosition(pack(clusterEta(*cluster), cluster->phi()));
            bin.push_back(cluster);
            ++selected;
        }
        ATH_MSG_DEBUG(__func__<<"() "<<__LINE__<<" - Selected "<<selected
                      <<" out of "<<clusters.size()<<" calo clusters.");
        return grid;   
    }

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

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_broadDeltaEta {this, "broadDeltaEta", 0.2, "Value of broad cut for delta eta" }

private

Broad windowsto initially match the calo cluster with the track exit parameters.

Definition at line 145 of file CaloExtensionAlg.h.

145{this, "broadDeltaEta", 0.2, "Value of broad cut for delta eta" };

◆ m_broadDeltaPhi

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_broadDeltaPhi {this, "broadDeltaPhi", 0.3, "Value of broad cut for delta phi" }

private

Definition at line 147 of file CaloExtensionAlg.h.

147{this, "broadDeltaPhi", 0.3, "Value of broad cut for delta phi" };

◆ m_caloDetDescrMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> ActsTrk::CaloExtensionAlg::m_caloDetDescrMgrKey {this, "CaloDetDescrManager", "CaloDetDescrManager"}

private

Calo description manager.

Definition at line 137 of file CaloExtensionAlg.h.

137{this, "CaloDetDescrManager", "CaloDetDescrManager"};

◆ m_caloExtensionKey

SG::WriteHandleKey<CaloExtensionContainer> ActsTrk::CaloExtensionAlg::m_caloExtensionKey {this, "CaloExtensionName", "CaloExtension"}

private

Definition at line 139 of file CaloExtensionAlg.h.

139{this, "CaloExtensionName", "CaloExtension"};

◆ m_clusterContainerKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> ActsTrk::CaloExtensionAlg::m_clusterContainerKey {this, "ClusterContainerName", "CaloCalTopoClusters"}

private

The input calorimeter cluster collection.

Definition at line 129 of file CaloExtensionAlg.h.

129{this, "ClusterContainerName", "CaloCalTopoClusters"};

◆ m_clusterSelector

ToolHandle<IegammaCaloClusterSelector> ActsTrk::CaloExtensionAlg::m_clusterSelector

private

Initial value:

{this, "ClusterSelector", "egammaCaloClusterSelector",

"Tool that makes the cluster selection"}

Tool to filter the calo clusters.

Definition at line 118 of file CaloExtensionAlg.h.

118 {this, "ClusterSelector", "egammaCaloClusterSelector",

119 "Tool that makes the cluster selection"};

◆ m_ctxProvider

ActsTrk::ContextUtility ActsTrk::CaloExtensionAlg::m_ctxProvider {this}

private

Context provider for geometry, magnetic field and calibration contexts.

Definition at line 123 of file CaloExtensionAlg.h.

123{this};

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

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> ActsTrk::CaloExtensionAlg::m_extensionDecorKey

private

Initial value:

{this, "ExtensionDecoration", m_trackParticleContainerKey,

"caloExtensionLink"}

Decorate the link to the associated CaloExtension directly onto the ID / ITk track.

Definition at line 134 of file CaloExtensionAlg.h.

134 {this, "ExtensionDecoration", m_trackParticleContainerKey,

135 "caloExtensionLink"};

◆ m_extrapolationTool

ToolHandle<IExtrapolationTool> ActsTrk::CaloExtensionAlg::m_extrapolationTool {this, "ExtrapolationTool", ""}

private

Acts extrapolation tool to record the surface intersections.

Definition at line 126 of file CaloExtensionAlg.h.

126{this, "ExtrapolationTool", ""};

◆ m_geoLayerIds

std::unordered_map<Acts::GeometryIdentifier, CaloSample> ActsTrk::CaloExtensionAlg::m_geoLayerIds {}

private

Definition at line 160 of file CaloExtensionAlg.h.

160{};

◆ m_maxClustEta

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_maxClustEta {this, "maxClustEta", 10.}

private

Maximum cut on the cluster's eta in order to be considered.

Definition at line 151 of file CaloExtensionAlg.h.

151{this, "maxClustEta", 10.};

◆ m_minClustEt

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_minClustEt {this, "minClusterEt", 10.*Gaudi::Units::MeV}

private

Minimum requirement on the cluster's transversal energy in order to be considered.

Definition at line 149 of file CaloExtensionAlg.h.

149{this, "minClusterEt", 10.*Gaudi::Units::MeV};

◆ m_narrowDeltaEta

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_narrowDeltaEta {this, "narrowDeltaEta", 0.05}

private

Narrow windows.

Definition at line 156 of file CaloExtensionAlg.h.

156{this, "narrowDeltaEta", 0.05};

◆ m_narrowDeltaPhi

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_narrowDeltaPhi {this, "narrowDeltaPhi", 0.05}

private

Definition at line 158 of file CaloExtensionAlg.h.

158{this, "narrowDeltaPhi", 0.05};

◆ m_propagator

std::unique_ptr<CurvedPropagator_t> ActsTrk::CaloExtensionAlg::m_propagator {}

private

The instance of the propagator.

Definition at line 114 of file CaloExtensionAlg.h.

114{};

◆ m_trackingGeometrySvc

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

private

Tracking geometry service.

Definition at line 121 of file CaloExtensionAlg.h.

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

◆ m_trackParticleContainerKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> ActsTrk::CaloExtensionAlg::m_trackParticleContainerKey

private

Initial value:

{this, "TrackParticleContainerName",

"InDetTrackParticles" }

The input track particle collection.

Definition at line 131 of file CaloExtensionAlg.h.

131 {this, "TrackParticleContainerName",

132 "InDetTrackParticles" };

◆ m_trackPt

Gaudi::Property<float> ActsTrk::CaloExtensionAlg::m_trackPt {this, "minPt", 2.5*Gaudi::Units::GeV}

private

The minimum momentum cut applied on the ID tracks to be considered.

Definition at line 142 of file CaloExtensionAlg.h.

142{this, "minPt", 2.5*Gaudi::Units::GeV};

◆ m_trackSelector

ToolHandle<InDet::IInDetTrackSelectionTool> ActsTrk::CaloExtensionAlg::m_trackSelector {this, "TrackSelectionTool" , ""}

private

Track quality selection tool (optional).

Definition at line 116 of file CaloExtensionAlg.h.

116{this, "TrackSelectionTool" , ""};

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

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

◆ CaloSample

◆ ClusterVec_t

◆ CurvedPropagator_t

◆ CurvedStepper_t

◆ EtaAxis_t

◆ PhiAxis_t

◆ SortedCluster_t

◆ StoreGateSvc_t

Member Function Documentation

◆ checkBroadCriteria()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ matchClusters()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ propagateToCaloExit()

◆ renounce()

◆ renounceArray()

◆ selectAndSort()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_broadDeltaEta

◆ m_broadDeltaPhi

◆ m_caloDetDescrMgrKey

◆ m_caloExtensionKey

◆ m_clusterContainerKey

◆ m_clusterSelector

◆ m_ctxProvider

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_extensionDecorKey

◆ m_extrapolationTool

◆ m_geoLayerIds

◆ m_maxClustEta

◆ m_minClustEt

◆ m_narrowDeltaEta

◆ m_narrowDeltaPhi

◆ m_propagator

◆ m_trackingGeometrySvc

◆ m_trackParticleContainerKey

◆ m_trackPt

◆ m_trackSelector

◆ m_varHandleArraysDeclared

◆ m_vhka