TileCal RoI map to offline Identifier. More...

#include <TileRoI_Map.h>

Inheritance diagram for TileRoI_Map:

Classes
class	EtaPhiRegion

Public Types
typedef Identifier	TT_ID
typedef int	COLL_ID

Public Member Functions
	TileRoI_Map (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
StatusCode	initialize ()
	define a RoI identifier type, two ints.
virtual	~TileRoI_Map ()
TT_ID	TrigTowerID (const Identifier &id) const
	return TrigTowerID for various queries.
TT_ID	TrigTowerID (const HWIdentifier &id) const
const std::vector< COLL_ID > &	CollectionID (const TT_ID &id) const
	reserve lookup.
bool	validId (const TT_ID &tt_id) const
	check validity
bool	getEtaPhiRegion (unsigned int hashid, float &etamin, float &etamax, float &phimin, float &phimax) const
	returns Eta-Phi Region for a hashed ID of the Collection.
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 ()
	AlgTool 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 std::map< Identifier, TT_ID >	OFFMAP
	Map for offline ID and online id.
typedef std::map< HWIdentifier, TT_ID >	ONLMAP
typedef std::vector< COLL_ID >	COLL_ID_VEC
typedef std::map< TT_ID, COLL_ID_VEC >	ROIMAP
typedef std::map< int, EtaPhiRegion >	E_P_MAP
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	addEntry (const HWIdentifier &adc_hwid)
void	printEtaPhiRegions ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
OFFMAP	m_offmap
ONLMAP	m_onlmap
ROIMAP	m_roimap
E_P_MAP	m_epmap
const TileID *	m_tileID {nullptr}
const TileHWID *	m_tileHWID {nullptr}
const TileDetDescrManager *	m_tileMgr {nullptr}
const TileCablingService *	m_cablingSvc {nullptr}
TileFragHash	m_idhash
Gaudi::Property< bool >	m_print {this, "Print", false}
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

TileCal RoI map to offline Identifier.

Author: Alexandre Solodkov

Version: 00-00-01 , 26/08/2002

Definition at line 32 of file TileRoI_Map.h.

Member Typedef Documentation

◆ COLL_ID

typedef int TileRoI_Map::COLL_ID

Definition at line 47 of file TileRoI_Map.h.

◆ COLL_ID_VEC

typedef std::vector<COLL_ID> TileRoI_Map::COLL_ID_VEC

private

Definition at line 113 of file TileRoI_Map.h.

◆ E_P_MAP

typedef std::map<int, EtaPhiRegion > TileRoI_Map::E_P_MAP

private

Definition at line 116 of file TileRoI_Map.h.

◆ OFFMAP

typedef std::map<Identifier, TT_ID> TileRoI_Map::OFFMAP

private

Map for offline ID and online id.

Definition at line 111 of file TileRoI_Map.h.

◆ ONLMAP

typedef std::map<HWIdentifier, TT_ID> TileRoI_Map::ONLMAP

private

Definition at line 112 of file TileRoI_Map.h.

◆ ROIMAP

typedef std::map<TT_ID, COLL_ID_VEC > TileRoI_Map::ROIMAP

private

Definition at line 114 of file TileRoI_Map.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ TT_ID

typedef Identifier TileRoI_Map::TT_ID

Definition at line 46 of file TileRoI_Map.h.

Constructor & Destructor Documentation

◆ TileRoI_Map()

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

constructor

Definition at line 24 of file TileRoI_Map.cxx.

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

◆ ~TileRoI_Map()

TileRoI_Map::~TileRoI_Map ( )

virtual

Definition at line 62 of file TileRoI_Map.cxx.

63{

64}

Member Function Documentation

◆ addEntry()

bool TileRoI_Map::addEntry ( const HWIdentifier & adc_hwid )

private

Definition at line 67 of file TileRoI_Map.cxx.

{
 
  Identifier adc_id  = m_cablingSvc->h2s_adc_id(adc_hwid);
 
  if (adc_id.is_valid()) {
 
    Identifier pmt_id  = m_tileID->pmt_id(adc_id);
    Identifier cell_id = m_tileID->cell_id(adc_id);
 
    Identifier rId = m_cablingSvc->pmt2tt_id(pmt_id);
 
    m_offmap[ cell_id ] = rId; // mapping for Cell id
    m_offmap[ pmt_id  ] = rId; // mapping for PMT id
    m_offmap[ adc_id  ] = rId; // mapping for ADC id
 
    HWIdentifier chan_id = m_tileHWID->channel_id(adc_hwid);
    m_onlmap[ chan_id  ] = rId; // mapping for online channel id
    m_onlmap[ adc_hwid ] = rId; // mapping for online ADC id
 
    std::cout 
      << " HW id " << m_tileHWID->to_string(adc_hwid)
      << " id " << m_tileID->to_string(adc_id)
      << " tt id " << rId // don't know how to print TT ID
      << std::endl;
 
    // add entry for RoI to COLL_ID map. 
    // make an Tile frag ID
    int frag = m_tileHWID->frag(chan_id);
    COLL_ID_VEC& v = m_roimap[rId];
    COLL_ID_VEC::const_iterator it = v.begin(); 
    COLL_ID_VEC::const_iterator it_end = v.end(); 
    bool found = false;
 
    const CaloDetDescrElement* caloDDE = m_tileMgr->get_cell_element(cell_id);
    m_epmap[frag].set(caloDDE->eta(),caloDDE->phi()); 
 
    for(; it != it_end; ++it)
      if(frag == (*it) )   found = true; 
    if(!found) {
//  std::cout <<" Mapped RoI "<<rId.sample()<<" "<<rId.eta()<<" "
//        <<rId.phi()<<" to frag "<<std::hex<<frag<<std::dec<<std::endl;
      v.push_back(frag);  
    }
  } else 
  {
    std::cout <<" Failed to get Identifier in TileRoI_Map::add "<< std::endl;
    return false;
  }
 
  return true;
 
} 

◆ CollectionID()

const TileRoI_Map::COLL_ID_VEC & TileRoI_Map::CollectionID ( const TT_ID & id ) const

reserve lookup.

given RoI, get CollectionID

Definition at line 157 of file TileRoI_Map.cxx.

{
   ROIMAP::const_iterator it = m_roimap.find(RoIid); 
   if(it !=m_roimap.end()) {
    return (*it).second; 
   }
   std::cout <<" TileRoI_Map::CollectionID: can not find RoI" << std::endl;
   static const COLL_ID_VEC v ;
   return v; 
}

◆ 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

◆ getEtaPhiRegion()

bool TileRoI_Map::getEtaPhiRegion	(	unsigned int	hashid,
		float &	etamin,
		float &	etamax,
		float &	phimin,
		float &	phimax ) const

returns Eta-Phi Region for a hashed ID of the Collection.

return false for invalid ID.

Definition at line 208 of file TileRoI_Map.cxx.

{
  if( (int)hashid >= m_idhash.max() ) return false; 
 
  int frag = m_idhash.identifier(hashid); 
  E_P_MAP::const_iterator it = m_epmap.find(frag); 
  if(it == m_epmap.end()) return false; 
 
  etamin = (*it).second.etamin; 
  etamax = (*it).second.etamax; 
  phimin = (*it).second.phimin; 
  phimax = (*it).second.phimax; 
 
  return true; 
 
}

◆ initialize()

StatusCode TileRoI_Map::initialize ( )

define a RoI identifier type, two ints.

iterator over all ADC Identifiers

Definition at line 31 of file TileRoI_Map.cxx.

{ 
  ATH_CHECK( detStore()->retrieve(m_tileMgr) );
  ATH_CHECK( detStore()->retrieve(m_tileID, "TileID") );
  ATH_CHECK( detStore()->retrieve(m_tileHWID, "TileHWID") );
 
  // get the pointer to CablingSvc
  m_cablingSvc = TileCablingService::getInstance();
 
  m_idhash.initialize(m_tileHWID); 
 
  // intialize the internal map
  std::vector<HWIdentifier>::const_iterator first = m_tileHWID->adc_begin();
  std::vector<HWIdentifier>::const_iterator  last = m_tileHWID->adc_end();
 
  int nADC = 0;
  for ( ; first!=last; ++first) {
    if ( addEntry(*first) ) ++nADC;
  }
 
  if (m_print) {
    std::cout << " number of ADCs made in TileRoI_Map " << nADC<< std::endl; 
  }
  
  if(m_print) printEtaPhiRegions(); 
 
  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 & TileRoI_Map::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 20 of file TileRoI_Map.cxx.

21{ return IID_ITileRoI_Map; }

IID_ITileRoI_Map

static const InterfaceID IID_ITileRoI_Map("TileRoI_Map", 1, 0)

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

◆ printEtaPhiRegions()

void TileRoI_Map::printEtaPhiRegions ( )

private

Definition at line 176 of file TileRoI_Map.cxx.

{
  // print all Collection ID and eta phi region
 
  E_P_MAP::const_iterator it = m_epmap.begin(); 
  E_P_MAP::const_iterator it_end = m_epmap.end(); 
 
  std::cout <<" COLLECTION ID , HASHID,  ETAMIN,  ETAMAX, PHIMIN, PHIMAX  "<<std::endl ;
 
  TileHWID tileHW;
 
  for(; it!=it_end;++it){
        int frag = (*it).first;
        int hashid = m_idhash(frag); 
 
        float e1,e2,p1,p2 ;
 
        // check getEtaPhiRegion method. 
        getEtaPhiRegion(hashid,e1,e2,p1,p2); 
 
        // print them out.
        std::cout <<std::hex<< frag 
             << "  " <<hashid <<  "  "
             <<e1 << "  " 
             <<e2 << "  "
             <<p1 << "  "
             <<p2 << std::endl; 
  }
        std::cout << std::dec << std::endl;
 
}

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

◆ TrigTowerID() [1/2]

TileRoI_Map::TT_ID TileRoI_Map::TrigTowerID ( const HWIdentifier & id ) const

Definition at line 141 of file TileRoI_Map.cxx.

{
  ONLMAP::const_iterator it = m_onlmap.find( id ); 
  if(it==m_onlmap.end() ) 
  {
     std::string err(" TileRoI_Map::TrigTowerID(const HWIdentifier&):  no entry for HWID "); 
     err += m_tileHWID->to_string(id,-1) ; 
     TileID_Exception except(err,2); 
     throw except; 
  }
 
  return (*it).second; 
 
}

◆ TrigTowerID() [2/2]

TileRoI_Map::TT_ID TileRoI_Map::TrigTowerID ( const Identifier & id ) const

return TrigTowerID for various queries.

Definition at line 123 of file TileRoI_Map.cxx.

{
  OFFMAP::const_iterator it = m_offmap.find(id); 
  if( it==m_offmap.end() ) 
  {
     std::string err(" TileRoI_Map:  not entry for ID ");
     err += m_tileID->to_string(id,-1) ; 
     TileID_Exception except(err,1); 
     throw except; 
  }
 
  return (*it).second; 
 
}

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

◆ validId()

bool TileRoI_Map::validId ( const TT_ID & tt_id ) const

check validity

Definition at line 169 of file TileRoI_Map.cxx.

{
   ROIMAP::const_iterator it = m_roimap.find(RoIid); 
   return it !=m_roimap.end() ; 
}

Member Data Documentation

◆ m_cablingSvc

const TileCablingService* TileRoI_Map::m_cablingSvc {nullptr}

private

Definition at line 127 of file TileRoI_Map.h.

127{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_epmap

E_P_MAP TileRoI_Map::m_epmap

private

Definition at line 122 of file TileRoI_Map.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_idhash

TileFragHash TileRoI_Map::m_idhash

private

Definition at line 129 of file TileRoI_Map.h.

◆ m_offmap

OFFMAP TileRoI_Map::m_offmap

private

Definition at line 118 of file TileRoI_Map.h.

◆ m_onlmap

ONLMAP TileRoI_Map::m_onlmap

private

Definition at line 119 of file TileRoI_Map.h.

◆ m_print

Gaudi::Property<bool> TileRoI_Map::m_print {this, "Print", false}

private

Definition at line 130 of file TileRoI_Map.h.

130{this, "Print", false};

◆ m_roimap

ROIMAP TileRoI_Map::m_roimap

private

Definition at line 120 of file TileRoI_Map.h.

◆ m_tileHWID

const TileHWID* TileRoI_Map::m_tileHWID {nullptr}

private

Definition at line 125 of file TileRoI_Map.h.

125{nullptr};

◆ m_tileID

const TileID* TileRoI_Map::m_tileID {nullptr}

private

Definition at line 124 of file TileRoI_Map.h.

124{nullptr};

◆ m_tileMgr

const TileDetDescrManager* TileRoI_Map::m_tileMgr {nullptr}

private

Definition at line 126 of file TileRoI_Map.h.

126{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:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ COLL_ID

◆ COLL_ID_VEC

◆ E_P_MAP

◆ OFFMAP

◆ ONLMAP

◆ ROIMAP

◆ StoreGateSvc_t

◆ TT_ID

Constructor & Destructor Documentation

◆ TileRoI_Map()

◆ ~TileRoI_Map()

Member Function Documentation

◆ addEntry()

◆ CollectionID()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getEtaPhiRegion()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ printEtaPhiRegions()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ TrigTowerID() [1/2]

◆ TrigTowerID() [2/2]

◆ updateVHKA()

◆ validId()

Member Data Documentation

◆ m_cablingSvc

◆ m_detStore

◆ m_epmap

◆ m_evtStore

◆ m_idhash

◆ m_offmap

◆ m_onlmap

◆ m_print

◆ m_roimap

◆ m_tileHWID

◆ m_tileID

◆ m_tileMgr

◆ m_varHandleArraysDeclared

◆ m_vhka