JiveXML::BadTileRetriever Class Reference

Retrieves all Tile Calo Cell objects. More...

#include <BadTileRetriever.h>

Inheritance diagram for JiveXML::BadTileRetriever:

Collaboration diagram for JiveXML::BadTileRetriever:

Public Member Functions
	BadTileRetriever (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	getBadTileData (const CaloCellContainer *cellContainer)
	Retrieve Tile bad 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
void	calcTILELayerSub (Identifier &)
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::ReadHandleKey< CaloCellContainer >	m_sgKey {this, "StoreGateKey", "AllCalo", "Name of the CaloCellContainer"}
double	m_cellThreshold
int	m_cellEnergyPrec
bool	m_tile
bool	m_doBadTile
DataVect	m_sub
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 Tile Calo Cell objects.

• Properties
  • StoreGateKeyTile: default is 'AllCalo'. Don't change.
  • CallThreshold: default is 50 MeV
  • RetrieveTile: activate retriever, default is true
  • CellEnergyPrec: output precision, default is 3 digits
  • DoBadTile: write Tile bad cell, default is false
• Retrieved Data
  • location in phi and eta
  • identifier and energy of each cell

Definition at line 39 of file BadTileRetriever.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

BadTileRetriever()

JiveXML::BadTileRetriever::BadTileRetriever	(	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 37 of file BadTileRetriever.cxx.

                                                                                                        :
    AthAlgTool(type,name,parent),
    m_calocell_id(nullptr)
  {
    //Only declare the interface
    declareInterface<IDataRetriever>(this);
    
    declareProperty("CellThreshold", m_cellThreshold = 50.);
    declareProperty("RetrieveTILE" , m_tile = true);
    declareProperty("DoBadTile",     m_doBadTile = false);
  
    declareProperty("CellEnergyPrec", m_cellEnergyPrec = 3);
  }

Member Function Documentation

calcTILELayerSub()

void JiveXML::BadTileRetriever::calcTILELayerSub ( Identifier & cellid )

private

Definition at line 129 of file BadTileRetriever.cxx.

  {
    if(m_calocell_id->is_tile_barrel(cellid))
      {
    if(m_calocell_id->is_tile_negative(cellid))
      m_sub.emplace_back(2);
    else
      m_sub.emplace_back(3);
      }
    else if(m_calocell_id->is_tile_extbarrel(cellid))
      {
    if(m_calocell_id->is_tile_negative(cellid))
      m_sub.emplace_back(0);
    else
      m_sub.emplace_back(5);
      }
    //else in ITC or scint
    else
      {
    if(m_calocell_id->is_tile_negative(cellid))
      m_sub.emplace_back(1);
    else
      m_sub.emplace_back(4);
      }
  }

dataTypeName()

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

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 52 of file BadTileRetriever.h.

{ return "BadTILE"; };

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

getBadTileData()

const DataMap JiveXML::BadTileRetriever::getBadTileData

(

const CaloCellContainer *

cellContainer

)

Retrieve Tile bad cell location and details.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Definition at line 86 of file BadTileRetriever.cxx.

                                                                                       {
    ATH_MSG_DEBUG( "getBadTileData()"  );
    char rndStr[30];
    DataMap DataMap;
    DataVect phi; phi.reserve(cellContainer->size());
    DataVect eta; eta.reserve(cellContainer->size());
    DataVect idVec; idVec.reserve(cellContainer->size());
    DataVect energyVec; energyVec.reserve(cellContainer->size());
    m_sub.clear();
    //Loop Over CaloCellContainer to retrieve TileCell information
    CaloCellContainer::const_iterator it1 = cellContainer->beginConstCalo(CaloCell_ID::TILE);
    CaloCellContainer::const_iterator it2 = cellContainer->endConstCalo(CaloCell_ID::TILE);
    if (m_doBadTile==true) {
      double energyGeV;
      //int cellInd;
      ATH_MSG_DEBUG( "Start iterator loop over cells"  );
      for(;it1!=it2;++it1){
        if( !(*it1)->badcell() ) continue;
        Identifier cellid = (*it1)->ID();   
        calcTILELayerSub(cellid);
        energyGeV = (*it1)->energy()*(1./GeV);
        energyVec.emplace_back( gcvt( energyGeV, m_cellEnergyPrec, rndStr) );
        idVec.emplace_back( (Identifier::value_type)(*it1)->ID().get_compact() );
        phi.emplace_back((*it1)->phi());
        eta.emplace_back((*it1)->eta());
      } // end cell iterator
    } // doBadTile
    
    // write values into DataMap
    const auto nEntries = phi.size();
    DataMap["phi"] = std::move(phi);
    DataMap["eta"] = std::move(eta);
    DataMap["sub"] = std::move(m_sub);
    DataMap["id"] = std::move(idVec);
    DataMap["energy"] = std::move(energyVec);
    //Be verbose
    ATH_MSG_DEBUG( dataTypeName() << " retrieved with " << nEntries << " entries" );
    //All collections retrieved okay
    return DataMap;
  } // getTileData

initialize()

StatusCode JiveXML::BadTileRetriever::initialize

(

)

Default AthAlgTool methods.

Initialise the ToolSvc.

Definition at line 55 of file BadTileRetriever.cxx.

                                          {
    ATH_MSG_DEBUG( "Initialising Tool"  );
    ATH_CHECK( detStore()->retrieve (m_calocell_id, "CaloCell_ID") );
    ATH_CHECK(m_sgKey.initialize());
    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::BadTileRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

Tile data retrieval from chosen collection.

Implements JiveXML::IDataRetriever.

Definition at line 65 of file BadTileRetriever.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_tile){
        DataMap data = getBadTileData(&(*cellContainer));
        ATH_CHECK( FormatTool->AddToEvent(dataTypeName(), m_sgKey.key(), &data) );
        ATH_MSG_DEBUG( "Bad Tile retrieved"  );
      }
    }
    //Tile 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_calocell_id

const CaloCell_ID* JiveXML::BadTileRetriever::m_calocell_id

private

Definition at line 59 of file BadTileRetriever.h.

m_cellEnergyPrec

int JiveXML::BadTileRetriever::m_cellEnergyPrec

private

Definition at line 63 of file BadTileRetriever.h.

m_cellThreshold

double JiveXML::BadTileRetriever::m_cellThreshold

private

Definition at line 62 of file BadTileRetriever.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_doBadTile

bool JiveXML::BadTileRetriever::m_doBadTile

private

Definition at line 65 of file BadTileRetriever.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_sgKey

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

private

Definition at line 61 of file BadTileRetriever.h.

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

m_sub

DataVect JiveXML::BadTileRetriever::m_sub

private

Definition at line 67 of file BadTileRetriever.h.

m_tile

bool JiveXML::BadTileRetriever::m_tile

private

Definition at line 64 of file BadTileRetriever.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:

• BadTileRetriever.h
• BadTileRetriever.cxx