CaloTriggerTowerService Class Reference

Tool providing the mapping of the online and offline TriggerTower identifiers as well as the TT-cells mapping. More...

#include <CaloTriggerTowerService.h>

Inheritance diagram for CaloTriggerTowerService:

Collaboration diagram for CaloTriggerTowerService:

Public Member Functions
	CaloTriggerTowerService (const std::string &type, const std::string &name, const IInterface *parent)
	constructor More...
StatusCode	initialize ()
StatusCode	finalize ()
bool	is_initialized () const
virtual StatusCode	iovCallBack (IOVSVC_CALLBACK_ARGS)
HWIdentifier	createTTChannelID (const Identifier &id, bool bQuiet=false) const
	create a TT HWIdentifier from a TT Identifier More...
Identifier	cnvToIdentifier (const HWIdentifier &id, bool bQuiet=false) const
	create a TT Identifier from a TT HWIdentifier More...
L1CaloCoolChannelId	createL1CoolChannelId (const HWIdentifier &id) const
	create a CoolChannelId (used by TDAQ framework) from a HWIdentifier More...
HWIdentifier	cnvCoolChannelIdToHWID (const L1CaloCoolChannelId &coolChannelId) const
	create an HWIdentifier from an TDAQ CoolChannelId More...
L1CaloCoolChannelId	cnvRxIdToCoolChannelId (const L1CaloRxCoolChannelId &rxCoolChannelId) const
	returns a TDAQ CoolChannelId corresponding to a L1CaloRxCoolChannelId More...
std::vector< L1CaloRxCoolChannelId >	cnvCoolChannelIdToRxId (const L1CaloCoolChannelId &ppmCoolChannelId) const
	returns a vector of L1CaloRxCoolChannelId corresponding to a L1CaloCoolChannelId More...
unsigned int	pos_neg (const HWIdentifier &id) const
	return 0 for z<0 channels and 1 for z>0 channels More...
unsigned int	em_had (const HWIdentifier &id) const
	return the corresponding sampling of channelId: More...
unsigned int	barrel_endcap_fcal (const HWIdentifier &id) const
	To know if a channel belongs to the barrel, end cap or fcal parts. More...
unsigned int	module_type (const HWIdentifier &id) const
	To get the type of the module connected to the channel: More...
std::vector< Identifier >	createCellIDvecTT (const Identifier &id) const
	Return a vector of offline Identifiers (corresponding helpers = LArEM_ID, LArHEC_ID, LArFCAL_ID) for a TT offline id (helper=CaloLVL1_ID) -> all layers together (Rem: equivalent to above extTt=0) The call is formarded to the DB object LArTTCellMap. More...
std::vector< Identifier >	createCellIDvecLayer (const Identifier &id) const
	Return a vector of offline Identifiers (corresponding helpers = LArEM_ID, LArHEC_ID, LArFCAL_ID) for a TT-layer offline id (helper=CaloLVL1_ID) -> one single layer (Rem: equivalent to above extTt!=0) The call is formarded to the DB object LArTTCellMap. More...
Identifier	whichTTID (const Identifier &id) const
	return the offline id (CaloLVL1_ID) of the TT to which a cell id (CaloCell_ID) belongs The call is formarded to the DB object LArTTCellMap More...
bool	is_in_lvl1 (const Identifier &id) const
	return true if the cell is in the lvl1 sums; some channels mapped to TT are only in HLT (last HEC compartment and last cells of barrel PS) More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
const LArTTCellMap *	getTTCellMap () const
const CaloTTOnOffIdMap *	getCaloTTOnOffIdMap () const
const CaloTTOnAttrIdMap *	getCaloTTOnAttrIdMap () const
const CaloTTPpmRxIdMap *	getCaloTTPpmRxIdMap () const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
const LArOnlineID *	m_onlineHelper
	pointer to the LAr Online Id helper More...
const LArEM_ID *	m_emHelper
	pointer to the LArEM offline Id helper More...
const CaloLVL1_ID *	m_lvl1Helper
	pointer to the Calo TT offline Id helper More...
const TTOnlineID *	m_ttonlineHelper
	pointer to the Calo TT online Id helper More...
