LArHVMapTool Class Reference

#include <LArHVMapTool.h>

Inheritance diagram for LArHVMapTool:

Collaboration diagram for LArHVMapTool:

Public Member Functions
	LArHVMapTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~LArHVMapTool ()=default
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual void	GetHVLines (const Identifier &id, const CaloDetDescrManager *cddm, std::vector< int > &hvLineVec) const override final
virtual void	GetHVLines (const Identifier &id, const CaloDetDescrManager *cddm, std::vector< HWIdentifier > &hvLineId) const override final
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 ()

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	GetHVLinesCore (const Identifier &id, const CaloDetDescrManager *cddm, std::vector< int > *hvLineVec, std::vector< HWIdentifier > *hvLineId) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const CaloIdManager *	m_caloIdMgr {nullptr}
const LArEM_ID *	m_larem_id {nullptr}
const LArHEC_ID *	m_larhec_id {nullptr}
const LArFCAL_ID *	m_larfcal_id {nullptr}
const LArHVIdMapping *	m_hvmapping {nullptr}
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
SG::ReadCondHandleKey< LArHVIdMapping >	m_hvCablingKey {this, "LArHVIdMapping", "LArHVIdMap", "SG key for HV ID mapping"}
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 17 of file LArHVMapTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArHVMapTool()

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

Definition at line 22 of file LArHVMapTool.cxx.

  : AthAlgTool(type,name,parent)
{
}

~LArHVMapTool()

virtual LArHVMapTool::~LArHVMapTool ( )

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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

finalize()

virtual StatusCode LArHVMapTool::finalize ( )

inlineoverridevirtual

Definition at line 26 of file LArHVMapTool.h.

{return StatusCode::SUCCESS;}

GetHVLines() [1/2]

void LArHVMapTool::GetHVLines ( const Identifier & id, const CaloDetDescrManager * cddm, std::vector< HWIdentifier > & hvLineId ) const

finaloverridevirtual

Implements ILArHVMapTool.

Definition at line 67 of file LArHVMapTool.cxx.

                                                                       {
   return GetHVLinesCore(id, calodetdescrmgr, nullptr, &hvLineId);
}

GetHVLines() [2/2]

void LArHVMapTool::GetHVLines ( const Identifier & id, const CaloDetDescrManager * cddm, std::vector< int > & hvLineVec ) const

finaloverridevirtual

Implements ILArHVMapTool.

Definition at line 62 of file LArHVMapTool.cxx.

                                                               {
   return GetHVLinesCore(id, calodetdescrmgr, &hvLineVec, nullptr);
}

GetHVLinesCore()

void LArHVMapTool::GetHVLinesCore ( const Identifier & id, const CaloDetDescrManager * cddm, std::vector< int > * hvLineVec, std::vector< HWIdentifier > * hvLineId ) const

private

