Conditions algorithm to create the region selector trigger tables from the R4 readout geoemetry. More...

#include <RegionSelectorCondAlg.h>

Inheritance diagram for MuonR4::RegionSelectorCondAlg:

Collaboration diagram for MuonR4::RegionSelectorCondAlg:

Public Member Functions
virtual StatusCode	initialize () override final
virtual StatusCode	execute (const EventContext &ctx) const override final
virtual bool	isReEntrant () const override
	Avoid scheduling algorithm multiple times.
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
template<typename Key_t, typename... OtherKey_t>
StatusCode	addCondDependency (const EventContext &ctx, SG::WriteCondHandle< IRegSelLUTCondData > &writeHandle, const SG::ReadCondHandleKey< Key_t > &key, OtherKey_t... others) const
	Declare the dependency of the region selector table on the other keys set.
const MuonIdHelper &	getIdHelper (const ActsTrk::DetectorType type) const
	Retrieve the idHelper for the given detector technology.
std::set< std::uint32_t >	getRobIDs (const EventContext &ctx, const Identifier &moduleID) const
	Returns the list of ROB ids associated with the module.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}
	Detector manager.
Gaudi::Property< bool >	m_printTable {this, "PrintTable", false}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
SG::WriteCondHandleKey< IRegSelLUTCondData >	m_tableKey { this, "RegSelLUT", "", "Region Selector lookup table" }
	Region selector table written by the algorithm.
SG::ReadCondHandleKey< ActsTrk::DetectorAlignStore >	m_alignKey {this, "AlignKey", ""}
	Dependency on the alignment constants.
SG::ReadCondHandleKey< MuonMDT_CablingMap >	m_cablingMdtKey {this, "MdtCablingKey", "MuonMDT_CablingMap"}
	Dependency on the Mdt cabling map.
SG::ReadCondHandleKey< Muon::RpcCablingMap >	m_cablingRpcKey {this, "RpcCablingKey", "MuonNRPC_CablingMap"}
	Dependency on the phase II Rpc cabling map.
SG::ReadCondHandleKey< Muon::TgcCablingMap >	m_cablingTgcKey {this, "TgcCablingKey", "MuonTgc_CablingMap"}
	Dependency on the Tgc cabling map.
Gaudi::Property< bool >	m_splitTrfCache {this, "splitTrfCache", false, ""}
	Instantiate a new transform cache to ensure lazy transform population in the event processing.
Gaudi::Property< bool >	m_dumpObjVolumes {this, "dumpObjVolumes", false}
	Dump the volumes from which the region selector tables are built.
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

Conditions algorithm to create the region selector trigger tables from the R4 readout geoemetry.

Definition at line 31 of file RegionSelectorCondAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ addCondDependency()

template<typename Key_t, typename... OtherKey_t>

StatusCode MuonR4::RegionSelectorCondAlg::addCondDependency	(	const EventContext &	ctx,
		SG::WriteCondHandle< IRegSelLUTCondData > &	writeHandle,
		const SG::ReadCondHandleKey< Key_t > &	key,
		OtherKey_t...	others ) const

private

Declare the dependency of the region selector table on the other keys set.

Parameters

ctx	EventContext to load the conditions object
writeHandle	Reference to the new writeHandle to be written to Storegate
key	Primary key on which the dependency is declared
others	Other keys for recursive dependency declaration

Definition at line 36 of file RegionSelectorCondAlg.cxx.

                                                           {
        if (!key.empty()) {
            SG::ReadCondHandle readHandle{key, ctx};
            if (!readHandle.isValid()){
                ATH_MSG_FATAL("Failed to retrieve "<<key.fullKey()<<".");
                return StatusCode::FAILURE;
            }
            writeHandle.addDependency(readHandle);
        }
        if constexpr(sizeof...(others) > 0) {
            ATH_CHECK(addCondDependency(ctx, writeHandle, others...));
        }
        return StatusCode::SUCCESS;
    }

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

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

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

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

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode MuonR4::RegionSelectorCondAlg::execute ( const EventContext & ctx ) const

finaloverridevirtual

Temporary auxiliary struct to cache the readout element's dimension in z, r & phi

Fill the geometric part of the reg sel table

