Muon::MuonTruthSegmentCreationAlg Class Reference

#include <MuonTruthSegmentCreationAlg.h>

Inheritance diagram for Muon::MuonTruthSegmentCreationAlg:

Collaboration diagram for Muon::MuonTruthSegmentCreationAlg:

Public Types
using	ChamberIdMap = std::map<Muon::MuonStationIndex::ChIndex, std::vector<Identifier>>
	This map contains all the hits corresponding to truth muons classified by chamber layer that recorded them.

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) 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
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	fillChamberIdMap (const EventContext &ctx, const xAOD::TruthParticle &truthParticle, ChamberIdMap &ids) const
	This function uses the 6 vectors, contained in.
StatusCode	createSegments (const EventContext &ctx, const ElementLink< xAOD::TruthParticleContainer > &truthLink, const ChamberIdMap &ids, xAOD::MuonSegmentContainer &segmentContainer) const
	This function performs, for each truth muon, the actual segment creation and stores segments into a new container.
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::TruthParticleContainer >	m_muonTruth {this, "muonTruth", "MuonTruthParticles"}
	Key for the truth muon container and muon origin decoration.
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_truthOriginKey {this, "truthOriginKey", m_muonTruth, "truthOrigin"}
	FIXME ReadDecorHandle should not be used to access dynamic variables applied by the algorithm which created the container, instead a SG::AuxElement::ConstAccessor should be used.
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_truthClassificationKey {this, "truthClassificationKey", m_muonTruth, "truthClassification"}
SG::ReadDecorHandleKeyArray< xAOD::TruthParticleContainer, std::vector< unsigned long long > >	m_truthHitsKeyArray {this, "truthHitsKeyArray", { }}
	Keys of the truth muon decorations that we need to read to (re-)fill the chamberIdMap.
SG::WriteHandleKey< xAOD::MuonSegmentContainer >	m_muonTruthSegmentContainerName {this, "MuonTruthSegmentName", "MuonTruthSegments"}
	Key for segment container that will be populated with segments.
SG::ReadHandleKeyArray< MuonSimDataCollection >	m_SDO_TruthNames
	Keys for all çontainers of muon hit simulation data, classified by detector technology.
SG::ReadHandleKey< CscSimDataCollection >	m_CSC_SDO_TruthNames {this, "CSCSDOs", "CSC_SDO"}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
	Handle for the muonIdHelper service.
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_detMgrKey
	MuonDetectorManager from the conditions store.
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

Definition at line 38 of file MuonTruthSegmentCreationAlg.h.

Member Typedef Documentation

ChamberIdMap

using Muon::MuonTruthSegmentCreationAlg::ChamberIdMap = std::map<Muon::MuonStationIndex::ChIndex, std::vector<Identifier>>

This map contains all the hits corresponding to truth muons classified by chamber layer that recorded them.

ChIndex is the chamber layer index (e.g. BMS, BOL,...), while Identifier is the hit ID, which represents the channel where the hit has been recorded.

Definition at line 52 of file MuonTruthSegmentCreationAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

createSegments()

StatusCode Muon::MuonTruthSegmentCreationAlg::createSegments ( const EventContext & ctx, const ElementLink< xAOD::TruthParticleContainer > & truthLink, const ChamberIdMap & ids, xAOD::MuonSegmentContainer & segmentContainer ) const

private

This function performs, for each truth muon, the actual segment creation and stores segments into a new container.

Parameters

segmentContainer.	Firstly, we retrieve simulation data from m_SDO_TruthNames and copy it into a new vector, keeping only the data corresponding to the correct detector technologies. Then, we loop over chamber layers and over the corresponding hit IDs, both provided by
ids,and	we store: *- gas-gap for hits with a phi measurement -> phiLayers *- gas-gap for hits recorded by MM or CSC -> precLayers *- 10*multi-layer + tube_layer for hits recorded by MDT -> precLayers *- gas-gap for hits recorded by trigger chambers without phi measurement -> etaLayers Then, in the same loop over hit IDs, we retrieve simulation data for that hit, specifically the global position, needed to retrieve for each chamber layer the pair of hits with the largest distance. If a pair of hits is found and at least three precision measurements are available, we proceed with the truth segment creation. We create a segment obj and we fill it with number and type (see above) of hits available, the
truthLink	link to the corresponding truth muon, and the position and direction of the truth segment, calculated with hit pair global positions. Finally, we append the sector, chamber layer, station eta, and technology of the chamber where the segment was recorded.
ctx	tells us in which event we are
truthLink	link to the corresponding truth muons
ids	chamberIdMap storing truth hit IDs classified by chamber layer
segmentContainer	segment container