Definition at line 72 of file LArHVMapTool.cxx.

                                                                                                  {
  std::set<int> hv;
  std::set<HWIdentifier> hvId;
  if(hvLineVec) hvLineVec->clear();
  if(hvLineId) hvLineId->clear();
 
  // LAr EMB
  if (m_larem_id->is_lar_em(id) && m_larem_id->sampling(id)>0) {
    if (abs(m_larem_id->barrel_ec(id))==1) {
       const EMBDetectorElement* embElement = dynamic_cast<const EMBDetectorElement*>(calodetdescrmgr->get_element(id));
       if (embElement) {
          const EMBCellConstLink &cell = embElement->getEMBCell();
          unsigned int nelec = cell->getNumElectrodes();
          for (unsigned int i=0;i<nelec;i++) {
             const EMBHVElectrode &electrode = cell->getElectrode(i);
             for (unsigned int igap=0;igap<2;igap++) {
                HWIdentifier hvline;
                hv.insert(electrode.getModule().getManager().hvLineNo(electrode,igap, m_hvmapping, &hvline));
                hvId.insert(hvline);
             }
          }
       } else {
          ATH_MSG_ERROR( "Failed d'cast to EMBDetectorElement" );
       }
    } else { // LAr EMEC
      const EMECDetectorElement* emecElement = dynamic_cast<const EMECDetectorElement*>(calodetdescrmgr->get_element(id));
      if (emecElement) {
         const EMECCellConstLink cell = emecElement->getEMECCell();
         unsigned int nelec = cell->getNumElectrodes();
         for (unsigned int i=0;i<nelec;i++) {
            const EMECHVElectrode &electrode = cell->getElectrode(i);
            for (unsigned int igap=0;igap<2;igap++) {
               HWIdentifier hvline;
               hv.insert(electrode.getModule().getManager().hvLineNo( electrode, igap, m_hvmapping, &hvline));
               hvId.insert(hvline);
            }
         }
      } else {
        ATH_MSG_ERROR( "Failed d'cast to EMECDetectorElement" );
      }
    }
  } else if (m_larhec_id->is_lar_hec(id)) { // LAr HEC
    const HECDetectorElement* hecElement = dynamic_cast<const HECDetectorElement*>(calodetdescrmgr->get_element(id));
    if (hecElement) {
      const HECCellConstLink cell = hecElement->getHECCell();
      unsigned int nsubgaps = cell->getNumSubgaps();
      for (unsigned int igap=0;igap<nsubgaps;igap++) {
        const HECHVSubgap &subgap = cell->getSubgap(igap);
        HWIdentifier hvline;
        hv.insert(subgap.getModule().getManager().hvLineNo(subgap,m_hvmapping,&hvline));
        hvId.insert(hvline);
      }
    } else {
      ATH_MSG_ERROR( "Failed d'cast to HECDetectorElement" );
    }
  } else if (m_larfcal_id->is_lar_fcal(id)) { // LAr FCAL
    const FCALDetectorElement* fcalElement = dynamic_cast<const FCALDetectorElement*>(calodetdescrmgr->get_element(id));
    if (fcalElement) {
      const FCALTile* tile = fcalElement->getFCALTile();
      unsigned int nlines = tile->getNumHVLines();
      unsigned int nlines_found=0;
      for (unsigned int i=0;i<nlines;i++) {
          const FCALHVLine *line = tile->getHVLine(i);
          if (line) nlines_found++;
      }
      if ( nlines_found>0 ) {
         for (unsigned int i=0;i<nlines;i++) {
            const FCALHVLine *line = tile->getHVLine(i);
            if (!line) continue;
            HWIdentifier hvline;
            hv.insert(line->getModule().getManager().hvLineNo(*line,m_hvmapping,&hvline));
            hvId.insert(hvline);
         }
      }
    } else {
      ATH_MSG_ERROR( "Failed d'cast to FCALDetectorElement" );
    }
 
  } else if (m_larem_id->is_lar_em(id) && m_larem_id->sampling(id)==0) { // Presamplers
    if (abs(m_larem_id->barrel_ec(id))==1) {
      const EMBDetectorElement* embElement = dynamic_cast<const EMBDetectorElement*>(calodetdescrmgr->get_element(id));
      if (embElement) {
         const EMBCellConstLink cell = embElement->getEMBCell();
         const EMBPresamplerHVModule &hvmodule = cell->getPresamplerHVModule();
         for (unsigned int igap=0;igap<2;igap++) {
            HWIdentifier hvline;
            hv.insert(hvmodule.getManager().hvLineNo(hvmodule,igap,m_hvmapping,&hvline));
            hvId.insert(hvline);
         }
      } else {
         ATH_MSG_ERROR( "Failed d'cast to EMBDetectorElement (for presampler)" );
      }
    } else {
      const EMECDetectorElement* emecElement = dynamic_cast<const EMECDetectorElement*>(calodetdescrmgr->get_element(id));
      if (emecElement) {
         const EMECCellConstLink cell = emecElement->getEMECCell();
         const EMECPresamplerHVModule &hvmodule = cell->getPresamplerHVModule ();
         HWIdentifier hvline;
         hv.insert(hvmodule.getManager().hvLineNo(hvmodule, m_hvmapping, &hvline));
         hvId.insert(hvline);
      } else {
         ATH_MSG_ERROR( "Failed d'cast to EMECDetectorElement (for presampler)" );
      }
    }
  }
 
  ATH_MSG_VERBOSE("Found "<<hvId.size()<<" hvIds for id: "<<id.get_identifier32().get_compact());
 
  if(hvLineVec) {
     for (std::set<int>::iterator i=hv.begin();i!=hv.end();++i) hvLineVec->push_back(*i);
  }
  if(hvLineId) {
     for (std::set<HWIdentifier>::iterator i=hvId.begin();i!=hvId.end();++i) hvLineId->push_back(*i);
  }
  return;
}

