#include <MuonLayerHashProviderTool.h>

Inheritance diagram for Muon::MuonLayerHashProviderTool:

Collaboration diagram for Muon::MuonLayerHashProviderTool:

Classes
struct	RegionHashesPerSector

Public Types
using	HashVec = std::vector<IdentifierHash>
	define data structure
using	RegionHashVec = std::array<HashVec, MuonStationIndex::sectorLayerHashMax()>
using	TechnologyIndex = MuonStationIndex::TechnologyIndex
using	TechnologyRegionHashVec = std::array< RegionHashVec, techMax>
using	RegionHashesPerSectorVec = std::array<RegionHashesPerSector, MuonStationIndex::numberOfSectors()>

Public Member Functions
const HashVec &	getHashes (int sector, TechnologyIndex technologyIndex, unsigned int sectorLayerHash) const
	access hashes for a given sector, technology and layer hash
	MuonLayerHashProviderTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default AlgTool functions.
virtual	~MuonLayerHashProviderTool ()=default
StatusCode	initialize () override
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	sysInitialize () override
	Perform system initialization for an algorithm.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	access to tool interface

Static Public Attributes
static constexpr unsigned	techMax = MuonStationIndex::toInt(TechnologyIndex::TechnologyIndexMax)

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
void	insertTechnology (const MuonIdHelper &idHelper)
	insert hashes of a given technology
void	insertTgcs () const
	insert hashes for the tgcs
void	insertHash (const IdentifierHash &hash, const Identifier &id) const
	insert a single hash for a given identifier
void	insertHash (int sector, const IdentifierHash &hash, const Identifier &id) const
	insert a single hash for a given identifier and sector
bool	initializeSectorMapping ()
	initialize the mapping structure
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
RegionHashesPerSectorVec m_regionHashesPerSector	ATLAS_THREAD_SAFE {}
	cachaed hash data structure
std::atomic< bool > m_hashLoaded	ATLAS_THREAD_SAFE {false}
std::mutex	m_tgcHash {}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_detMgrKey
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 22 of file MuonLayerHashProviderTool.h.

Member Typedef Documentation

◆ HashVec

using Muon::MuonLayerHashProviderTool::HashVec = std::vector<IdentifierHash>

define data structure

sector
- technology
  - hashes

Definition at line 29 of file MuonLayerHashProviderTool.h.

◆ RegionHashesPerSectorVec

using Muon::MuonLayerHashProviderTool::RegionHashesPerSectorVec = std::array<RegionHashesPerSector, MuonStationIndex::numberOfSectors()>

Definition at line 40 of file MuonLayerHashProviderTool.h.

◆ RegionHashVec

using Muon::MuonLayerHashProviderTool::RegionHashVec = std::array<HashVec, MuonStationIndex::sectorLayerHashMax()>

Definition at line 31 of file MuonLayerHashProviderTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ TechnologyIndex

using Muon::MuonLayerHashProviderTool::TechnologyIndex = MuonStationIndex::TechnologyIndex

Definition at line 32 of file MuonLayerHashProviderTool.h.

◆ TechnologyRegionHashVec

using Muon::MuonLayerHashProviderTool::TechnologyRegionHashVec = std::array< RegionHashVec, techMax>

Definition at line 34 of file MuonLayerHashProviderTool.h.

Constructor & Destructor Documentation

◆ MuonLayerHashProviderTool()

Muon::MuonLayerHashProviderTool::MuonLayerHashProviderTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Default AlgTool functions.

Definition at line 15 of file MuonLayerHashProviderTool.cxx.

                                                                                                                            :
    AthAlgTool(type,name,parent) {
    declareInterface<MuonLayerHashProviderTool>(this);
 
  }

◆ ~MuonLayerHashProviderTool()

virtual Muon::MuonLayerHashProviderTool::~MuonLayerHashProviderTool ( )

virtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ getHashes()

const std::vector< IdentifierHash > & Muon::MuonLayerHashProviderTool::getHashes	(	int	sector,
		TechnologyIndex	technologyIndex,
		unsigned int	sectorLayerHash ) const

inline

access hashes for a given sector, technology and layer hash