Definition at line 123 of file MuonTruthSegmentCreationAlg.cxx.

                                                                                                             {
 
        const MuonGM::MuonDetectorManager* detMgr{nullptr};
        ATH_CHECK(SG::get(detMgr, m_detMgrKey, ctx));
 
        constexpr unsigned techMax = toInt(TechnologyIndex::TechnologyIndexMax);
        std::array<const MuonSimDataCollection*, techMax> sdoCollections{};
        bool useSDO = !m_CSC_SDO_TruthNames.empty();
        for (const SG::ReadHandleKey<MuonSimDataCollection>& k : m_SDO_TruthNames) {
            const MuonSimDataCollection* coll{nullptr};
            ATH_CHECK(SG::get(coll, k, ctx));
            if (coll->empty()) {
                continue;
            }
            Identifier id = coll->begin()->first;
            sdoCollections[toInt(m_idHelperSvc->technologyIndex(id))] = coll;
            useSDO = true;
        }
        // loop over chamber layers
        for (const auto& [chIdx, assocIds] : ids) {
            // skip empty layers
            Amg::Vector3D firstPos{Amg::Vector3D::Zero()}, secondPos{Amg::Vector3D::Zero()};
            bool firstPosSet{false}, secondPosSet{false};
            Identifier chId{};
            int index = -1;
            uint8_t nprecLayers{0}, nphiLayers{0}, ntrigEtaLayers{0};
            std::unordered_set<int> phiLayers{}, etaLayers{}, precLayers{};
            ATH_MSG_DEBUG(" new chamber layer " << Muon::MuonStationIndex::chName(chIdx) << " hits " << assocIds.size());
            // loop over hits
            for (const auto& id : assocIds) {
                ATH_MSG_VERBOSE(" hit " << m_idHelperSvc->toString(id));
                bool measPhi = m_idHelperSvc->measuresPhi(id);
                bool isCsc = m_idHelperSvc->isCsc(id);
                bool isMM = m_idHelperSvc->isMM(id);
                bool isTrig = m_idHelperSvc->isTrigger(id);
                bool isEndcap = m_idHelperSvc->isEndcap(id);
                if (measPhi) {
                    phiLayers.insert(m_idHelperSvc->gasGap(id));
                } else {
                    if (!isTrig) {
                        if (!chId.is_valid()) chId = id;  // use first precision hit in list
                        if (isCsc || isMM) {
                            precLayers.insert(m_idHelperSvc->gasGap(id));
                        } else {
                            int iid = 10 * m_idHelperSvc->mdtIdHelper().multilayer(id) + m_idHelperSvc->mdtIdHelper().tubeLayer(id);
                            precLayers.insert(iid);
                            // ATH_MSG_VERBOSE("iid " << iid << " precLayers size " << precLayers.size() );
                        }
                    } else {
                        etaLayers.insert(m_idHelperSvc->gasGap(id));
                    }
                }
                // use SDO to look-up truth position of the hit
                if (!useSDO) {
                    continue;
                }
                Amg::Vector3D gpos{Amg::Vector3D::Zero()};
                if (!isCsc) {
                    bool ok = false;
                    TechnologyIndex techIdx = m_idHelperSvc->technologyIndex(id);
                    if (sdoCollections[toInt(techIdx)]) {
                        auto pos = sdoCollections[toInt(techIdx)]->find(id);
                        if (pos != sdoCollections[toInt(techIdx)]->end()) {
                            gpos = pos->second.globalPosition();
                            if (gpos.perp() > 0.1) ok = true;  // sanity check
                        }
                    }
                    // look up successful, calculate
                    if (!ok) continue;
 
                    // small comparison function
                    auto isSmaller = [isEndcap](const Amg::Vector3D& p1, const Amg::Vector3D& p2) {
                        if (isEndcap)
                            return std::abs(p1.z()) < std::abs(p2.z());
                        else
                            return p1.perp() < p2.perp();
                    };
                    if (!firstPosSet) {
                        firstPos = gpos;
                        firstPosSet = true;
                    } else if (!secondPosSet) {
                        secondPos = gpos;
                        secondPosSet = true;
                        if (isSmaller(secondPos, firstPos)) std::swap(firstPos, secondPos);
                    } else {
                        // update position if we can increase the distance between the two positions
                        if (isSmaller(gpos, firstPos))
                            firstPos = gpos;
                        else if (isSmaller(secondPos, gpos))
                            secondPos = gpos;
                    }
                } else {
                    SG::ReadHandle cscCollection(m_CSC_SDO_TruthNames, ctx);
                    ATH_CHECK(cscCollection.isPresent());
                    auto pos = cscCollection->find(id);
                    if (pos == cscCollection->end()) {
                        continue;
                    }
                    const MuonGM::CscReadoutElement* descriptor = detMgr->getCscReadoutElement(id);
                    ATH_MSG_DEBUG("found csc sdo with " << pos->second.getdeposits().size() << " deposits");
                    Amg::Vector3D locpos(0, pos->second.getdeposits()[0].second.ypos(), pos->second.getdeposits()[0].second.zpos());
                    gpos = descriptor->localToGlobalCoords(locpos, m_idHelperSvc->cscIdHelper().elementID(id));
                    ATH_MSG_DEBUG("got CSC global position " << gpos);
                    if (!firstPosSet) {
                        firstPos = gpos;
                        firstPosSet = true;
                    } else if (!secondPosSet) {
                        secondPos = gpos;
                        secondPosSet = true;
                        if (secondPos.perp() < firstPos.perp()) std::swap(firstPos, secondPos);
                    } else {
                        if (gpos.perp() < firstPos.perp())
                            firstPos = gpos;
                        else if (secondPos.perp() < gpos.perp())
                            secondPos = gpos;
                    }
                }
            }
            if (precLayers.size() > 2) {
                if (!phiLayers.empty()) nphiLayers = phiLayers.size();
                ntrigEtaLayers = etaLayers.size();
                nprecLayers = precLayers.size();
                ATH_MSG_DEBUG(" total counts: precision " << static_cast<int>(nprecLayers) << " phi layers " << static_cast<int>(nphiLayers)
                              << " eta trig layers " << static_cast<int>(ntrigEtaLayers)
                              << " associated reco muon " << index << " unique ID " << HepMC::uniqueID(*truthLink)
                              << " truthLink " << truthLink);
                xAOD::MuonSegment* segment =  segmentContainer.push_back(std::make_unique<xAOD::MuonSegment>());
 
                segment->setNHits(nprecLayers, nphiLayers, ntrigEtaLayers);
                static const SG::Accessor<ElementLink<xAOD::TruthParticleContainer> >
                  truthParticleLinkAcc("truthParticleLink");
                truthParticleLinkAcc(*segment) = truthLink;
                if (chId.is_valid()) {    //we should always enter here if we have precision measurements
                    int eta = m_idHelperSvc->stationEta(chId);
                    int sector = m_idHelperSvc->sector(chId);
                    MuonStationIndex::TechnologyIndex technology = m_idHelperSvc->technologyIndex(chId);
                    MuonStationIndex::ChIndex chIndex = m_idHelperSvc->chamberIndex(chId);
                    segment->setIdentifier(sector, chIndex, eta, technology);
                }
                if (firstPosSet && secondPosSet) {
                    Amg::Vector3D gpos = (firstPos + secondPos) / 2.;
                    Amg::Vector3D gdir = (firstPos - secondPos).unit();
                    ATH_MSG_DEBUG(" got position : r " << gpos.perp() << " z " << gpos.z() << "  and direction: theta " << gdir.theta()
                                                       << " phi " << gdir.phi());
                    segment->setPosition(gpos.x(), gpos.y(), gpos.z());
                    segment->setDirection(gdir.x(), gdir.y(), gdir.z());
                }
            }
        }
        return StatusCode::SUCCESS;
    }

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode Muon::MuonTruthSegmentCreationAlg::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 61 of file MuonTruthSegmentCreationAlg.cxx.

                                                                                 {
 
        const xAOD::TruthParticleContainer* muonTruthContainer{nullptr};
        ATH_CHECK(SG::get(muonTruthContainer, m_muonTruth, ctx));
 
        SG::ReadDecorHandle<xAOD::TruthParticleContainer, int> truthOrigin(m_truthOriginKey, ctx);
        ATH_CHECK(truthOrigin.isPresent());
        SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int> truthClassification(m_truthClassificationKey, ctx);
        ATH_CHECK(truthClassification.isPresent()); // May need to comment this out initially
 
        // create output container
        SG::WriteHandle segmentContainer(m_muonTruthSegmentContainerName, ctx);
        ATH_CHECK(segmentContainer.record(std::make_unique<xAOD::MuonSegmentContainer>(),
                                          std::make_unique<xAOD::MuonSegmentAuxContainer>()));
        ATH_MSG_DEBUG("Recorded MuonSegmentContainer with key: " << segmentContainer.name());
 
        size_t itr = 0;
        for (const xAOD::TruthParticle* truthParticle : *muonTruthContainer) {
            // TODO adapt the logic in this loop to use truthClassification rather than truthOrigin
            const int iOrigin = truthOrigin(*truthParticle);
            bool goodMuon = bad_origins.find(iOrigin) == bad_origins.end();
 
            // create segments
            if (goodMuon) {
                ElementLink<xAOD::TruthParticleContainer> truthLink(*muonTruthContainer, itr);
                truthLink.toPersistent();
 
                ChamberIdMap ids{};
                ATH_CHECK(fillChamberIdMap(ctx, *truthParticle, ids));
                ATH_CHECK(createSegments(ctx, truthLink, ids, *segmentContainer));
            }
            itr++;
        }
 
        ATH_MSG_DEBUG("Registered " << segmentContainer->size() << " truth muon segments ");
 
        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();
}