CxxUtils::CachedPointer< const LArTTCellMap >	m_TTCellMap
CxxUtils::CachedPointer< const CaloTTOnOffIdMap >	m_caloTTOnOffIdMap
CxxUtils::CachedPointer< const CaloTTOnAttrIdMap >	m_caloTTOnAttrIdMap
CxxUtils::CachedPointer< const CaloTTPpmRxIdMap >	m_caloTTPpmRxIdMap
std::string	m_TTCellMapKey
std::string	m_caloTTOnOffIdMapKey
std::string	m_caloTTOnAttrIdMapKey
std::string	m_caloTTPpmRxIdMapKey
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool providing the mapping of the online and offline TriggerTower identifiers as well as the TT-cells mapping.

Author

Arnaud Lucotte, Fabienne Ledroit

maintained by Damien Prieur

Definition at line 49 of file CaloTriggerTowerService.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

CaloTriggerTowerService()

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

constructor

Definition at line 22 of file CaloTriggerTowerService.cxx.

  : AthAlgTool(type,name,parent),
    m_onlineHelper(nullptr) ,
    m_emHelper(nullptr) ,
    m_lvl1Helper(nullptr) ,
    m_ttonlineHelper(nullptr)
{
 
  // Declare additional interface
  declareInterface<CaloTriggerTowerService>(this);
 
  declareProperty("LArTTCellMapKey",m_TTCellMapKey="LArTTCellMapAtlas");
  declareProperty("CaloTTOnOffIdMapKey",m_caloTTOnOffIdMapKey="CaloTTOnOffIdMapAtlas");
  declareProperty("CaloTTOnAttrIdMapKey",m_caloTTOnAttrIdMapKey="CaloTTOnAttrIdMapAtlas");
  declareProperty("CaloTTPpmRxIdMapKey",m_caloTTPpmRxIdMapKey="CaloTTPpmRxIdMapAtlas");
 
}

Member Function Documentation

barrel_endcap_fcal()

unsigned int CaloTriggerTowerService::barrel_endcap_fcal

(

const HWIdentifier &

id

)

const

To know if a channel belongs to the barrel, end cap or fcal parts.

Returns

0: barrel

1: end cap

2: fcal

999: error

Definition at line 231 of file CaloTriggerTowerService.cxx.

                                                                                      {
 
  const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = getCaloTTOnAttrIdMap();
  if(!caloTTOnAttrIdMap) {
     msg() << MSG::ERROR << " No TTOnAttrIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the TTOnAttrIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return (0);
    } else {
        unsigned int barrel_endcap_fcal = caloTTOnAttrIdMap->barrel_endcap_fcal(id);
        return barrel_endcap_fcal;
    }
}

cnvCoolChannelIdToHWID()

HWIdentifier CaloTriggerTowerService::cnvCoolChannelIdToHWID

(

const L1CaloCoolChannelId &

coolChannelId

)

const

create an HWIdentifier from an TDAQ CoolChannelId

Definition at line 318 of file CaloTriggerTowerService.cxx.

                                                                                                             {
 
    unsigned int       crate = coolChannelId.crate();
    unsigned int      module = coolChannelId.module(false); // get the physical module position
    unsigned int   submodule = coolChannelId.subModule();
    unsigned int     channel = coolChannelId.channel();
 
    // create Athena Online Id - the physical module position is expected here (not the logical)
    HWIdentifier channelId = m_ttonlineHelper->channelId(crate,module,submodule,channel);
 
    return channelId;
}

cnvCoolChannelIdToRxId()

std::vector< L1CaloRxCoolChannelId > CaloTriggerTowerService::cnvCoolChannelIdToRxId

(

const L1CaloCoolChannelId &

ppmCoolChannelId

)

const

returns a vector of L1CaloRxCoolChannelId corresponding to a L1CaloCoolChannelId

Definition at line 208 of file CaloTriggerTowerService.cxx.

                                                                                                                                  {
 
   const CaloTTPpmRxIdMap* caloTTPpmRxIdMap = getCaloTTPpmRxIdMap();
   if(!caloTTPpmRxIdMap ) {
     msg() << MSG::ERROR << " No CaloTTPpmRxIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the CaloTTPpmRxIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return std::vector<L1CaloRxCoolChannelId>();
 
   } else {
     // mapping object exist, forward the call
     std::vector<L1CaloRxCoolChannelId> rxChannels = caloTTPpmRxIdMap->ppmToRxId(ppmCoolChannelId);
     if(rxChannels.empty()) {
         CaloID_Exception except;
         except.code(6) ;
         except.message(" Ppm channel ID not found in map ") ;
         throw except ;
       }
     return rxChannels;
   }
}