Now we need to combine it with the ROB id

Definition at line 111 of file RegionSelectorCondAlg.cxx.

                                                                           {
        SG::WriteCondHandle writeHandle{m_tableKey, ctx};
        if (writeHandle.isValid()) {
            ATH_MSG_DEBUG("Region selector "<<m_tableKey<<" is still valid");
            return StatusCode::SUCCESS;
        }
        writeHandle.addDependency(IOVInfiniteRange::infiniteRunLB());
        ATH_CHECK(addCondDependency(ctx, writeHandle, m_alignKey, m_cablingMdtKey,
                                                      m_cablingRpcKey, m_cablingTgcKey));
 
        auto writeCdo = std::make_unique<RegSelSiLUT>();
        const ActsTrk::DetectorAlignStore* alignDeltas{nullptr};
        ATH_CHECK(SG::get(alignDeltas, m_alignKey, ctx));
 
        ActsTrk::GeometryContext gctx{};
        if (m_splitTrfCache) {
            gctx.setStore(MuonGMR4::copyDeltas(*alignDeltas));
        } else {
            gctx.setStore(std::make_unique<ActsTrk::DetectorAlignStore>(*alignDeltas));
        }
        const MuonIdHelper& idHelper{getIdHelper(alignDeltas->detType)};
        struct TempSelTable {
            std::optional<double> centralPhi{};
            double zMin{std::numeric_limits<double>::max()}; 
            double zMax{-std::numeric_limits<double>::max()};
            double rMin{std::numeric_limits<double>::max()}; 
            double rMax{-std::numeric_limits<double>::max()};
            double dPhiMin{std::numeric_limits<double>::max()}; 
            double dPhiMax{-std::numeric_limits<double>::max()};
 
            void update(const Amg::Vector3D& v) {
                const double dPhi = xAOD::P4Helpers::deltaPhi(v.phi(), centralPhi.value_or(0.));
                rMin = std::min(rMin, v.perp());   rMax = std::max(rMax, v.perp());
                zMin = std::min(zMin, v.z());      zMax = std::max(zMax, v.z());
                dPhiMin = std::min(dPhiMin, dPhi); dPhiMax = std::max(dPhiMax, dPhi);
            }
    
        };
        std::vector<TempSelTable> luts(idHelper.module_hash_max());
        IdentifierHash modHash{};
        std::vector<std::unique_ptr<Acts::Volume>> objVolumes{};
        std::vector<std::shared_ptr<const Acts::Surface>> objSurfaces{};
        for (const MuonGMR4::MuonReadoutElement* reEle: m_detMgr->getAllReadoutElements(alignDeltas->detType)) {
            
            const Acts::Surface& surface{reEle->surface()};
 
            const double halfTck = 0.5*reEle->thickness();
 
            std::vector<Amg::Vector3D> localVertices{};
            localVertices.reserve(8);
            ATH_MSG_VERBOSE(__LINE__<<" - Fetch edge points from surface: "<<m_idHelperSvc->toStringDetEl(reEle->identify()));
            std::ranges::for_each(static_cast<const Acts::PlanarBounds&>(surface.bounds()).vertices(), 
                    [&](const Amg::Vector2D& v){
                        ATH_MSG_VERBOSE(__LINE__<<" - Local vertex: "<<Amg::toString(v)<<", half thickness: "<<halfTck);
                        localVertices.emplace_back(v.x(), v.y(), halfTck);
                        localVertices.emplace_back(v.x(), v.y(), -halfTck);
                    });
            
            if (m_dumpObjVolumes) {
                std::unique_ptr<Acts::VolumeBounds> volBounds{};
                objSurfaces.emplace_back(surface.getSharedPtr());
                switch (surface.bounds().type()) {
                    using enum Acts::SurfaceBounds::BoundsType;
                    case eRectangle:{
                        using vEnum = Acts::RectangleBounds::BoundValues;
                        const auto& bounds{static_cast<const Acts::RectangleBounds&>(surface.bounds())};
                        volBounds = std::make_unique<Acts::CuboidVolumeBounds>(bounds.get(vEnum::eMaxX),
                                                                               bounds.get(vEnum::eMaxY), 
                                                                               halfTck);
                        break;
                    } case eTrapezoid: {
                        using vEnum = Acts::TrapezoidBounds::BoundValues;
                        const auto& bounds{static_cast<const Acts::TrapezoidBounds&>(surface.bounds())};
                        volBounds = std::make_unique<Acts::TrapezoidVolumeBounds>(bounds.get(vEnum::eHalfLengthXnegY),
                                                                                  bounds.get(vEnum::eHalfLengthXposY),
                                                                                  bounds.get(vEnum::eHalfLengthY), 
                                                                                  halfTck);
                        break;
                    } default:
                        THROW_EXCEPTION("Unsupported bounds "<<surface.bounds());
                }
                objVolumes.emplace_back(std::make_unique<Acts::Volume>(surface.localToGlobalTransform(gctx.context()),
                                                                       std::move(volBounds)));
            }
                    
            ATH_MSG_VERBOSE(__LINE__<<" - Fetched "<<localVertices.size()<<" vertices.");
            const Amg::Transform3D& loc2Glob{surface.localToGlobalTransform(gctx.context())};
            idHelper.get_module_hash(reEle->identify(), modHash);
            auto& lut = luts.at(modHash);
            if (!lut.centralPhi) {
                lut.centralPhi = loc2Glob.translation().phi();
            }
            for (const Amg::Vector3D& locVtx : localVertices) {
                const Amg::Vector3D globVtx = loc2Glob * locVtx;
                ATH_MSG_VERBOSE(__LINE__<<" - Expand LUT with vertex "
                        <<std::format("{:.2f}/{:.2f}/{:.2f}", globVtx.perp(), globVtx.z(), globVtx.phi()));
                lut.update(globVtx);
            }
        }
        const auto modCtx = idHelper.module_context();
        for (auto module_itr = idHelper.module_begin();
                  module_itr != idHelper.module_end(); ++module_itr) {
            idHelper.get_module_hash(*module_itr, modHash);
            const auto& lut = luts.at(modHash);
 
            if(!lut.centralPhi) {
                continue;
            }
 
            ExpandedIdentifier exp_id{};
            if (idHelper.get_expanded_id(*module_itr, exp_id, &modCtx)) {
                ATH_MSG_DEBUG(__LINE__<<" - Failed retrieving ExpandedIdentifier for PRD Identifier = " 
                        << m_idHelperSvc->toString(*module_itr) << ". Skipping to the next PRD.");
              continue;
            }
            const int detid   = ( exp_id[2]<0 ? -1 : 1 );
            const int layerid = exp_id[1]+1;
 
            const double phiMin = lut.centralPhi.value_or(0) + lut.dPhiMin;
            const double phiMax = lut.centralPhi.value_or(0) + lut.dPhiMax;
            
 
            for (const std::uint32_t robID : getRobIDs(ctx, *module_itr)) {
                RegSelModule m{lut.zMin, lut.zMax, lut.rMin, lut.rMax, 
                               phiMin, phiMax, layerid, detid, robID, modHash};
                ATH_MSG_VERBOSE(__LINE__<<" - Insert new entry "<<m_idHelperSvc->chamberNameString(*module_itr)
                                <<", "<<m);
                writeCdo->addModule(m);
            }
        }
 
        if (m_printTable) {
            if (const auto *lut = dynamic_cast<const RegSelSiLUT*>(writeCdo.get())) {
                lut->write(std::format("{:}.map", name()));
            }
        }
        if (!objVolumes.empty()) {  
            Acts::ObjVisualization3D visualHelper{};
            for (const auto& volume : objVolumes) {
                Acts::GeometryView3D::drawVolume(visualHelper, *volume,
                                                 gctx.context());
            }
            for (const auto& surface : objSurfaces) {
                Acts::GeometryView3D::drawSurface(visualHelper, *surface,
                                                  gctx.context());
            }
            visualHelper.write(std::format("RegSelVolumes_{:}.obj", alignDeltas->detType));
 
        }
 
        ATH_CHECK(writeHandle.record(std::make_unique<IRegSelLUTCondData>(std::move(writeCdo))));
        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();
  }

