Retrieves all Calo Cluster objects. More...

#include <CaloFCalRetriever.h>

Inheritance diagram for JiveXML::CaloFCalRetriever:

Collaboration diagram for JiveXML::CaloFCalRetriever:

Public Member Functions
	CaloFCalRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...

virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data. More...

const DataMap	getFCalData (const CaloCellContainer *cellContainer)
	Retrieve FCal cell location and details. More...

virtual std::string	dataTypeName () const
	Return the name of the data type. More...

StatusCode	initialize ()
	Default AthAlgTool methods. 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 ()
	Return the interface identifier. 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
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 CaloCell_ID *	m_calocell_id

SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}

SG::ReadCondHandleKey< LArADC2MeV >	m_adc2mevKey { this, "ADC2MeVKey", "LArADC2MeV", "SG Key of the LArADC2MeV CDO" }

SG::ReadHandleKey< CaloCellContainer >	m_sgKey {this, "StoreGateKey", "AllCalo", "Name of the CaloCellContainer"}
	for properties More...

double	m_cellThreshold

int	m_cellEnergyPrec

int	m_cellTimePrec

bool	m_fcal

bool	m_doFCalCellDetails

bool	m_cellConditionCut

std::vector< Identifier::value_type >	m_LArChannelsToIgnoreM5

bool	m_doMaskLArChannelsM5

bool	m_doBadFCal

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

Retrieves all Calo Cluster objects.

Properties
- StoreGateKey: default is 'AllCalo'. Don't change.
- FCallCellThreshold: default is 50 (MeV)
- RetrieveFCal: general flag, default is true
- DoFCalCellDetails: default is false
- CellConditionCut: default is false
- LArChannelsToIgnoreM5: default is empty (none ignored). Input: vector of cells
  - DoMaskLArChannelsM5: default is false (none masked)
  - CellEnergyPrec: precision in int, default is 3 digits
  - CellTimePrec: precision in int, default is 3 digits
Retrieved Data
- location in x, y
- numCells: number of cells in each cluster
- cells: identifier and adc counts of each cell

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

◆ CaloFCalRetriever()

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

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 31 of file CaloFCalRetriever.cxx.

                                                                                                           :
     AthAlgTool(type,name,parent),
     m_calocell_id(nullptr)
   {
     //Only declare the interface
     declareInterface<IDataRetriever>(this);
     
     declareInterface<IDataRetriever>(this);
     declareProperty("FCallCellThreshold", m_cellThreshold = 50.);
     declareProperty("RetrieveFCal" , m_fcal = true);
     declareProperty("DoBadFCal",     m_doBadFCal = false);
     declareProperty("DoFCalCellDetails",  m_doFCalCellDetails = false); 
     declareProperty("CellConditionCut", m_cellConditionCut = false);
     declareProperty("LArChannelsToIgnoreM5",  m_LArChannelsToIgnoreM5);
     declareProperty("DoMaskLArChannelsM5", m_doMaskLArChannelsM5 = false);
  
     declareProperty("CellEnergyPrec", m_cellEnergyPrec = 3);
     declareProperty("CellTimePrec", m_cellTimePrec = 3);
   }

Member Function Documentation

◆ dataTypeName()

virtual std::string JiveXML::CaloFCalRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 62 of file CaloFCalRetriever.h.

62 { return "FCAL"; };

◆ 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

◆ getFCalData()

const DataMap JiveXML::CaloFCalRetriever::getFCalData ( const CaloCellContainer * cellContainer )

Retrieve FCal cell location and details.

Parameters

FormatTool the tool that will create formated output from the DataMap

