JiveXML::CaloClusterRetriever Class Reference

Retrieves all Calo Cluster objects. More...

#include <CaloClusterRetriever.h>

Inheritance diagram for JiveXML::CaloClusterRetriever:

Collaboration diagram for JiveXML::CaloClusterRetriever:

Public Member Functions
	CaloClusterRetriever (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	getData (const xAOD::CaloClusterContainer *)
	Retrieve basic parameters, mainly four-vectors.
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
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_sgKeyFavourite {this, "StoreGateKey", "egammaClusters", "Name of the CaloClusterContainer"}
std::vector< std::string >	m_otherKeys
bool	m_doWriteHLT
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
  • FavouriteJetCollection
  • OtherJetCollections
  • DoWriteHLT
• Retrieved Data
  • Usual four-vector: phi, eta, et
  • id: counter on clusters
  • Cells: numCells: number of cells in each cluster, and cells: compact identifier code of each cell

Definition at line 35 of file CaloClusterRetriever.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

CaloClusterRetriever()

JiveXML::CaloClusterRetriever::CaloClusterRetriever	(	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 19 of file CaloClusterRetriever.cxx.

                                                                                                                :
    AthAlgTool(type,name,parent),
    m_sgKeyFavourite ("egammaClusters")
  {
    //Only declare the interface
    declareInterface<IDataRetriever>(this);
    
    declareProperty("FavouriteClusterCollection" ,m_sgKeyFavourite,
        "Collection to be first in output, shown in Atlantis without switching");
    declareProperty("OtherClusterCollections" ,m_otherKeys,
        "Other collections to be retrieved. If list left empty, all available retrieved");
    declareProperty("DoWriteHLT", m_doWriteHLT = false,"Ignore HLTAutokey object by default."); // ignore HLTAutoKey objects
  }

Member Function Documentation

dataTypeName()

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

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 48 of file CaloClusterRetriever.h.

{ return "Cluster"; };

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

getData()

const DataMap JiveXML::CaloClusterRetriever::getData

(

const xAOD::CaloClusterContainer *

ccc

)

Retrieve basic parameters, mainly four-vectors.

Clusters have no cells (trying to access them without back-navigation causes Athena crash).

Parameters

FormatTool

the tool that will create formated output from the DataMap

Definition at line 123 of file CaloClusterRetriever.cxx.

                                                                                 {
    
    ATH_MSG_DEBUG( "getData()"  );
 
    DataMap DataMap;
 
    DataVect phi; phi.reserve(ccc->size());
    DataVect eta; eta.reserve(ccc->size());
    DataVect et; et.reserve(ccc->size());
    DataVect idVec; idVec.reserve(ccc->size());
    DataVect numCellsVec; numCellsVec.reserve(ccc->size());
    DataVect cells; cells.reserve( ccc->size() );
 
    int noClu = ccc->size();
    int noCells = 0;
    
    int id = 0;
    for (const auto cluster : *ccc) {
      phi.emplace_back(cluster->phi());
      eta.emplace_back(cluster->eta());
      et.emplace_back(cluster->et()*(1./GeV));
      idVec.emplace_back( ++id );
 
      int numCells = cluster->size();
      numCellsVec.emplace_back( numCells );
      noCells += numCells;
 
      for (const auto cell : *cluster) {
        cells.push_back(cell->ID().get_compact());
      }
    }
 
    std::string tagCells;
    if(noClu){
      tagCells = "cells multiple=\"" +DataType(noCells/(noClu*1.0)).toString()+"\"";
    }else{
      tagCells = "cells multiple=\"1.0\"";
    }
 
    // Start with mandatory entries
    const auto nEntries = phi.size();
    DataMap["phi"] = std::move(phi);
    DataMap["eta"] = std::move(eta);
    DataMap["et"] = std::move(et);
    DataMap[tagCells] = std::move(cells);
    DataMap["numCells"] = std::move(numCellsVec);
    DataMap["id"] = std::move(idVec);
 
    //Be verbose
    ATH_MSG_DEBUG( dataTypeName() << " , collection: " << dataTypeName()
                   << " retrieved with " << nEntries << " entries" );
 
    //All collections retrieved okay
    return DataMap;
 
  } // retrieve

initialize()

StatusCode JiveXML::CaloClusterRetriever::initialize

(

)

Default AthAlgTool methods.

Definition at line 33 of file CaloClusterRetriever.cxx.

  {
 
    ATH_MSG_DEBUG("Initialising Tool");
 
    ATH_CHECK(m_sgKeyFavourite.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::CaloClusterRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

For each cluster collections retrieve basic parameters.

'Favourite' cluster collection first, then 'Other' collections.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 48 of file CaloClusterRetriever.cxx.

                                                                               {
    
    ATH_MSG_DEBUG( "in retrieveAll()"  );
    
    //obtain the default collection first
    ATH_MSG_DEBUG( "Trying to retrieve " << dataTypeName() << " (" << m_sgKeyFavourite.key() << ")"  );
 
    SG::ReadHandle<xAOD::CaloClusterContainer> ccc_primary(m_sgKeyFavourite);
    if (ccc_primary.isValid()) {
      DataMap data = getData(&(*ccc_primary));
      if (FormatTool->AddToEvent(dataTypeName(), m_sgKeyFavourite.key() + "_ESD", &data).isFailure()) {
        ATH_MSG_WARNING("Failed to retrieve favourite Collection " << m_sgKeyFavourite.key() );
      }
      else {
        ATH_MSG_DEBUG(dataTypeName() << " (" << m_sgKeyFavourite.key() << ") CaloCluster retrieved");
      }
    }
    else{
      ATH_MSG_WARNING("Favourite Collection " << m_sgKeyFavourite.key() << " not found in SG ");
    }
 
    if ( m_otherKeys.empty() ) {
      //obtain all other collections from StoreGate
      std::vector<std::string> allkeys;
      evtStore()->keys(static_cast<CLID>( ClassID_traits<xAOD::CaloClusterContainer>::ID() ), allkeys);
      for (const auto& key : allkeys) {
        if (key!=m_sgKeyFavourite.key()) {
          ATH_MSG_DEBUG( "Trying to retrieve all " << dataTypeName() << " (" << key << ")"  );
          SG::ReadHandle<xAOD::CaloClusterContainer> containerRH(key);
          if (!containerRH.isValid()) {
            ATH_MSG_DEBUG( "Unable to retrieve CaloCluster collection " << key );
          } else {
            std::string::size_type position = key.find("HLTAutoKey",0);
            if ( m_doWriteHLT ){ position = 99; } // override SG key find
            if ( position != 0 ){  // SG key doesn't contain HLTAutoKey
              DataMap data = getData(&*containerRH);
              if ( FormatTool->AddToEvent(dataTypeName(), containerRH.key()+"_ESD", &data).isFailure()){
                 ATH_MSG_WARNING( "Collection " << containerRH.key() << " not found in SG "  );
              }else{
                 ATH_MSG_DEBUG( dataTypeName() << " (" << containerRH.key() << ") CaloCluster retrieved"  );
              }
            }
          }
        }
      }
    }else {
      //obtain all collections with keys provided by user: m_otherKeys
      for (const auto& key : m_otherKeys) {
        if (key!=m_sgKeyFavourite.key()) {
          ATH_MSG_DEBUG( "Trying to retrieve selected " << dataTypeName() << " (" << key << ")"  );
          SG::ReadHandle<xAOD::CaloClusterContainer> containerRH(key);
          if (!containerRH.isValid()) {
            ATH_MSG_DEBUG( "Unable to retrieve CaloCluster collection " << key );
          } else {
            DataMap data = getData(&*containerRH);
            if ( FormatTool->AddToEvent(dataTypeName(), containerRH.key()+"_ESD", &data).isFailure()){
               ATH_MSG_WARNING( "Collection " << containerRH.key() << " not found in SG "  );
            }else{
               ATH_MSG_DEBUG( dataTypeName() << " (" << containerRH.key() << ") retrieved"  );
            }
          }
        }
      }
    }
    //All collections 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_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_doWriteHLT

bool JiveXML::CaloClusterRetriever::m_doWriteHLT

private

Definition at line 56 of file CaloClusterRetriever.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_otherKeys

std::vector<std::string> JiveXML::CaloClusterRetriever::m_otherKeys

private

Definition at line 55 of file CaloClusterRetriever.h.

m_sgKeyFavourite

SG::ReadHandleKey<xAOD::CaloClusterContainer> JiveXML::CaloClusterRetriever::m_sgKeyFavourite {this, "StoreGateKey", "egammaClusters", "Name of the CaloClusterContainer"}

private

Definition at line 54 of file CaloClusterRetriever.h.

{this, "StoreGateKey", "egammaClusters", "Name of the CaloClusterContainer"};

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:

• CaloClusterRetriever.h
• CaloClusterRetriever.cxx