◆ getIdHelper()

const MuonIdHelper & MuonR4::RegionSelectorCondAlg::getIdHelper ( const ActsTrk::DetectorType type ) const

private

Retrieve the idHelper for the given detector technology.

Parameters

type	Muon detector technology type

Definition at line 54 of file RegionSelectorCondAlg.cxx.

                                                                                               {
        switch (type) {
            using enum ActsTrk::DetectorType;
            case Mdt: 
                return m_idHelperSvc->mdtIdHelper();
            case Rpc:
                return m_idHelperSvc->rpcIdHelper();
            case Tgc:
                return m_idHelperSvc->tgcIdHelper();
            case Mm:
                return m_idHelperSvc->mmIdHelper();
            case sTgc:
                return m_idHelperSvc->stgcIdHelper();
            default:
                THROW_EXCEPTION("Unknown detector type "<<type<<".");
        }
    }

◆ getRobIDs()

std::set< std::uint32_t > MuonR4::RegionSelectorCondAlg::getRobIDs	(	const EventContext &	ctx,
		const Identifier &	moduleID ) const

private

Returns the list of ROB ids associated with the module.

Parameters

ctx	EventContext to access the conditions store
moduleID	Chamber module identifier

Definition at line 72 of file RegionSelectorCondAlg.cxx.

                                                                                               {
        
        switch(m_idHelperSvc->technologyIndex(moduleID)) {
            using enum Muon::MuonStationIndex::TechnologyIndex;
            case MDT: {
                const MuonMDT_CablingMap* cabling{};
                if (!SG::get(cabling, m_cablingMdtKey, ctx).isSuccess()) {
                    THROW_EXCEPTION("Failed to load Mdt cabling "<<m_cablingMdtKey.fullKey());
                }
                return {cabling->getROBId(m_idHelperSvc->moduleHash(moduleID), msgStream())};
            } case RPC: {
                const Muon::RpcCablingMap* cabling{};
                if (!SG::get(cabling, m_cablingRpcKey, ctx).isSuccess()) {
                    THROW_EXCEPTION("Failed to load Rpc cabling "<<m_cablingRpcKey.fullKey());
                }
                return {cabling->getROBId(m_idHelperSvc->moduleHash(moduleID), msgStream())};
            } case TGC: {
                const Muon::TgcCablingMap* cabling{};
                if (!SG::get(cabling, m_cablingTgcKey, ctx).isSuccess()) {
                    THROW_EXCEPTION("Failed to load Tgc cabling");
                }
                int subDetectorId{}, rodId{};
                cabling->getReadoutIDfromElementID(moduleID, subDetectorId, rodId);
                return {static_cast<std::uint32_t>(((0x0ff) & subDetectorId)<<16 | rodId)};
            } case MM:
              case STGC:{
                Muon::nsw::helper::NSWOfflineRobId robIdHelper{
                        m_idHelperSvc->stationNameString(moduleID),
                        static_cast<int8_t>(m_idHelperSvc->stationEta(moduleID)),
                        static_cast<uint8_t>(m_idHelperSvc->stationPhi(moduleID))};
                return std::set<std::uint32_t>(robIdHelper.get_ids().begin(), robIdHelper.get_ids().end());
            } default: {
                THROW_EXCEPTION("Invalid identifier "<<m_idHelperSvc->toStringChamber(moduleID));
            }
        }
        return {};
    }