cnvRxIdToCoolChannelId()

L1CaloCoolChannelId CaloTriggerTowerService::cnvRxIdToCoolChannelId

(

const L1CaloRxCoolChannelId &

rxCoolChannelId

)

const

returns a TDAQ CoolChannelId corresponding to a L1CaloRxCoolChannelId

Definition at line 184 of file CaloTriggerTowerService.cxx.

                                                                                                                      {
 
   L1CaloCoolChannelId invalidId;
 
   const CaloTTPpmRxIdMap* caloTTPpmRxIdMap = getCaloTTPpmRxIdMap();
   if(!caloTTPpmRxIdMap ) {
     msg() << MSG::ERROR << " No CaloTTPpmRxIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the CaloTTPpmRxIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return invalidId;
 
   } else {
     // mapping object exist, forward the call
     L1CaloCoolChannelId ppmId = caloTTPpmRxIdMap->rxToPpmId(rxCoolChannelId);
     if(ppmId==L1CaloCoolChannelId()) {
         CaloID_Exception except;
         except.code(6) ;
         except.message(" Rx channel ID not found in map ") ;
         throw except ;
       }
     return ppmId;
   }
}

cnvToIdentifier()

Identifier CaloTriggerTowerService::cnvToIdentifier	(	const HWIdentifier &	id,
		bool	bQuiet = false
	)		const

create a TT Identifier from a TT HWIdentifier

Definition at line 155 of file CaloTriggerTowerService.cxx.

{
    Identifier invalidId (0);
 
        const CaloTTOnOffIdMap* caloTTOnOffIdMap = getCaloTTOnOffIdMap();
    if(!caloTTOnOffIdMap ) {
        msg() << MSG::ERROR << " No CaloTTOnOffIdMap !" << endmsg;
        msg() << MSG::ERROR << " Has the DB folder holding the CaloTTOnOffIdMap been added to IOVDbSvc ? " << endmsg;
        msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
        return invalidId;
 
    } else {
        // mapping object exist, forward the call
                Identifier offid = caloTTOnOffIdMap->cnvToIdentifier(id, bQuiet);
        if(bQuiet) {
            return offid;
 
        } else {
            if(!offid.is_valid()) {
                CaloID_Exception except;
                except.code(6) ;
                except.message(" Online ID not found in map ") ;
                throw except ;
            }
            return offid;
        }
    }
}

createCellIDvecLayer()

std::vector< Identifier > CaloTriggerTowerService::createCellIDvecLayer

(

const Identifier &

id

)

const

Return a vector of offline Identifiers (corresponding helpers = LArEM_ID, LArHEC_ID, LArFCAL_ID) for a TT-layer offline id (helper=CaloLVL1_ID) -> one single layer (Rem: equivalent to above extTt!=0)
The call is formarded to the DB object LArTTCellMap.

Definition at line 370 of file CaloTriggerTowerService.cxx.

{
  std::vector<Identifier> vec ;
  const LArTTCellMap* TTCellMap = getTTCellMap();
 
  if(m_emHelper->dictionaryVersion() == "fullAtlas" ||
     m_emHelper->dictionaryVersion() == "H8TestBeam") {
    if(!TTCellMap) {
      msg() << MSG::ERROR << " No TTCellMap  !" << endmsg;
      return vec;
    }
    vec = TTCellMap->createCellIDvec(id);
  }
 
  return vec;
}

createCellIDvecTT()

std::vector< Identifier > CaloTriggerTowerService::createCellIDvecTT

(

const Identifier &

id

)

const

Return a vector of offline Identifiers (corresponding helpers = LArEM_ID, LArHEC_ID, LArFCAL_ID) for a TT offline id (helper=CaloLVL1_ID) -> all layers together (Rem: equivalent to above extTt=0)
The call is formarded to the DB object LArTTCellMap.

Definition at line 334 of file CaloTriggerTowerService.cxx.