Definition at line 95 of file CaloFCalRetriever.cxx.

                                                                                      {
     
     ATH_MSG_DEBUG( "getFCalData()"  );
     const EventContext& ctx = Gaudi::Hive::currentContext();
  
     DataMap DataMap;
  
     DataVect x; x.reserve(cellContainer->size());
     DataVect y; y.reserve(cellContainer->size());
     DataVect z; z.reserve(cellContainer->size());
     DataVect dx; dx.reserve(cellContainer->size());
     DataVect dy; dy.reserve(cellContainer->size());
     DataVect dz; dz.reserve(cellContainer->size());
  
     DataVect energy; energy.reserve(cellContainer->size());
     DataVect idVec; idVec.reserve(cellContainer->size());
     DataVect channel; channel.reserve(cellContainer->size());
     DataVect feedThrough; feedThrough.reserve(cellContainer->size());
     DataVect slot; slot.reserve(cellContainer->size());
     DataVect sub; sub.reserve(cellContainer->size());
  
     DataVect cellTimeVec; cellTimeVec.reserve(cellContainer->size());
     DataVect cellGain; cellGain.reserve(cellContainer->size());
     DataVect cellPedestal; cellPedestal.reserve(cellContainer->size());
     DataVect adc2Mev; adc2Mev.reserve(cellContainer->size());
     DataVect BadCell; BadCell.reserve(cellContainer->size());
  
     char rndStr[30]; // for rounding (3 digit precision)
  
     CaloCellContainer::const_iterator it1 = cellContainer->beginConstCalo(CaloCell_ID::LARFCAL);
     CaloCellContainer::const_iterator it2 = cellContainer->endConstCalo(CaloCell_ID::LARFCAL);
  
     SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
     const LArOnOffIdMapping* cabling{*cablingHdl};
  
     if(!cabling) {
        ATH_MSG_WARNING( "Do not have cabling mapping from key " << m_cablingKey.key() );
        return DataMap;
     }
  
     const ILArPedestal* larPedestal = nullptr;
     if(m_doFCalCellDetails){
     if( detStore()->retrieve(larPedestal).isFailure() ){
       ATH_MSG_ERROR( "in getFCalData(), Could not retrieve LAr Pedestal"  );
     }
       }
       
     const LArOnlineID* onlineId;
     if ( detStore()->retrieve(onlineId, "LArOnlineID").isFailure()) {
       ATH_MSG_ERROR( "in getFCalData(),Could not get LArOnlineID!"  );
      }
     
     const LArADC2MeV* adc2mev = nullptr;
     if (m_doFCalCellDetails) {
       SG::ReadCondHandle<LArADC2MeV> adc2mevH (m_adc2mevKey, ctx);
       adc2mev = *adc2mevH;
     }
  
       double energyGeV, xmm, ymm, zmm, dxmm, dymm, dzmm, cellTime;
       double energyAllLArFcal = 0.;
  
       for(;it1!=it2;++it1){
  
       if((*it1)->badcell()) BadCell.push_back(1);
       else if((*it1)->energy()>= m_cellThreshold) BadCell.push_back(0);
       else BadCell.push_back(-1);
  
       if ((((*it1)->provenance()&0xFF)!=0xA5)&&m_cellConditionCut) continue; // check full conditions for FCal
       Identifier cellid = (*it1)->ID(); 
  
           HWIdentifier LArhwid = cabling->createSignalChannelIDFromHash((*it1)->caloDDE()->calo_hash());
       
       //ignore FCal cells that are to be masked
       if (m_doMaskLArChannelsM5){
         bool maskChannel = false;
         for (size_t i = 0; i < m_LArChannelsToIgnoreM5.size(); i++){
               if (cellid == m_LArChannelsToIgnoreM5[i]){
         maskChannel = true; 
         break;  // exit loop over bad channels
           }       
         }
         if (maskChannel) continue;  // continue loop over all channels
       }
  
       energyGeV = (*it1)->energy()*(1./GeV);
       energy.emplace_back( gcvt( energyGeV, m_cellEnergyPrec, rndStr) );
           energyAllLArFcal += energyGeV;
           idVec.emplace_back((Identifier::value_type)(*it1)->ID().get_compact() );
         
       xmm = (*it1)->x()*0.1;
       ymm = (*it1)->y()*0.1;
       zmm = (*it1)->z()*0.1;
       x.emplace_back( gcvt( xmm, 4, rndStr)  );
       y.emplace_back( gcvt( ymm, 4, rndStr)  );
       z.emplace_back( gcvt( zmm, 4, rndStr)  );
       
           channel.emplace_back(onlineId->channel(LArhwid)); 
           feedThrough.emplace_back(onlineId->feedthrough(LArhwid)); 
           slot.emplace_back(onlineId->slot(LArhwid)); 
  
       if ( m_doFCalCellDetails){
         cellTime = (*it1)->time();
         cellTimeVec.emplace_back( gcvt( cellTime, m_cellTimePrec, rndStr)  );
         cellGain.emplace_back( (*it1)->gain()  ); 
         
         int fcalgain = (*it1)->gain();
         float pedestal=larPedestal->pedestal(LArhwid,fcalgain);
         float pedvalue=0;
         if (pedestal >= (1.0+LArElecCalib::ERRORCODE)) pedvalue = pedestal;
         else pedvalue = 0;
         cellPedestal.emplace_back(pedvalue);
              
             LArVectorProxy polynom_adc2mev = adc2mev->ADC2MEV(cellid,fcalgain);
             if (polynom_adc2mev.size()==0){ adc2Mev.emplace_back(-1); }
             else{ adc2Mev.emplace_back(polynom_adc2mev[1]); }
       }
  
       const CaloDetDescrElement* elt = (*it1)->caloDDE();
  
       dxmm = elt->dx()*0.1;
       dymm = elt->dy()*0.1;
       dzmm = elt->dz()*0.1;
       dx.emplace_back( gcvt( dxmm, 4, rndStr)  );
       dy.emplace_back( gcvt( dymm, 4, rndStr)  );
       dz.emplace_back( gcvt( dzmm, 4, rndStr)  );
         
       if(m_calocell_id->pos_neg(cellid)==2)
         sub.emplace_back(1);
       else
         sub.emplace_back(0);
       }
  
     ATH_MSG_DEBUG( " Total energy in FCAL (LAr) in GeV : " <<  energyAllLArFcal  );
  
     // write values into DataMap
     const auto nEntries = x.size();
     DataMap["x"] = std::move(x);
     DataMap["y"] = std::move(y);
     DataMap["z"] = std::move(z);
     DataMap["dx"] = std::move(dx);
     DataMap["dy"] = std::move(dy);
     DataMap["dz"] = std::move(dz);
     DataMap["energy"] = std::move(energy);
     DataMap["id"] = std::move(idVec);
     DataMap["channel"] = std::move(channel);
     DataMap["feedThrough"] = std::move(feedThrough);
     DataMap["slot"] = std::move(slot);
     //Bad Cells
     if (m_doBadFCal) {
       DataMap["BadCell"] = std::move(BadCell);
     }    DataMap["sub"] = std::move(sub);
  
     // adc counts
     if ( m_doFCalCellDetails){
        DataMap["cellTime"] = std::move(cellTimeVec);
        DataMap["cellGain"] = std::move(cellGain);
        DataMap["cellPedestal"] = std::move(cellPedestal);
        DataMap["adc2Mev"] = std::move(adc2Mev);
     }
     //Be verbose
     ATH_MSG_DEBUG( dataTypeName() << " retrieved with " << nEntries << " entries" );
  
     //All collections retrieved okay
     return DataMap;
  
   } // getFCalData