fillChamberIdMap()

StatusCode Muon::MuonTruthSegmentCreationAlg::fillChamberIdMap ( const EventContext & ctx, const xAOD::TruthParticle & truthParticle, ChamberIdMap & ids ) const

private

This function uses the 6 vectors, contained in.

Parameters

hitsCollection,carrying	truth muon hit IDs categorized by detector technology (MDT, TGC, RPC, sTGC, CSC, MM) to (re-)fill the
ids	ChamberIdMap, which contains all truth muon hit IDs classified by chamber layer. This function retrieves the chamber layer from the hit ID by means of the muonIdHelper tool.
hitsCollection	hit collection
ids	empty chamberIdMap

Definition at line 100 of file MuonTruthSegmentCreationAlg.cxx.

                                                                                     {
 
        for (SG::ReadDecorHandle<xAOD::TruthParticleContainer, std::vector<unsigned long long>>& hitCollection : m_truthHitsKeyArray.makeHandles(ctx)){
            for (const unsigned long long& hit_compID : hitCollection(truthParticle)){
                const Identifier id{hit_compID};
                if (m_idHelperSvc->isTgc(id)) {  // TGCS should be added to both EIL and EIS
                    if (m_idHelperSvc->phiIndex(id) == PhiIndex::T4) {
                        ids[ChIndex::EIS].push_back(id);
                        ids[ChIndex::EIL].push_back(id);
                    } else {
                        ids[ChIndex::EMS].push_back(id);
                        ids[ChIndex::EML].push_back(id);
                    }
                } else {
                    ids[m_idHelperSvc->chamberIndex(id) ].push_back(id);
                }
            }
        }
        return StatusCode::SUCCESS;
    }

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 Muon::MuonTruthSegmentCreationAlg::initialize ( )