Definition at line 88 of file MuonLayerHashProviderTool.h.

                                                                                                                       {
    if (!m_hashLoaded){
      insertTgcs();
    }
    using namespace MuonStationIndex;
    return m_regionHashesPerSector[sector-1].technologyRegionHashVecs[toInt(technologyIndex)][sectorLayerHash];
  }

◆ initialize()

StatusCode Muon::MuonLayerHashProviderTool::initialize ( )

override

Definition at line 21 of file MuonLayerHashProviderTool.cxx.

                                                   {
 
    ATH_CHECK(m_idHelperSvc.retrieve());
    ATH_CHECK(m_detMgrKey.initialize());
 
    if( !initializeSectorMapping() ){
      ATH_MSG_ERROR("Failed to initialize sector mapping");
      return StatusCode::FAILURE;
    }
 
    return StatusCode::SUCCESS;
  }

◆ initializeSectorMapping()

bool Muon::MuonLayerHashProviderTool::initializeSectorMapping ( )

private

initialize the mapping structure

Definition at line 103 of file MuonLayerHashProviderTool.cxx.

                                                          {
    // set sector numbers
    for( unsigned int i=0;i<m_regionHashesPerSector.size();++i ) {
      m_regionHashesPerSector[i].sector=i+1;      
    }
    ATH_MSG_DEBUG("Initializing hashes: number of sectors " << numberOfSectors() 
                 << " sectorLayers " << sectorLayerHashMax() );
 
    // add technologies
    if (m_idHelperSvc->hasMDT()) insertTechnology(m_idHelperSvc->mdtIdHelper());
    if (m_idHelperSvc->hasRPC()) insertTechnology(m_idHelperSvc->rpcIdHelper());
    if (m_idHelperSvc->hasCSC()) insertTechnology(m_idHelperSvc->cscIdHelper());
    if (m_idHelperSvc->hasMM()) insertTechnology(m_idHelperSvc->mmIdHelper());
    if (m_idHelperSvc->hasSTGC()) insertTechnology(m_idHelperSvc->stgcIdHelper());
    return true;
  }

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

◆ insertHash() [1/2]

void Muon::MuonLayerHashProviderTool::insertHash	(	const IdentifierHash &	hash,
		const Identifier &	id ) const

private

insert a single hash for a given identifier

Definition at line 35 of file MuonLayerHashProviderTool.cxx.

                                                                                                    {
    insertHash(m_idHelperSvc->sector(id),hash,id);
  }

◆ insertHash() [2/2]

void Muon::MuonLayerHashProviderTool::insertHash	(	int	sector,
		const IdentifierHash &	hash,
		const Identifier &	id ) const

private

insert a single hash for a given identifier and sector

Definition at line 39 of file MuonLayerHashProviderTool.cxx.

                                                                                                                 {
    const int techIndex = toInt(m_idHelperSvc->technologyIndex(id));
    const int layHash = sectorLayerHash(m_idHelperSvc->regionIndex(id),m_idHelperSvc->layerIndex(id));
    m_regionHashesPerSector[sector-1].technologyRegionHashVecs[techIndex][layHash].push_back(hash);
  }

◆ insertTechnology()

void Muon::MuonLayerHashProviderTool::insertTechnology ( const MuonIdHelper & idHelper )

private

insert hashes of a given technology

Definition at line 45 of file MuonLayerHashProviderTool.cxx.

                                                                                {
 
    // loop over all available STGC collection identifiers and order them per sector
    MuonIdHelper::const_id_iterator it = idHelper.module_begin();
    MuonIdHelper::const_id_iterator it_end = idHelper.module_end();
    for( ;it!=it_end; ++it ){
      IdentifierHash hash;
      idHelper.get_module_hash(*it,hash);
      insertHash(hash,*it);
    }
 
  }

◆ insertTgcs()

void Muon::MuonLayerHashProviderTool::insertTgcs ( ) const

private

insert hashes for the tgcs

