JiveXML::CaloLArRetriever Class Reference

Retrieves all Calo Cluster objects. More...

#include <CaloLArRetriever.h>

Inheritance diagram for JiveXML::CaloLArRetriever:

Collaboration diagram for JiveXML::CaloLArRetriever:

Public Member Functions
	CaloLArRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data.
const DataMap	getLArData (const CaloCellContainer *cellContainer)
	Retrieve LAr cell location and details.
virtual std::string	dataTypeName () const
	Return the name of the data type.
StatusCode	initialize ()
	Default AthAlgTool methods.
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 ()
	Return the interface identifier.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

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
double	m_cellThreshold {}
int	m_cellEnergyPrec {}
int	m_cellTimePrec {}
bool	m_lar {}
bool	m_doLArCellDetails {}
bool	m_cellConditionCut {}
std::vector< Identifier::value_type >	m_LArChannelsToIgnoreM5
bool	m_doMaskLArChannelsM5 {}
bool	m_doBadLAr {}
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

Retrieves all Calo Cluster objects.

• Properties
  • StoreGateKey: default is 'AllCalo'. Don't change.
  • LArlCellThreshold: default is 50 (MeV)
  • RetrieveLAr: general flag, default is true
  • DoLArCellDetails: 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 phi and eta
  • numCells: number of cells in each cluster
  • cells: identifier and adc counts of each cell

Definition at line 50 of file CaloLArRetriever.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

CaloLArRetriever()

JiveXML::CaloLArRetriever::CaloLArRetriever	(	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 CaloLArRetriever.cxx.

                                                                                                        :
    AthAlgTool(type,name,parent),
    m_calocell_id(nullptr)
  {
 
    //Only declare the interface
    declareInterface<IDataRetriever>(this);
 
    declareInterface<IDataRetriever>(this);
    declareProperty("LArlCellThreshold", m_cellThreshold = 50.);
    declareProperty("RetrieveLAr" , m_lar = true);
    declareProperty("DoBadLAr",     m_doBadLAr = false);
    declareProperty("DoLArCellDetails",  m_doLArCellDetails = 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::CaloLArRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 63 of file CaloLArRetriever.h.

{ return "LAr"; };

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getLArData()

const DataMap JiveXML::CaloLArRetriever::getLArData

(

const CaloCellContainer *

cellContainer

)

Retrieve LAr cell location and details.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Definition at line 96 of file CaloLArRetriever.cxx.

                                                                                   {
    
    ATH_MSG_DEBUG( "getLArData()"  );
    const EventContext& ctx = Gaudi::Hive::currentContext();
 
    DataMap dataMap;
 
    DataVect phi; phi.reserve(cellContainer->size());
    DataVect eta; eta.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 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::LAREM);
    CaloCellContainer::const_iterator it2 = cellContainer->endConstCalo(CaloCell_ID::LAREM);
 
    
    const ILArPedestal* larPedestal = nullptr;
    if(m_doLArCellDetails){
      if( detStore()->retrieve(larPedestal).isFailure() ){
        ATH_MSG_ERROR( "in getLArData(), Could not retrieve LAr Pedestal"  );
      }
    }
      
    const LArOnlineID* onlineId = nullptr;
    if ( detStore()->retrieve(onlineId, "LArOnlineID").isFailure()) {
      ATH_MSG_ERROR( "in getLArData(),Could not get LArOnlineID!"  );
    }
 
    const LArADC2MeV* adc2mev = nullptr;
    if (m_doLArCellDetails) {
      SG::ReadCondHandle<LArADC2MeV> adc2mevH (m_adc2mevKey, ctx);
      adc2mev = *adc2mevH;
    }
 
      double energyGeV,cellTime;
      double energyAllLArBarrel = 0.;
 
      ATH_MSG_DEBUG( "Start iterator loop over cells"  );
      
      SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey, ctx};
      const LArOnOffIdMapping* cabling{*cablingHdl};
      if(!cabling) {
         ATH_MSG_ERROR( "Do not have cabling mapping from key " << m_cablingKey.key() );
         return dataMap;
      }
     
 
      for(;it1!=it2;++it1){
    if ((*it1)->energy() < m_cellThreshold) continue; // skip to next cell if threshold not passed
 
    if((*it1)->badcell()){ BadCell.push_back(1); }
        else{ BadCell.push_back(-1); }
 
      if ((((*it1)->provenance()&0xFF)!=0xA5)&&m_cellConditionCut) continue; // check full conditions for LAr
      Identifier cellid = (*it1)->ID(); 
 
          HWIdentifier LArhwid = cabling->createSignalChannelIDFromHash((*it1)->caloDDE()->calo_hash());
      
      //ignore LAr 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);
      if (energyGeV == 0) energyGeV = 0.001; // 1 MeV due to LegoCut > 0.0 (couldn't be >= 0.0) 
      energy.emplace_back( gcvt( energyGeV, m_cellEnergyPrec, rndStr) );
          energyAllLArBarrel += energyGeV;
 
          idVec.emplace_back((Identifier::value_type)(*it1)->ID().get_compact() );
          phi.emplace_back((*it1)->phi());
          eta.emplace_back((*it1)->eta());
          channel.emplace_back(onlineId->channel(LArhwid)); 
          feedThrough.emplace_back(onlineId->feedthrough(LArhwid)); 
          slot.emplace_back(onlineId->slot(LArhwid)); 
 
          if ( m_doLArCellDetails){
            cellTime = (*it1)->time();
            cellTimeVec.emplace_back( gcvt( cellTime, m_cellTimePrec, rndStr)  );
            cellGain.emplace_back( (*it1)->gain()  ); 
              
            int largain = (*it1)->gain();
            float pedestal=larPedestal->pedestal(LArhwid,largain);
            float pedvalue=0;
            if (pedestal >= (1.0+LArElecCalib::ERRORCODE)) pedvalue = pedestal;
            else pedvalue = 0;
            cellPedestal.emplace_back(pedvalue);
            LArVectorProxy polynom_adc2mev = adc2mev->ADC2MEV(cellid,largain);
            if (polynom_adc2mev.size()==0){ adc2Mev.emplace_back(-1); }
            else{ adc2Mev.emplace_back(polynom_adc2mev[1]); }
          }
      }
 
    ATH_MSG_DEBUG( " Total energy in LAr barrel in GeV : " <<  energyAllLArBarrel  );
 
    // write values into dataMap
    const auto nEntries = phi.size() ;
    dataMap["phi"] = std::move(phi);
    dataMap["eta"] = std::move(eta);
    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_doBadLAr==true) {
      dataMap["BadCell"] = std::move(BadCell);
    }
 
   // adc counts
    if ( m_doLArCellDetails){
       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() << " , collection: " << dataTypeName()
                   << " retrieved with " << nEntries << " entries" );
 
    //All collections retrieved okay
    return dataMap;
 
  } // getLArData