overridevirtual

Definition at line 38 of file MuonTruthSegmentCreationAlg.cxx.

                                                       {
        ATH_CHECK(m_muonTruth.initialize());
 
        ATH_CHECK(m_muonTruthSegmentContainerName.initialize());
        ATH_CHECK(m_SDO_TruthNames.initialize());
        ATH_CHECK(m_CSC_SDO_TruthNames.initialize(!m_CSC_SDO_TruthNames.empty()));
 
        ATH_CHECK(m_detMgrKey.initialize());
        ATH_CHECK(m_idHelperSvc.retrieve());
 
        ATH_CHECK(m_truthOriginKey.initialize());
        ATH_CHECK(m_truthClassificationKey.initialize());
        if(m_idHelperSvc->hasRPC()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthRpcHits");}
        if(m_idHelperSvc->hasTGC()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthTgcHits");}
        if(m_idHelperSvc->hasMDT()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthMdtHits");}
        if(m_idHelperSvc->hasMM()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthMMHits");}
        if(m_idHelperSvc->hasSTGC()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthStgcHits");}
        if(m_idHelperSvc->hasCSC()) {m_truthHitsKeyArray.emplace_back(m_muonTruth, "truthCscHits");}
        ATH_CHECK(m_truthHitsKeyArray.initialize());
        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_CSC_SDO_TruthNames

SG::ReadHandleKey<CscSimDataCollection> Muon::MuonTruthSegmentCreationAlg::m_CSC_SDO_TruthNames {this, "CSCSDOs", "CSC_SDO"}

private

Definition at line 108 of file MuonTruthSegmentCreationAlg.h.

{this, "CSCSDOs", "CSC_SDO"};

m_detMgrKey

SG::ReadCondHandleKey<MuonGM::MuonDetectorManager> Muon::MuonTruthSegmentCreationAlg::m_detMgrKey

private

Initial value:

{this, "DetectorManagerKey", "MuonDetectorManager",
                                                                      "Key of input MuonDetectorManager condition data"}

MuonDetectorManager from the conditions store.

Definition at line 114 of file MuonTruthSegmentCreationAlg.h.

                                                                  {this, "DetectorManagerKey", "MuonDetectorManager",
                                                                      "Key of input MuonDetectorManager condition data"};

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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::MuonTruthSegmentCreationAlg::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Handle for the muonIdHelper service.

Definition at line 111 of file MuonTruthSegmentCreationAlg.h.

{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

m_muonTruth

SG::ReadHandleKey<xAOD::TruthParticleContainer> Muon::MuonTruthSegmentCreationAlg::m_muonTruth {this, "muonTruth", "MuonTruthParticles"}

private

Key for the truth muon container and muon origin decoration.

Definition at line 90 of file MuonTruthSegmentCreationAlg.h.

{this, "muonTruth", "MuonTruthParticles"};

m_muonTruthSegmentContainerName

SG::WriteHandleKey<xAOD::MuonSegmentContainer> Muon::MuonTruthSegmentCreationAlg::m_muonTruthSegmentContainerName {this, "MuonTruthSegmentName", "MuonTruthSegments"}

private

Key for segment container that will be populated with segments.

Definition at line 103 of file MuonTruthSegmentCreationAlg.h.

{this, "MuonTruthSegmentName", "MuonTruthSegments"};

m_SDO_TruthNames

SG::ReadHandleKeyArray<MuonSimDataCollection> Muon::MuonTruthSegmentCreationAlg::m_SDO_TruthNames

private

Initial value:

{
            this, "SDOs", {"RPC_SDO", "TGC_SDO", "MDT_SDO" }, "remove NSW by default for now, can always be changed in the configuration"}

Keys for all çontainers of muon hit simulation data, classified by detector technology.

Definition at line 106 of file MuonTruthSegmentCreationAlg.h.

                                                                    {
            this, "SDOs", {"RPC_SDO", "TGC_SDO", "MDT_SDO" }, "remove NSW by default for now, can always be changed in the configuration"};

m_truthClassificationKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> Muon::MuonTruthSegmentCreationAlg::m_truthClassificationKey {this, "truthClassificationKey", m_muonTruth, "truthClassification"}

private

Definition at line 96 of file MuonTruthSegmentCreationAlg.h.

{this, "truthClassificationKey", m_muonTruth, "truthClassification"};

m_truthHitsKeyArray

SG::ReadDecorHandleKeyArray<xAOD::TruthParticleContainer, std::vector<unsigned long long> > Muon::MuonTruthSegmentCreationAlg::m_truthHitsKeyArray {this, "truthHitsKeyArray", { }}

private

Keys of the truth muon decorations that we need to read to (re-)fill the chamberIdMap.

Each key corresponds to the decorator containing hit IDs for each muon for a specific detector technology.

Definition at line 100 of file MuonTruthSegmentCreationAlg.h.

{this, "truthHitsKeyArray", { }};

m_truthOriginKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> Muon::MuonTruthSegmentCreationAlg::m_truthOriginKey {this, "truthOriginKey", m_muonTruth, "truthOrigin"}

private

FIXME ReadDecorHandle should not be used to access dynamic variables applied by the algorithm which created the container, instead a SG::AuxElement::ConstAccessor should be used.

Definition at line 95 of file MuonTruthSegmentCreationAlg.h.

{this, "truthOriginKey", m_muonTruth, "truthOrigin"};

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:

• MuonTruthSegmentCreationAlg.h
• MuonTruthSegmentCreationAlg.cxx