Definition at line 58 of file MuonLayerHashProviderTool.cxx.

                                                   {
    std::lock_guard guard{m_tgcHash};
    if (m_hashLoaded) return;
    // the tgc's can be in multiple sectors so we need to do something special here
    SG::ReadCondHandle detMgr{m_detMgrKey};
  
    MuonSectorMapping sectorMapping;
 
    // loop over all available TGC collection identifiers and order them per sector
    MuonIdHelper::const_id_iterator it = m_idHelperSvc->tgcIdHelper().module_begin();
    MuonIdHelper::const_id_iterator it_end = m_idHelperSvc->tgcIdHelper().module_end();
    for( ;it!=it_end; ++it ){
      const MuonGM::TgcReadoutElement* detEl = detMgr->getTgcReadoutElement(*it);
      if( !detEl ) {
        ATH_MSG_DEBUG(" No detector element found for " << m_idHelperSvc->toString(*it) );
        continue;
      }
      const IdentifierHash hash = m_idHelperSvc->moduleHash(*it);
      int nstrips = detEl->nStrips(1);
      Amg::Vector3D p1 = detEl->channelPos(1,1,1);
      Amg::Vector3D p2 = detEl->channelPos(1,1,nstrips);
      std::vector<int> sectors1;
      sectorMapping.getSectors(p1.phi(),sectors1);
      std::set<int> added;
      std::vector<int>::iterator sit = sectors1.begin();
      std::vector<int>::iterator sit_end = sectors1.end();
      for( ;sit!=sit_end; ++sit ){
        insertHash(*sit,hash,*it);
        added.insert(*sit);
      }
 
      std::vector<int> sectors2;
      sectorMapping.getSectors(p2.phi(),sectors2);
      sit = sectors2.begin();
      sit_end = sectors2.end();
      for( ;sit!=sit_end; ++sit ){
        if( added.count(*sit) ) continue;
        added.insert(*sit);
        insertHash(*sit,hash,*it);
      }
    }
    m_hashLoaded = true;
  }

◆ interfaceID()

const InterfaceID & Muon::MuonLayerHashProviderTool::interfaceID ( )

inlinestatic

access to tool interface

Definition at line 51 of file MuonLayerHashProviderTool.h.

                                            { 
      static const InterfaceID IID_MuonLayerHashProviderTool("Muon::MuonLayerHashProviderTool",1,0);
      return IID_MuonLayerHashProviderTool; 
    }

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

RegionHashesPerSectorVec m_regionHashesPerSector Muon::MuonLayerHashProviderTool::ATLAS_THREAD_SAFE {}

mutableprivate

cachaed hash data structure

Definition at line 75 of file MuonLayerHashProviderTool.h.

75{};

◆ ATLAS_THREAD_SAFE [2/2]

std::atomic<bool> m_hashLoaded Muon::MuonLayerHashProviderTool::ATLAS_THREAD_SAFE {false}

mutableprivate

Definition at line 76 of file MuonLayerHashProviderTool.h.

76{false};

◆ m_detMgrKey

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

private

Initial value:

{this, "DetMgr", "MuonDetectorManager",

"MuonManager ReadKey for IOV Range intersection"}

Definition at line 81 of file MuonLayerHashProviderTool.h.

81 {this, "DetMgr", "MuonDetectorManager",

82 "MuonManager ReadKey for IOV Range intersection"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_idHelperSvc

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

private

Definition at line 79 of file MuonLayerHashProviderTool.h.

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

◆ m_tgcHash

std::mutex Muon::MuonLayerHashProviderTool::m_tgcHash {}

mutableprivate

Definition at line 77 of file MuonLayerHashProviderTool.h.

77{};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ techMax

unsigned Muon::MuonLayerHashProviderTool::techMax = MuonStationIndex::toInt(TechnologyIndex::TechnologyIndexMax)

staticconstexpr

Definition at line 33 of file MuonLayerHashProviderTool.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HashVec

◆ RegionHashesPerSectorVec

◆ RegionHashVec

◆ StoreGateSvc_t

◆ TechnologyIndex

◆ TechnologyRegionHashVec

Constructor & Destructor Documentation

◆ MuonLayerHashProviderTool()

◆ ~MuonLayerHashProviderTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getHashes()

◆ initialize()

◆ initializeSectorMapping()

◆ inputHandles()

◆ insertHash() [1/2]

◆ insertHash() [2/2]

◆ insertTechnology()

◆ insertTgcs()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE [1/2]

◆ ATLAS_THREAD_SAFE [2/2]

◆ m_detMgrKey

◆ m_detStore

◆ m_evtStore

◆ m_idHelperSvc

◆ m_tgcHash

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ techMax