#include <CaloCellsHandlerTool.h>

Inheritance diagram for CaloCellsHandlerTool:

Collaboration diagram for CaloCellsHandlerTool:

Public Member Functions
	CaloCellsHandlerTool (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~CaloCellsHandlerTool ()

StatusCode	initialize ()

StatusCode	getGepCellMap (const CaloCellContainer &cells, pGepCellMap &, const EventContext &ctx) const

StatusCode	setNumberOfEnergyBits (int value)

StatusCode	setLeastSignificantBit (int value)

StatusCode	setG (int value)

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

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
int	getGepEnergy (float offline_et) const

std::vector< unsigned int >	getNeighbours (const CaloCellContainer &allcells, const CaloCell *acell, const EventContext &) const

StatusCode	removeCellsFromOverloadedFEB (std::vector< Gep::GepCaloCell > &cells) 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
int	m_nEnergyBits = -1
	Key of the CaloNoise Conditions data object. More...

int	m_valLeastSigBit = -1

int	m_valG = -1

int	m_readoutRanges [5] = {-1,-1,-1,-1,-1}

int	m_stepsPerRange = -1

unsigned	m_maxCellsPerFEB = -1

std::map< unsigned int, Gep::GepCaloCell >	m_gepCellsBase = {}

Gaudi::Property< std::string >	m_GepEnergyEncodingScheme {this, "GEPEnergyEncodingScheme", "", "String defining the GEP readout scheme according to number of readout bits + '-' + value of LSB in MeV + '-' + gain value"}

Gaudi::Property< bool >	m_doGepHardwareStyleEnergyEncoding {this, "HardwareStyleEnergyEncoding", false, "Enabling or disabling the hardware-style energy encoding for the GEP"}

Gaudi::Property< bool >	m_doTruncationOfOverflowingFEBs {this, "TruncationOfOverflowingFEBs", false, "Enabling or disabling the truncation of cells from FEBs with more than the maximum number of cells which can be send"}

Gaudi::Property< std::string >	m_LArCellMap {this, "LArCellMapFile", "UpgradePerformanceFunctions/LAr_Cell_Map_offlineID_0.csv", "File associating LAr cells with readout FEBs and connection technology"}

SG::ReadCondHandleKey< CaloNoise >	m_electronicNoiseKey

SG::ReadCondHandleKey< CaloNoise >	m_totalNoiseKey

const CaloCell_ID *	m_CaloCell_ID {nullptr}

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

Definition at line 26 of file CaloCellsHandlerTool.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

◆ CaloCellsHandlerTool()

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

Definition at line 11 of file CaloCellsHandlerTool.cxx.

13 : AthAlgTool(type, name, parent){

14 }

◆ ~CaloCellsHandlerTool()

CaloCellsHandlerTool::~CaloCellsHandlerTool ( )

virtual

Definition at line 16 of file CaloCellsHandlerTool.cxx.

16 {}

Member Function Documentation

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

95 { return m_detStore; }

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

85 { 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.

90 { 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

◆ getGepCellMap()

StatusCode CaloCellsHandlerTool::getGepCellMap	(	const CaloCellContainer &	cells,
		pGepCellMap &	gepCellsMap,
		const EventContext &	ctx
	)		const

Definition at line 117 of file CaloCellsHandlerTool.cxx.

                                                           {
  
   // PS this function creates and returns a map which has Gep::GepCaloCells as its values
   // The cells are made up of data which is invariant for all events, and dynamic
   // data which varies with event.
   // The invariant data should be setup in initialize(), and the dynamic
   // data should be updated here in a way which is compatible with the const-ness of this
   // function.
   // This will be attended to in the future.
  
   SG::ReadCondHandle<CaloNoise> electronicNoiseHdl{m_electronicNoiseKey,  ctx};
   if (!electronicNoiseHdl.isValid()) {return StatusCode::FAILURE;}
   const CaloNoise* electronicNoiseCDO = *electronicNoiseHdl;
  
   SG::ReadCondHandle<CaloNoise> totalNoiseHdl{m_totalNoiseKey, ctx};
   if (!totalNoiseHdl.isValid()) {return StatusCode::FAILURE;}
   const CaloNoise* totalNoiseCDO = *totalNoiseHdl;
  
   int idx = -1;
   std::map<std::string,std::vector<Gep::GepCaloCell>> gepCellsPerFEB;
  
   for(const auto *cell: cells){
  
     Gep::GepCaloCell caloCell; 
     ++idx;
  
     caloCell.id = (cell->ID().get_identifier32()).get_compact();
     auto base_cell_itr = m_gepCellsBase.find(caloCell.id);
     if (base_cell_itr != m_gepCellsBase.end()) caloCell = base_cell_itr->second;
     else {
     // Tile cells are not included in the cell base map
     // In the future this might change, for now just setting FEB value to a dummy
     caloCell.FEB = "Tile";
     }
  
     float electronicNoise = electronicNoiseCDO->getNoise(cell->ID(), cell->gain());
     float totalNoise = totalNoiseCDO->getNoise(cell->ID(), cell->gain());
    
     // Only send positive-energy 2sigma cells to the GEP
     if ((cell->energy() / totalNoise) < 2.0) continue;
  
     // GEP will only have ET available for LAr cells, so convert to energy from ET
     if (m_doGepHardwareStyleEnergyEncoding && !m_CaloCell_ID->is_tile(cell->ID())) {
     caloCell.et = getGepEnergy(cell->energy() / TMath::CosH(cell->eta()));
     caloCell.e  = caloCell.et * TMath::CosH(cell->eta());
     }
     else {
     caloCell.e  = cell->energy();
     caloCell.et = caloCell.e / TMath::CosH(cell->eta());
     }
     caloCell.time       = cell->time();
     caloCell.quality    = cell->quality();
     caloCell.provenance = cell->provenance();    
           
     caloCell.totalNoise = totalNoise;
     caloCell.electronicNoise = electronicNoise;
     caloCell.sigma = cell->energy() / totalNoise;
  
     caloCell.isBad = cell->badcell();    
     caloCell.eta    = cell->eta();
     caloCell.phi    = cell->phi();
     caloCell.sinTh  = cell->sinTh();
     caloCell.cosTh  = cell->cosTh();
     caloCell.sinPhi = cell->sinPhi();
     caloCell.cosPhi = cell->cosPhi();
     caloCell.cotTh  = cell->cotTh();
     caloCell.x = cell->x();
     caloCell.y = cell->y();
     caloCell.z = cell->z();
     
     unsigned int samplingEnum = m_CaloCell_ID->calo_sample(cell->ID());
     
     bool IsEM = m_CaloCell_ID->is_em(cell->ID());
     bool IsEM_Barrel=false;
     bool IsEM_EndCap=false;
     bool IsEM_BarrelPos=false;
     bool IsEM_BarrelNeg=false;
     if(IsEM){
       IsEM_Barrel=m_CaloCell_ID->is_em_barrel(cell->ID());
       if(IsEM_Barrel){
     if(m_CaloCell_ID->pos_neg(cell->ID())>0) IsEM_BarrelPos=true;
       }
       IsEM_EndCap=m_CaloCell_ID->is_em_endcap(cell->ID());
     }
     
     caloCell.isEM           = IsEM;
     caloCell.isEM_barrel    = IsEM_Barrel;
     caloCell.isEM_endCap    = IsEM_EndCap;
     caloCell.isEM_barrelPos = IsEM_BarrelPos;
     caloCell.isEM_barrelNeg = IsEM_BarrelNeg;  //always false?
     caloCell.isFCAL = m_CaloCell_ID->is_fcal(cell->ID());
     caloCell.isHEC  = m_CaloCell_ID->is_hec(cell->ID());
     caloCell.isTile = m_CaloCell_ID->is_tile(cell->ID());
     
     caloCell.sampling = samplingEnum;
     caloCell.detName = CaloSampling::getSamplingName(samplingEnum);
     
     caloCell.neighbours = getNeighbours(cells, cell, ctx);
     caloCell.id = (cell->ID().get_identifier32()).get_compact(); 
     
     const CaloDetDescriptor *elt = cell->caloDDE()->descriptor();
     caloCell.layer = cell->caloDDE()->getLayer();
     
     float deta = elt->deta();
     float dphi = elt->dphi();
     
     float etamin = caloCell.eta - (0.5*deta);
     float etamax = caloCell.eta + (0.5*deta);
     
     float phimin = caloCell.phi - (0.5*dphi);
     float phimax = caloCell.phi + (0.5*dphi);
     
     caloCell.etaMin = etamin;
     caloCell.etaMax = etamax;
     caloCell.phiMin = phimin;
     caloCell.phiMax = phimax;
     caloCell.etaGranularity = deta;
     caloCell.phiGranularity = dphi;
  
     caloCell.index = idx;
   
     // Fill cells into map according to FEB  
     auto feb_itr = gepCellsPerFEB.find(caloCell.FEB);
     if (feb_itr != gepCellsPerFEB.end()) feb_itr->second.push_back(caloCell);
     else {
     std::vector<Gep::GepCaloCell> cellsThisFEB;
     cellsThisFEB.push_back(caloCell);
     gepCellsPerFEB.insert(std::pair<std::string,std::vector<Gep::GepCaloCell>>(caloCell.FEB,cellsThisFEB));
     }
   }
  
   // store cells map
   auto itr = gepCellsPerFEB.begin();
   for ( ;itr != gepCellsPerFEB.end(); ++itr) {
  
     // LAr FEBs might overflow, so they will get truncated
     if (m_doTruncationOfOverflowingFEBs && itr->second.size() > m_maxCellsPerFEB && itr->first != "Tile") {
         ATH_MSG_DEBUG("FEB " << itr->first << " is sending " << itr->second.size() << " cells, which is more cells than GEP can receive. Removing all but the possible " << m_maxCellsPerFEB << " cells.");
         CHECK(removeCellsFromOverloadedFEB(itr->second));
     }
     for (const Gep::GepCaloCell& cell : itr->second)
         gepCellsMap->insert(std::pair<unsigned int, Gep::GepCaloCell>(cell.id, cell)); 
   }
   ATH_MSG_DEBUG("GEP is receiving a total of " << gepCellsMap->size() << " cells in this event");
  
   return StatusCode::SUCCESS;
 }

◆ getGepEnergy()

int CaloCellsHandlerTool::getGepEnergy ( float offline_et ) const

private

Definition at line 269 of file CaloCellsHandlerTool.cxx.

                                                              {
  
   // If cell saturates readout range, largest possible value is send
   if (offline_et > m_readoutRanges[4]) return m_readoutRanges[4];
  
   int readoutRange = 0;
   for (int i = 1; i <= 3; ++i) {
         if (offline_et > m_readoutRanges[i]) readoutRange = i;
   }
  
   float step = ((float) m_readoutRanges[readoutRange+1] - (float) m_readoutRanges[readoutRange]) / (m_stepsPerRange-1);
   int gep_energy = -1;
   for (int i = 0; i < m_stepsPerRange; ++i) {
         if (offline_et < (m_readoutRanges[readoutRange]+(step*i))) break;
         gep_energy = m_readoutRanges[readoutRange]+(step*i);
   }
  
   return gep_energy;
 }

◆ getNeighbours()

std::vector< unsigned int > CaloCellsHandlerTool::getNeighbours	(	const CaloCellContainer &	allcells,
		const CaloCell *	acell,
		const EventContext &
	)		const

private

Definition at line 293 of file CaloCellsHandlerTool.cxx.

                                                {
  
   // get all neighboring cells
   std::vector<IdentifierHash> cellNeighbours;
  
   IdentifierHash cellHashID = m_CaloCell_ID->calo_cell_hash(acell->ID());
   m_CaloCell_ID->get_neighbours(cellHashID,LArNeighbours::super3D,cellNeighbours);
  
   std::vector<unsigned int> neighbour_ids;
   for (unsigned int iNeighbour = 0;
        iNeighbour < cellNeighbours.size();
        ++iNeighbour) {
     
     const CaloCell* neighbour = allcells.findCell(cellNeighbours[iNeighbour]);
     if (neighbour) {
       neighbour_ids.push_back((neighbour->ID().get_identifier32()).get_compact());
     } else {
       ATH_MSG_ERROR("Couldn't access neighbour #" << iNeighbour
             << " for cell ID "
             << (acell->ID().get_identifier32()).get_compact());
     }
   }
   return neighbour_ids;
 }

◆ initialize()

StatusCode CaloCellsHandlerTool::initialize ( )

Definition at line 19 of file CaloCellsHandlerTool.cxx.

                                             {
  
   ATH_CHECK(m_electronicNoiseKey.initialize());
   ATH_CHECK(m_totalNoiseKey.initialize());
   
   // CaloIndentifier
   CHECK( detStore()->retrieve (m_CaloCell_ID, "CaloCell_ID") );
  
   ATH_MSG_INFO("Hardware-style energy encoding for GEP cells has been set to " << m_doGepHardwareStyleEnergyEncoding.value());
   if (!m_doGepHardwareStyleEnergyEncoding) ATH_MSG_WARNING("Hardware-style energy encoding for GEP cells has been disabled. Cell energies will have larger precision than realistically possible");
  
   ATH_MSG_INFO("Truncation of Gep cells from FEBs which are overflowing has been set to " << m_doTruncationOfOverflowingFEBs.value());
   if (!m_doTruncationOfOverflowingFEBs) ATH_MSG_WARNING("Truncation of GEP cells from overflowing FEBs has been disabled. More GEP cells will be send to algorithms than realistically possible");
  
   // Setting up GEP energy encoding scheme
   if (m_doGepHardwareStyleEnergyEncoding) {
  
     // Read values of Gep readout scheme from argument
     int GepScheme[3];
     for (int i = 0; i < 3; ++i) {
         GepScheme[i] = std::stoi(m_GepEnergyEncodingScheme.value().substr(0,m_GepEnergyEncodingScheme.value().find("-")));
         m_GepEnergyEncodingScheme.value().erase(0, m_GepEnergyEncodingScheme.value().find("-")+1);
     }
  
     CHECK(setNumberOfEnergyBits(GepScheme[0]));
     CHECK(setLeastSignificantBit(GepScheme[1]));
     CHECK(setG(GepScheme[2]));
  
     m_stepsPerRange = std::pow(2,m_nEnergyBits-2);
  
     m_readoutRanges[0] = 0;
     m_readoutRanges[1] = (m_stepsPerRange-1)*m_valLeastSigBit;
     m_readoutRanges[2] = ((m_valG*(m_stepsPerRange-1))+m_stepsPerRange)*m_valLeastSigBit;
     m_readoutRanges[3] = (m_stepsPerRange+(m_stepsPerRange*m_valG)+((m_stepsPerRange-1)*m_valG*m_valG))*m_valLeastSigBit;
     m_readoutRanges[4] = (m_stepsPerRange+(m_stepsPerRange*m_valG)+(m_stepsPerRange*m_valG*m_valG)+((m_stepsPerRange-1)*m_valG*m_valG*m_valG))*m_valLeastSigBit;
  
     ATH_MSG_INFO("Readout scheme with " << m_nEnergyBits << "-bits provides the following four energy thresholds (with " << m_stepsPerRange << " discrete steps on each threshold)");
     ATH_MSG_INFO("GEP cell energy range 0: min = " << m_readoutRanges[0] << " MeV -> max = " << m_readoutRanges[1] << " MeV");
     ATH_MSG_INFO("GEP cell energy range 1: min = " << m_readoutRanges[1] + m_valLeastSigBit << " MeV -> max = " << m_readoutRanges[2] << " MeV");
     ATH_MSG_INFO("GEP cell energy range 2: min = " << m_readoutRanges[2]+(m_valG*m_valLeastSigBit) << " MeV -> max = " << m_readoutRanges[3] << " MeV");
     ATH_MSG_INFO("GEP cell energy range 3: min = " << m_readoutRanges[3]+(m_valG*m_valG*m_valLeastSigBit) << " MeV -> max = " << m_readoutRanges[4] << " MeV");
   }
  
   if (m_doTruncationOfOverflowingFEBs) {
     // Loading the invariant cell data and storing in m_gepCellsBase for later use on event-by-event basis
     m_gepCellsBase.clear();
  
     ATH_MSG_INFO("Loading cell map associating cells to FEBs");
  
     std::string cellMapPath = PathResolverFindCalibFile(m_LArCellMap);
     if(cellMapPath.empty()) ATH_MSG_ERROR("Could not find file with cell map data: " << m_LArCellMap.value());
  
     std::ifstream file(cellMapPath.c_str());
  
     unsigned n_cells = 0;
  
     // Read input file
     if (file.is_open()) {
  
             int online_id, offline_id, ch, con_num, fbr;
             std::string feb, con_type;
  
             // Skipping header of file
             std::getline(file, feb);
  
             // start reading data
             while (true) {
  
                     file >> offline_id >> online_id >> feb >> ch >> con_type >> con_num >> fbr;
  
                     if (file.eof()) break;
  
             Gep::GepCaloCell caloCell;
             caloCell.id = offline_id;
             caloCell.FEB = feb;
             caloCell.channel = ch;
             caloCell.fiber = fbr;
             caloCell.connection_type = con_type;
             caloCell.connection_number = con_num;
  
                 m_gepCellsBase.insert(std::pair<unsigned int, Gep::GepCaloCell>(caloCell.id, caloCell));
  
                     ++n_cells;
             }
     }
     else {
             ATH_MSG_ERROR("Could not open file containing the cell to FEB association");
             return StatusCode::FAILURE;
     }
  
     ATH_MSG_INFO("Loaded FEB information for " << n_cells << " cells");
   }
  
   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.

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

◆ removeCellsFromOverloadedFEB()

StatusCode CaloCellsHandlerTool::removeCellsFromOverloadedFEB ( std::vector< Gep::GepCaloCell > & cells ) const

private

Definition at line 322 of file CaloCellsHandlerTool.cxx.

                                                                                                     {
  
   std::map<int,Gep::GepCaloCell> orderedCells;
   for (const Gep::GepCaloCell& cell : cells) 
     orderedCells.insert(std::pair<int,Gep::GepCaloCell>(cell.channel,cell));
  
   cells.clear();
  
   std::map<int,Gep::GepCaloCell>::iterator cell_itr = orderedCells.begin();
   for ( ;cell_itr != orderedCells.end(); ++cell_itr) {
     cells.push_back(cell_itr->second);
     if (cells.size() == m_maxCellsPerFEB) break;
   }
  
   return StatusCode::SUCCESS;
 }

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

◆ setG()

StatusCode CaloCellsHandlerTool::setG ( int value )

inline

Definition at line 72 of file CaloCellsHandlerTool.h.

                              {
     if (value < 1) {
                 ATH_MSG_FATAL("The value of G in the GEP energy encoding cannot be set to " << value);
                 return StatusCode::FAILURE;
         }
         ATH_MSG_INFO("Setting the value for G in the GEP energy encoding to " << value);
         m_valG = value;
  
     return StatusCode::SUCCESS;
   }

◆ setLeastSignificantBit()

StatusCode CaloCellsHandlerTool::setLeastSignificantBit ( int value )

inline

Definition at line 61 of file CaloCellsHandlerTool.h.

                                                {
     if (value < 1) {
         ATH_MSG_FATAL("The value of the least significant bit in the GEP energy encoding cannot be set to " << value);
                 return StatusCode::FAILURE;
     }
         ATH_MSG_INFO("Setting the value for the least significant bit in the GEP energy encoding to " << value << " MeV");
         m_valLeastSigBit = value;
  
     return StatusCode::SUCCESS;
   }

◆ setNumberOfEnergyBits()

StatusCode CaloCellsHandlerTool::setNumberOfEnergyBits ( int value )

inline

Definition at line 42 of file CaloCellsHandlerTool.h.

                                               {
  
     // At the moment only have a detailed scheme for 6-10 bit readouts, thus rejecting any other value
     switch(value) {
         case 6: m_maxCellsPerFEB = 53; break;
         case 7: m_maxCellsPerFEB = 46; break;
         case 8: m_maxCellsPerFEB = 41; break;
         case 9: m_maxCellsPerFEB = 37; break;
         case 10: m_maxCellsPerFEB = 34; break;
                 default: ATH_MSG_FATAL("A GEP energy encoding scheme with " << value << " energy bits is currently not defined");
                 return StatusCode::FAILURE;
     }
  
         ATH_MSG_INFO("Setting GEP energy encoding to a " << value << "-bit scheme which allows for the sending of " << m_maxCellsPerFEB << " cells to GEP per FEB");
     m_nEnergyBits = value;
  
     return StatusCode::SUCCESS;
   }

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

Member Data Documentation

◆ m_CaloCell_ID

const CaloCell_ID* CaloCellsHandlerTool::m_CaloCell_ID {nullptr}

private

Definition at line 117 of file CaloCellsHandlerTool.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_doGepHardwareStyleEnergyEncoding

Gaudi::Property<bool> CaloCellsHandlerTool::m_doGepHardwareStyleEnergyEncoding {this, "HardwareStyleEnergyEncoding", false, "Enabling or disabling the hardware-style energy encoding for the GEP"}

private

Definition at line 99 of file CaloCellsHandlerTool.h.

◆ m_doTruncationOfOverflowingFEBs

Gaudi::Property<bool> CaloCellsHandlerTool::m_doTruncationOfOverflowingFEBs {this, "TruncationOfOverflowingFEBs", false, "Enabling or disabling the truncation of cells from FEBs with more than the maximum number of cells which can be send"}

private

Definition at line 100 of file CaloCellsHandlerTool.h.

◆ m_electronicNoiseKey

SG::ReadCondHandleKey<CaloNoise> CaloCellsHandlerTool::m_electronicNoiseKey

private

Initial value:

{this,
      "electronicNoiseKey",
      "totalNoise",
      "SG Key of CaloNoise data object"}

Definition at line 104 of file CaloCellsHandlerTool.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_gepCellsBase

std::map<unsigned int,Gep::GepCaloCell> CaloCellsHandlerTool::m_gepCellsBase = {}

private

Definition at line 96 of file CaloCellsHandlerTool.h.

◆ m_GepEnergyEncodingScheme

Gaudi::Property<std::string> CaloCellsHandlerTool::m_GepEnergyEncodingScheme {this, "GEPEnergyEncodingScheme", "", "String defining the GEP readout scheme according to number of readout bits + '-' + value of LSB in MeV + '-' + gain value"}

private

Definition at line 98 of file CaloCellsHandlerTool.h.

◆ m_LArCellMap

Gaudi::Property<std::string> CaloCellsHandlerTool::m_LArCellMap {this, "LArCellMapFile", "UpgradePerformanceFunctions/LAr_Cell_Map_offlineID_0.csv", "File associating LAr cells with readout FEBs and connection technology"}

private

Definition at line 101 of file CaloCellsHandlerTool.h.

◆ m_maxCellsPerFEB

unsigned CaloCellsHandlerTool::m_maxCellsPerFEB = -1

private

Definition at line 94 of file CaloCellsHandlerTool.h.

◆ m_nEnergyBits

int CaloCellsHandlerTool::m_nEnergyBits = -1

private

Key of the CaloNoise Conditions data object.

Typical values are '"electronicNoise', 'pileupNoise', or '"totalNoise' (default)

Definition at line 89 of file CaloCellsHandlerTool.h.

◆ m_readoutRanges

int CaloCellsHandlerTool::m_readoutRanges[5] = {-1,-1,-1,-1,-1}

private

Definition at line 92 of file CaloCellsHandlerTool.h.

◆ m_stepsPerRange

int CaloCellsHandlerTool::m_stepsPerRange = -1

private

Definition at line 93 of file CaloCellsHandlerTool.h.

◆ m_totalNoiseKey

SG::ReadCondHandleKey<CaloNoise> CaloCellsHandlerTool::m_totalNoiseKey

private

Initial value:

{this,
          "totalNoiseKey",
          "totalNoise",
          "SG Key of CaloNoise data object"}

Definition at line 111 of file CaloCellsHandlerTool.h.

◆ m_valG

int CaloCellsHandlerTool::m_valG = -1

private

Definition at line 91 of file CaloCellsHandlerTool.h.

◆ m_valLeastSigBit

int CaloCellsHandlerTool::m_valLeastSigBit = -1

private

Definition at line 90 of file CaloCellsHandlerTool.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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloCellsHandlerTool()

◆ ~CaloCellsHandlerTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getGepCellMap()

◆ getGepEnergy()

◆ getNeighbours()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ removeCellsFromOverloadedFEB()

◆ renounce()

◆ renounceArray()

◆ setG()

◆ setLeastSignificantBit()

◆ setNumberOfEnergyBits()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_CaloCell_ID

◆ m_detStore

◆ m_doGepHardwareStyleEnergyEncoding

◆ m_doTruncationOfOverflowingFEBs

◆ m_electronicNoiseKey

◆ m_evtStore

◆ m_gepCellsBase

◆ m_GepEnergyEncodingScheme

◆ m_LArCellMap

◆ m_maxCellsPerFEB

◆ m_nEnergyBits

◆ m_readoutRanges

◆ m_stepsPerRange

◆ m_totalNoiseKey

◆ m_valG

◆ m_valLeastSigBit

◆ m_varHandleArraysDeclared

◆ m_vhka