{
  std::vector<Identifier> vec ;
 
  if(m_emHelper->dictionaryVersion() == "fullAtlas" ||
     m_emHelper->dictionaryVersion() == "H8TestBeam") {
 
    const LArTTCellMap* TTCellMap = getTTCellMap();
    if(!TTCellMap) {
      msg() << MSG::ERROR << " No TTCellMap  !" << endmsg;
      return vec;
    }
 
    Identifier ttId=m_lvl1Helper->tower_id(id);
    Identifier regId=m_lvl1Helper->region_id(id);
    int maxLay=m_lvl1Helper->layer_max(regId);
 
    for(int iLay=0;iLay<=maxLay;++iLay) {
      // Rem: not all iLay correspond to physically existing layers
      Identifier layId = m_lvl1Helper->layer_id(ttId,iLay);
      std::vector<Identifier> vecp = TTCellMap->createCellIDvec(layId);
      std::vector<Identifier>::const_iterator it  = vecp.begin();
      std::vector<Identifier>::const_iterator it_e  = vecp.end();
      for (; it!=it_e; ++it)      {
    vec.push_back(*it);
      }
    }
 
  }
 
  return vec;
}

createL1CoolChannelId()

L1CaloCoolChannelId CaloTriggerTowerService::createL1CoolChannelId

(

const HWIdentifier &

id

)

const

create a CoolChannelId (used by TDAQ framework) from a HWIdentifier

Definition at line 292 of file CaloTriggerTowerService.cxx.

                                                                                                  {
 
    const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = getCaloTTOnAttrIdMap();
    if(caloTTOnAttrIdMap) {
 
        unsigned int crate       = m_ttonlineHelper->crate(id);
        unsigned int module      = m_ttonlineHelper->module(id); // this returns the physical slot position !
        unsigned int submodule   = m_ttonlineHelper->submodule(id);
        unsigned int channel     = m_ttonlineHelper->channel(id);
 
        unsigned int module_type = caloTTOnAttrIdMap->module_type(id);
 
        // since the module argument is the physical position and not the logical one, the logical flag is set to false
        return L1CaloCoolChannelId(crate, L1CaloModuleType( (L1CaloModuleType::L1CaloModuleEnum) module_type), module, submodule, channel, false);
 
    } else {
 
        msg() << MSG::ERROR << " No CaloTTOnAttrIdMap !" << endmsg;
        msg() << MSG::ERROR << " Has the DB folder holding the CaloTTOnAttrIdMap been added to IOVDbSvc ? " << endmsg;
        msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
        return 0;
    }
}

createTTChannelID()

HWIdentifier CaloTriggerTowerService::createTTChannelID	(	const Identifier &	id,
		bool	bQuiet = false
	)		const

create a TT HWIdentifier from a TT Identifier

Definition at line 122 of file CaloTriggerTowerService.cxx.

{
 
    HWIdentifier invalidId (0);
 
        const CaloTTOnOffIdMap* caloTTOnOffIdMap = getCaloTTOnOffIdMap();
    if(!caloTTOnOffIdMap ) {// no mapping object
        msg() << MSG::ERROR << " No CaloTTOnOffIdMap !" << endmsg;
        msg() << MSG::ERROR << " Has the DB folder holding the CaloTTOnOffIdMap been added to IOVDbSvc ? " << endmsg;
        msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
        return invalidId;
 
    } else {
 
        // have mapping object, forward the call
                HWIdentifier sid = caloTTOnOffIdMap->createSignalChannelID( id ) ;
        if(bQuiet) {
            return sid;
 
        } else {
            if(sid == invalidId) {
                CaloID_Exception except;
                except.code(5) ;
                except.message("HWIdentifier not found in map ") ;
                throw except ;
            }
            return sid;
        }
    }
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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; }

em_had()

unsigned int CaloTriggerTowerService::em_had

(

const HWIdentifier &

id

)

const

return the corresponding sampling of channelId:

Returns

0: for EM calorimeter

1: for HAD calorimeter

999: error

Definition at line 246 of file CaloTriggerTowerService.cxx.

                                                                          {
 
    const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = getCaloTTOnAttrIdMap();
    if(!caloTTOnAttrIdMap) {
     msg() << MSG::ERROR << " No TTOnAttrIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the TTOnAttrIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return (0);
    } else {
        unsigned int em_had = caloTTOnAttrIdMap->em_had(id);
        return em_had;
    }
}

evtStore() [1/2]

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; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 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()

StatusCode CaloTriggerTowerService::finalize

(

)

Definition at line 108 of file CaloTriggerTowerService.cxx.

