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
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool) override
	Retrieve all the data.
const DataMap	getData (const xAOD::CaloClusterContainer *)
	Retrieve basic parameters, mainly four-vectors.
virtual std::string	dataTypeName () const override
	Return the name of the data type.
virtual StatusCode	initialize () override
	Default AthAlgTool methods.

Private Attributes
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_sgKeyFavourite
Gaudi::Property< std::vector< std::string > >	m_otherKeys
Gaudi::Property< bool >	m_doWriteHLT

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 Function Documentation

dataTypeName()

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

inlineoverridevirtual

Return the name of the data type.

Definition at line 45 of file CaloClusterRetriever.h.

{ return "Cluster"; };

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

overridevirtual

Default AthAlgTool methods.

Definition at line 13 of file CaloClusterRetriever.cxx.

  {
 
    ATH_MSG_DEBUG("Initialising Tool");
 
    ATH_CHECK(m_sgKeyFavourite.initialize());
 
    return StatusCode::SUCCESS;
  }

retrieve()

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

overridevirtual

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

Definition at line 28 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;
  }

Member Data Documentation

m_doWriteHLT

Gaudi::Property<bool> JiveXML::CaloClusterRetriever::m_doWriteHLT

private

Initial value:

{this
    , "DoWriteHLT", false, "Ignore HLTAutokey object by default"}

Definition at line 55 of file CaloClusterRetriever.h.

                                      {this
    , "DoWriteHLT", false, "Ignore HLTAutokey object by default"};

m_otherKeys

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

private

Initial value:

{this
    , "OtherClusterCollections", {}, "Other collections to be retrieved. If list left empty, all available retrieved"}

Definition at line 53 of file CaloClusterRetriever.h.

                                                     {this
    , "OtherClusterCollections", {}, "Other collections to be retrieved. If list left empty, all available retrieved"};

m_sgKeyFavourite

SG::ReadHandleKey<xAOD::CaloClusterContainer> JiveXML::CaloClusterRetriever::m_sgKeyFavourite

private

Initial value:

{this
      , "FavouriteClusterCollection", "egammaClusters", "Collection to be first in output, shown in Atlantis without switching"}

Definition at line 51 of file CaloClusterRetriever.h.

                                                                {this
      , "FavouriteClusterCollection", "egammaClusters", "Collection to be first in output, shown in Atlantis without switching"};

---

The documentation for this class was generated from the following files:

• CaloClusterRetriever.h
• CaloClusterRetriever.cxx