◆ initialize()

StatusCode JiveXML::CaloFCalRetriever::initialize ( )

Default AthAlgTool methods.

Initialise the ToolSvc.

Definition at line 55 of file CaloFCalRetriever.cxx.

                                            {
  
     ATH_MSG_DEBUG( "Initialising Tool"  );
     ATH_CHECK( detStore()->retrieve (m_calocell_id, "CaloCell_ID") );
  
     ATH_CHECK( m_sgKey.initialize() );
     ATH_CHECK( m_cablingKey.initialize() );
     ATH_CHECK( m_adc2mevKey.initialize(m_doFCalCellDetails) );
  
     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 & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40 { return IID_IDataRetriever; }

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

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

◆ retrieve()

StatusCode JiveXML::CaloFCalRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

FCal data retrieval from default collection.

Implements JiveXML::IDataRetriever.

Definition at line 70 of file CaloFCalRetriever.cxx.

                                                                             {
     
     ATH_MSG_DEBUG( "in retrieve()"  );
  
     SG::ReadHandle<CaloCellContainer> cellContainer(m_sgKey);
     if (!cellContainer.isValid()){
         ATH_MSG_WARNING( "Could not retrieve Calorimeter Cells "  );
     }
     else{
       if(m_fcal){
         DataMap data = getFCalData(&(*cellContainer));
         ATH_CHECK( FormatTool->AddToEvent(dataTypeName(), m_sgKey.key(), &data) );
         ATH_MSG_DEBUG( "FCal retrieved"  );
       }
     }
  
     //FCal cells retrieved okay
     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_adc2mevKey

SG::ReadCondHandleKey<LArADC2MeV> JiveXML::CaloFCalRetriever::m_adc2mevKey { this, "ADC2MeVKey", "LArADC2MeV", "SG Key of the LArADC2MeV CDO" }

private

Definition at line 72 of file CaloFCalRetriever.h.

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> JiveXML::CaloFCalRetriever::m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}

private

Definition at line 70 of file CaloFCalRetriever.h.

◆ m_calocell_id

const CaloCell_ID* JiveXML::CaloFCalRetriever::m_calocell_id

private

Definition at line 69 of file CaloFCalRetriever.h.

◆ m_cellConditionCut

bool JiveXML::CaloFCalRetriever::m_cellConditionCut

private

Definition at line 82 of file CaloFCalRetriever.h.

◆ m_cellEnergyPrec

int JiveXML::CaloFCalRetriever::m_cellEnergyPrec

private

Definition at line 78 of file CaloFCalRetriever.h.

◆ m_cellThreshold

double JiveXML::CaloFCalRetriever::m_cellThreshold

private

Definition at line 77 of file CaloFCalRetriever.h.

◆ m_cellTimePrec

int JiveXML::CaloFCalRetriever::m_cellTimePrec

private

Definition at line 79 of file CaloFCalRetriever.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_doBadFCal

bool JiveXML::CaloFCalRetriever::m_doBadFCal

private

Definition at line 85 of file CaloFCalRetriever.h.

◆ m_doFCalCellDetails

bool JiveXML::CaloFCalRetriever::m_doFCalCellDetails

private

Definition at line 81 of file CaloFCalRetriever.h.

◆ m_doMaskLArChannelsM5

bool JiveXML::CaloFCalRetriever::m_doMaskLArChannelsM5

private

Definition at line 84 of file CaloFCalRetriever.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_fcal

bool JiveXML::CaloFCalRetriever::m_fcal

private

Definition at line 80 of file CaloFCalRetriever.h.

◆ m_LArChannelsToIgnoreM5

std::vector<Identifier::value_type> JiveXML::CaloFCalRetriever::m_LArChannelsToIgnoreM5

private

Definition at line 83 of file CaloFCalRetriever.h.

◆ m_sgKey

SG::ReadHandleKey<CaloCellContainer> JiveXML::CaloFCalRetriever::m_sgKey {this, "StoreGateKey", "AllCalo", "Name of the CaloCellContainer"}

private

for properties

Definition at line 76 of file CaloFCalRetriever.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloFCalRetriever()

Member Function Documentation

◆ dataTypeName()

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

◆ getFCalData()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieve()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_adc2mevKey

◆ m_cablingKey

◆ m_calocell_id

◆ m_cellConditionCut

◆ m_cellEnergyPrec

◆ m_cellThreshold

◆ m_cellTimePrec

◆ m_detStore

◆ m_doBadFCal

◆ m_doFCalCellDetails

◆ m_doMaskLArChannelsM5

◆ m_evtStore

◆ m_fcal

◆ m_LArChannelsToIgnoreM5

◆ m_sgKey

◆ m_varHandleArraysDeclared

◆ m_vhka