{
  msg()<<MSG::INFO<<" => CaloTriggerTowerService::finalize() "<< endmsg;
  return StatusCode::SUCCESS;
}

getCaloTTOnAttrIdMap()

const CaloTTOnAttrIdMap * CaloTriggerTowerService::getCaloTTOnAttrIdMap ( ) const

private

Definition at line 489 of file CaloTriggerTowerService.cxx.

{
  if (!m_caloTTOnAttrIdMap.get()) {
    const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = nullptr;
    if (detStore()->retrieve (caloTTOnAttrIdMap, m_caloTTOnAttrIdMapKey).isSuccess()) {
      m_caloTTOnAttrIdMap.set (caloTTOnAttrIdMap);
    }
  }
  return m_caloTTOnAttrIdMap.get();
}

getCaloTTOnOffIdMap()

const CaloTTOnOffIdMap * CaloTriggerTowerService::getCaloTTOnOffIdMap ( ) const

private

Definition at line 477 of file CaloTriggerTowerService.cxx.

{
  if (!m_caloTTOnOffIdMap.get()) {
    const CaloTTOnOffIdMap* caloTTOnOffIdMap = nullptr;
    if (detStore()->retrieve (caloTTOnOffIdMap, m_caloTTOnOffIdMapKey).isSuccess()) {
      m_caloTTOnOffIdMap.set (caloTTOnOffIdMap);
    }
  }
  return m_caloTTOnOffIdMap.get();
}

getCaloTTPpmRxIdMap()

const CaloTTPpmRxIdMap * CaloTriggerTowerService::getCaloTTPpmRxIdMap ( ) const

private

Definition at line 501 of file CaloTriggerTowerService.cxx.

{
  if (!m_caloTTPpmRxIdMap.get()) {
    const CaloTTPpmRxIdMap* caloTTPpmRxIdMap = nullptr;
    if (detStore()->retrieve (caloTTPpmRxIdMap, m_caloTTPpmRxIdMapKey).isSuccess()) {
      m_caloTTPpmRxIdMap.set (caloTTPpmRxIdMap);
    }
  }
  return m_caloTTPpmRxIdMap.get();
}

getTTCellMap()

const LArTTCellMap * CaloTriggerTowerService::getTTCellMap ( ) const

private

Definition at line 465 of file CaloTriggerTowerService.cxx.

{
  if (!m_TTCellMap.get()) {
    const LArTTCellMap* TTCellMap = nullptr;
    if (detStore()->retrieve (TTCellMap, m_TTCellMapKey).isSuccess()) {
      m_TTCellMap.set (TTCellMap);
    }
  }
  return m_TTCellMap.get();
}

initialize()

StatusCode CaloTriggerTowerService::initialize

(

)

Definition at line 44 of file CaloTriggerTowerService.cxx.