◆ initialize()

StatusCode MuonR4::RegionSelectorCondAlg::initialize ( )

finaloverridevirtual

Definition at line 25 of file RegionSelectorCondAlg.cxx.

                                                 {
        ATH_CHECK(detStore()->retrieve(m_detMgr));
        ATH_CHECK(m_tableKey.initialize());
        ATH_CHECK(m_alignKey.initialize());
        ATH_CHECK(m_cablingMdtKey.initialize(SG::AllowEmpty));
        ATH_CHECK(m_cablingRpcKey.initialize(SG::AllowEmpty));
        ATH_CHECK(m_cablingTgcKey.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;
  }

◆ isReEntrant()

virtual bool AthCondAlgorithm::isReEntrant ( ) const

inlineoverridevirtualinherited

Avoid scheduling algorithm multiple times.

With multiple concurrent events, conditions objects often expire simultaneously for all slots. To avoid that the scheduler runs the CondAlg in each slot, we declare it as "non-reentrant". This ensures that the conditions objects are only created once.

In case a particular CondAlg should behave differently, it can override this method again and return true.

See also: ATEAM-836

Definition at line 39 of file AthCondAlgorithm.h.

39{ return false; }

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

SG::ReadCondHandleKey<ActsTrk::DetectorAlignStore> MuonR4::RegionSelectorCondAlg::m_alignKey {this, "AlignKey", ""}

private

Dependency on the alignment constants.

Definition at line 69 of file RegionSelectorCondAlg.h.

69{this, "AlignKey", ""};

◆ m_cablingMdtKey

SG::ReadCondHandleKey<MuonMDT_CablingMap> MuonR4::RegionSelectorCondAlg::m_cablingMdtKey {this, "MdtCablingKey", "MuonMDT_CablingMap"}

private

Dependency on the Mdt cabling map.

Definition at line 71 of file RegionSelectorCondAlg.h.

71{this, "MdtCablingKey", "MuonMDT_CablingMap"};

◆ m_cablingRpcKey

SG::ReadCondHandleKey<Muon::RpcCablingMap> MuonR4::RegionSelectorCondAlg::m_cablingRpcKey {this, "RpcCablingKey", "MuonNRPC_CablingMap"}

private

Dependency on the phase II Rpc cabling map.

Definition at line 73 of file RegionSelectorCondAlg.h.

73{this, "RpcCablingKey", "MuonNRPC_CablingMap"};

◆ m_cablingTgcKey

SG::ReadCondHandleKey<Muon::TgcCablingMap> MuonR4::RegionSelectorCondAlg::m_cablingTgcKey {this, "TgcCablingKey", "MuonTgc_CablingMap"}

private

Dependency on the Tgc cabling map.

Definition at line 75 of file RegionSelectorCondAlg.h.

75{this, "TgcCablingKey", "MuonTgc_CablingMap"};

◆ m_detMgr

const MuonGMR4::MuonDetectorManager* MuonR4::RegionSelectorCondAlg::m_detMgr {nullptr}

private

Detector manager.

Definition at line 62 of file RegionSelectorCondAlg.h.

62{nullptr};

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

Gaudi::Property<bool> MuonR4::RegionSelectorCondAlg::m_dumpObjVolumes {this, "dumpObjVolumes", false}

private

Dump the volumes from which the region selector tables are built.

Definition at line 79 of file RegionSelectorCondAlg.h.

79{this, "dumpObjVolumes", false};

◆ m_evtStore

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

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_idHelperSvc

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

private

Definition at line 65 of file RegionSelectorCondAlg.h.

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

◆ m_printTable

Gaudi::Property<bool> MuonR4::RegionSelectorCondAlg::m_printTable {this, "PrintTable", false}

private

Definition at line 64 of file RegionSelectorCondAlg.h.

64{this, "PrintTable", false};

◆ m_splitTrfCache

Gaudi::Property<bool> MuonR4::RegionSelectorCondAlg::m_splitTrfCache {this, "splitTrfCache", false, ""}

private

Instantiate a new transform cache to ensure lazy transform population in the event processing.

Definition at line 77 of file RegionSelectorCondAlg.h.

77{this, "splitTrfCache", false, ""};

◆ m_tableKey

SG::WriteCondHandleKey<IRegSelLUTCondData> MuonR4::RegionSelectorCondAlg::m_tableKey { this, "RegSelLUT", "", "Region Selector lookup table" }

private

Region selector table written by the algorithm.

Definition at line 67 of file RegionSelectorCondAlg.h.

67{ this, "RegSelLUT", "", "Region Selector lookup table" };

◆ 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

◆ StoreGateSvc_t

Member Function Documentation

◆ addCondDependency()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ getIdHelper()

◆ getRobIDs()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ isReEntrant()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_alignKey

◆ m_cablingMdtKey

◆ m_cablingRpcKey

◆ m_cablingTgcKey

◆ m_detMgr

◆ m_detStore

◆ m_dumpObjVolumes

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_idHelperSvc

◆ m_printTable

◆ m_splitTrfCache

◆ m_tableKey

◆ m_varHandleArraysDeclared

◆ m_vhka