initialize()

StatusCode JiveXML::CaloLArRetriever::initialize

(

)

Default AthAlgTool methods.

Initialise the ToolSvc.

Definition at line 56 of file CaloLArRetriever.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_doLArCellDetails) );
 
    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.

{ return IID_IDataRetriever; }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

retrieve()

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

virtual

Retrieve all the data.

LAr data retrieval from default collection.

Implements JiveXML::IDataRetriever.

Definition at line 71 of file CaloLArRetriever.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_lar){
        DataMap data = getLArData(&(*cellContainer));
        ATH_CHECK( FormatTool->AddToEvent(dataTypeName(), m_sgKey.key(), &data) );
        ATH_MSG_DEBUG( "LAr retrieved"  );
      }
    }
 
    //LAr 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_adc2mevKey

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

private

Definition at line 73 of file CaloLArRetriever.h.

{ this, "ADC2MeVKey", "LArADC2MeV", "SG Key of the LArADC2MeV CDO" };

m_cablingKey

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

private

Definition at line 71 of file CaloLArRetriever.h.

{this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"};

m_calocell_id

const CaloCell_ID* JiveXML::CaloLArRetriever::m_calocell_id {}

private

Definition at line 70 of file CaloLArRetriever.h.

{};

m_cellConditionCut

bool JiveXML::CaloLArRetriever::m_cellConditionCut {}

private

Definition at line 83 of file CaloLArRetriever.h.

{};

m_cellEnergyPrec

int JiveXML::CaloLArRetriever::m_cellEnergyPrec {}

private

Definition at line 79 of file CaloLArRetriever.h.

{};

m_cellThreshold

double JiveXML::CaloLArRetriever::m_cellThreshold {}

private

Definition at line 78 of file CaloLArRetriever.h.

{};

m_cellTimePrec

int JiveXML::CaloLArRetriever::m_cellTimePrec {}

private

Definition at line 80 of file CaloLArRetriever.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_doBadLAr

bool JiveXML::CaloLArRetriever::m_doBadLAr {}

private

Definition at line 86 of file CaloLArRetriever.h.

{};

m_doLArCellDetails

bool JiveXML::CaloLArRetriever::m_doLArCellDetails {}

private

Definition at line 82 of file CaloLArRetriever.h.

{};

m_doMaskLArChannelsM5

bool JiveXML::CaloLArRetriever::m_doMaskLArChannelsM5 {}

private

Definition at line 85 of file CaloLArRetriever.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_lar

bool JiveXML::CaloLArRetriever::m_lar {}

private

Definition at line 81 of file CaloLArRetriever.h.

{};

m_LArChannelsToIgnoreM5

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

private

Definition at line 84 of file CaloLArRetriever.h.

m_sgKey

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

private

for properties

Definition at line 77 of file CaloLArRetriever.h.

{this, "StoreGateKey", "AllCalo", "Name of the CaloCellContainer"};

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:

• CaloLArRetriever.h
• CaloLArRetriever.cxx