{
 
  msg().setLevel(msgLevel());
 
  msg()<<MSG::INFO<<" => CaloTriggerTowerService::initialize() "<< endmsg;
 
  const CaloIdManager*  caloMgr;
  StatusCode status = detStore()->retrieve(caloMgr);
  if (status.isFailure()) {
    msg() << MSG::ERROR << "Unable to retrieve CaloIdManager from DetectorStore" << endmsg;
    return StatusCode::FAILURE;
  } else {
    msg() << MSG::DEBUG << "Successfully retrieved CaloIdManager from DetectorStore" << endmsg;
  }
  m_emHelper = caloMgr->getEM_ID();
  if (!m_emHelper) {
    msg() << MSG::ERROR << "Could not access LArEM_ID helper" << endmsg;
    return StatusCode::FAILURE;
  } else {
    msg() << MSG::DEBUG << "Successfully accessed LArEM_ID helper" << endmsg;
  }
  m_lvl1Helper = caloMgr->getLVL1_ID();
  if (!m_lvl1Helper) {
    msg() << MSG::ERROR << "Could not access CaloLVL1_ID helper" << endmsg;
    return StatusCode::FAILURE;
  } else {
    msg() << MSG::DEBUG << "Successfully accessed CaloLVL1_ID helper" << endmsg;
  }
  m_ttonlineHelper = caloMgr->getTTOnlineID();
  if (!m_ttonlineHelper) {
    msg() << MSG::ERROR << "Could not access TTOnlineID helper" << endmsg;
    return StatusCode::FAILURE;
  } else {
    msg() << MSG::DEBUG << "Successfully accessed CaloLVL1_ID helper" << endmsg;
  }
 
  status = detStore()->retrieve(m_onlineHelper, "LArOnlineID");
  if (status.isFailure()) {
    msg() << MSG::ERROR << "Could not access LArOnlineID helper" << endmsg;
    return StatusCode::FAILURE;
  } else {
    msg() << MSG::DEBUG << "Successfully accessed LArOnlineID helper" << endmsg;
  }
 
  // Make sure the dictionaries for the LArTTCellMap persistent classes
  // are available.  We used to read this object via a conditions callback,
  // but callbacks are not thread-friendly, so this was changed to retrieving
  // it from detStore during event processing.  However, this meant that
  // the TClass's for the persistent objects were also being loaded
  // at that time.  As of root 6.22.00, at least, TClass can sometimes
  // fail to properly load a dictionary when it's being run in a multithreaded
  // context.  So force the needed dictionaries to load now.
  TClass::GetClass ("LArTTCell_P");
  TClass::GetClass ("LArTTCell_P::LArTTCell_P_t");
  TClass::GetClass ("std::vector<LArTTCell_P::LArTTCell_P_t>");
 
  msg()<<MSG::INFO<<" ====> ...CaloTriggerTowerService::init() OK "<< endmsg;
  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()

static const InterfaceID& CaloTriggerTowerService::interfaceID ( )

inlinestatic

Retrieve interface ID.

Definition at line 53 of file CaloTriggerTowerService.h.

{ return IID_CaloTriggerTowerService; }

iovCallBack()

StatusCode CaloTriggerTowerService::iovCallBack ( IOVSVC_CALLBACK_ARGS  )

virtual

Definition at line 456 of file CaloTriggerTowerService.cxx.

                                                                    {
 
  msg()<<MSG::INFO<<" ====> iovCallBack " << endmsg;
 
  return StatusCode::SUCCESS;
 
}

is_in_lvl1()

bool CaloTriggerTowerService::is_in_lvl1

(

const Identifier &

id

)

const

return true if the cell is in the lvl1 sums;
some channels mapped to TT are only in HLT (last HEC compartment and last cells of barrel PS)

Definition at line 416 of file CaloTriggerTowerService.cxx.

{
 
  bool lvl1 = true ;
 
  if(m_emHelper->dictionaryVersion() == "fullAtlas" ||
    m_emHelper->dictionaryVersion() == "H8TestBeam") {
 
    if(m_emHelper->is_em_barrel(id)) {
      int samp=m_emHelper->sampling(id);
      if(samp==0) {
        int eta=m_emHelper->eta(id);
        if(eta==60) {
          lvl1 = false ;
        }
      }
    } else {
      Identifier ttId=whichTTID(id);
      if(m_lvl1Helper->is_hec(ttId)) {
        int layer = m_lvl1Helper->layer(ttId);
        if(layer == 3){
          lvl1 = false ;
        }
      }
    }
  } else {
    lvl1 = false ;
  }
 
  return lvl1;
 
}

is_initialized()

bool CaloTriggerTowerService::is_initialized

(

)

const

Definition at line 115 of file CaloTriggerTowerService.cxx.

{
  return getTTCellMap() != nullptr && getCaloTTOnOffIdMap() != nullptr && getCaloTTOnAttrIdMap() != nullptr;
}

module_type()

unsigned int CaloTriggerTowerService::module_type

(

const HWIdentifier &

id

)

const

To get the type of the module connected to the channel:

Returns

1: PPM

2: CPM

3: JEM

999: error

Definition at line 275 of file CaloTriggerTowerService.cxx.

                                                                               {
 
 
    const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = getCaloTTOnAttrIdMap();
    if(!caloTTOnAttrIdMap) {
     msg() << MSG::ERROR << " No TTOnAttrIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the TTOnAttrIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return (0);
    } else {
        unsigned int module_type = caloTTOnAttrIdMap->module_type(id);
        return module_type;
    }
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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.

pos_neg()

unsigned int CaloTriggerTowerService::pos_neg

(

const HWIdentifier &

id

)

const

return 0 for z<0 channels and 1 for z>0 channels

Definition at line 261 of file CaloTriggerTowerService.cxx.

                                                                           {
 
    const CaloTTOnAttrIdMap* caloTTOnAttrIdMap = getCaloTTOnAttrIdMap();
    if(!caloTTOnAttrIdMap) {
     msg() << MSG::ERROR << " No TTOnAttrIdMap !" << endmsg;
     msg() << MSG::ERROR << " Has the DB folder holding the TTOnAttrIdMap been added to IOVDbSvc ? " << endmsg;
     msg() << MSG::ERROR << " IOVDbSvc.Folders+=[ FolderName + DBConnection + \"<tag>\"+TagSpec+\"</tag>\" ] " << endmsg;
     return (0);
    } else {
        unsigned int pos_neg = caloTTOnAttrIdMap->pos_neg(id);
        return pos_neg;
    }
}

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

whichTTID()

Identifier CaloTriggerTowerService::whichTTID

(

const Identifier &

id

)

const

return the offline id (CaloLVL1_ID) of the TT to which a cell id (CaloCell_ID) belongs
The call is formarded to the DB object LArTTCellMap

Definition at line 389 of file CaloTriggerTowerService.cxx.

{
  Identifier sid(0);
 
  if(m_emHelper->dictionaryVersion() == "fullAtlas" ||
     m_emHelper->dictionaryVersion() == "H8TestBeam") {
 
    const LArTTCellMap* TTCellMap = getTTCellMap();
    if(!TTCellMap) {
      msg() << MSG::ERROR << " No TTCellMap  !" << endmsg;
      return sid;
    }
    sid = TTCellMap->whichTTID( id ) ;
    Identifier invalidId (0);
    if(sid == invalidId ){
      LArID_Exception except;
      except.message("Identifier not found in map ") ;
      throw except ;
    }
  }
 
  return sid;
}

Member Data Documentation

m_caloTTOnAttrIdMap

CxxUtils::CachedPointer<const CaloTTOnAttrIdMap> CaloTriggerTowerService::m_caloTTOnAttrIdMap

private

Definition at line 193 of file CaloTriggerTowerService.h.

m_caloTTOnAttrIdMapKey

std::string CaloTriggerTowerService::m_caloTTOnAttrIdMapKey

private

Definition at line 198 of file CaloTriggerTowerService.h.

m_caloTTOnOffIdMap

CxxUtils::CachedPointer<const CaloTTOnOffIdMap> CaloTriggerTowerService::m_caloTTOnOffIdMap

private

Definition at line 192 of file CaloTriggerTowerService.h.

m_caloTTOnOffIdMapKey

std::string CaloTriggerTowerService::m_caloTTOnOffIdMapKey

private

Definition at line 197 of file CaloTriggerTowerService.h.

m_caloTTPpmRxIdMap

CxxUtils::CachedPointer<const CaloTTPpmRxIdMap> CaloTriggerTowerService::m_caloTTPpmRxIdMap

private

Definition at line 194 of file CaloTriggerTowerService.h.

m_caloTTPpmRxIdMapKey

std::string CaloTriggerTowerService::m_caloTTPpmRxIdMapKey

private

Definition at line 199 of file CaloTriggerTowerService.h.

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_emHelper

const LArEM_ID* CaloTriggerTowerService::m_emHelper

private

pointer to the LArEM offline Id helper

Definition at line 185 of file CaloTriggerTowerService.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_lvl1Helper

const CaloLVL1_ID* CaloTriggerTowerService::m_lvl1Helper

private

pointer to the Calo TT offline Id helper

Definition at line 187 of file CaloTriggerTowerService.h.

m_onlineHelper

const LArOnlineID* CaloTriggerTowerService::m_onlineHelper

private

pointer to the LAr Online Id helper

Definition at line 183 of file CaloTriggerTowerService.h.

m_TTCellMap

CxxUtils::CachedPointer<const LArTTCellMap> CaloTriggerTowerService::m_TTCellMap

private

Definition at line 191 of file CaloTriggerTowerService.h.

m_TTCellMapKey

std::string CaloTriggerTowerService::m_TTCellMapKey

private

Definition at line 196 of file CaloTriggerTowerService.h.

m_ttonlineHelper

const TTOnlineID* CaloTriggerTowerService::m_ttonlineHelper

private

pointer to the Calo TT online Id helper

Definition at line 189 of file CaloTriggerTowerService.h.

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:

• CaloTriggerTowerService.h
• CaloTriggerTowerService.cxx