initialize()

StatusCode LArHVMapTool::initialize ( )

overridevirtual

Definition at line 27 of file LArHVMapTool.cxx.

                                   {
 
  CHECK(detStore()->retrieve(m_caloIdMgr));
 
  m_larem_id   = m_caloIdMgr->getEM_ID();
  m_larhec_id   = m_caloIdMgr->getHEC_ID();
  m_larfcal_id   = m_caloIdMgr->getFCAL_ID();
 
  ATH_CHECK(m_caloDetDescrMgrKey.initialize());
  ATH_CHECK( m_hvCablingKey.initialize() );
 
  ATH_MSG_DEBUG("LArHVMapTool::initialize ...");
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloDetDescrMgrKey,ctx};
  const CaloDetDescrManager *calodetdescrmgr = *caloMgrHandle;
  SG::ReadCondHandle<LArHVIdMapping> hvCabling (m_hvCablingKey, ctx);
  m_hvmapping=*hvCabling;
  if(!m_hvmapping) {
     ATH_MSG_ERROR("Could not get HV mapping !");
     return StatusCode::FAILURE;
  } else {
     ATH_MSG_DEBUG("Got HV mapping !");
  }
 
  IdentifierHash h=0;
  Identifier offId;
  m_larem_id->get_id(h,offId);
  std::vector<int> hvlineVec;
  GetHVLines(offId, calodetdescrmgr, hvlineVec);
 
  return StatusCode::SUCCESS;
}

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.

interfaceID()

const InterfaceID & ILArHVMapTool::interfaceID ( )

inlinestaticinherited

Definition at line 36 of file ILArHVMapTool.h.

{ 
   return IID_ILArHVMapTool; 
}

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

m_caloDetDescrMgrKey

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

private

Definition at line 45 of file LArHVMapTool.h.

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

m_caloIdMgr

const CaloIdManager* LArHVMapTool::m_caloIdMgr {nullptr}

private

Definition at line 38 of file LArHVMapTool.h.

{nullptr};

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_hvCablingKey

SG::ReadCondHandleKey<LArHVIdMapping> LArHVMapTool::m_hvCablingKey {this, "LArHVIdMapping", "LArHVIdMap", "SG key for HV ID mapping"}

private

Definition at line 47 of file LArHVMapTool.h.

{this, "LArHVIdMapping", "LArHVIdMap", "SG key for HV ID mapping"};

m_hvmapping

const LArHVIdMapping* LArHVMapTool::m_hvmapping {nullptr}

private

Definition at line 43 of file LArHVMapTool.h.

{nullptr};

m_larem_id

const LArEM_ID* LArHVMapTool::m_larem_id {nullptr}

private

Definition at line 39 of file LArHVMapTool.h.

{nullptr};

m_larfcal_id

const LArFCAL_ID* LArHVMapTool::m_larfcal_id {nullptr}

private

Definition at line 41 of file LArHVMapTool.h.

{nullptr};

m_larhec_id

const LArHEC_ID* LArHVMapTool::m_larhec_id {nullptr}

private

Definition at line 40 of file LArHVMapTool.h.

{nullptr};

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.

---

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

• LArHVMapTool.h
• LArHVMapTool.cxx