ClusterDumper Class Reference

#include <ClusterDumper.h>

Inheritance diagram for ClusterDumper:

Collaboration diagram for ClusterDumper:

Public Member Functions
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
virtual StatusCode	finalize ()
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Delegate algorithm constructor.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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_containerName {this,"ContainerName","CaloCalTopoClusters"}
	The key for the output xAOD::CaloClusterContainer.
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EvtInfo", "EventInfo", "EventInfo name"}
Gaudi::Property< std::string >	m_fileName {this,"FileName",{}}
Gaudi::Property< bool >	m_printCellLinks {this,"PrintCellLinks",true}
Gaudi::Property< bool >	m_reducedPrecision
std::ostream *	m_out =&std::cout
std::ofstream	m_fileOut
std::mutex	m_fileMutex
DataObjIDColl	m_extendedExtraObjects
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

Definition at line 21 of file ClusterDumper.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Delegate algorithm constructor.

Definition at line 51 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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; }

execute()

StatusCode ClusterDumper::execute ( )

virtual

Function executing the algorithm.

Definition at line 46 of file ClusterDumper.cxx.

                                  {
 
 
  SG::ReadHandle<xAOD::EventInfo> eventInfo (m_eventInfoKey);
  
  SG::ReadHandle<xAOD::CaloClusterContainer> clustercontainer{m_containerName};
  ATH_MSG_DEBUG( "Retrieved clusters with key: " << m_containerName.key() );
 
  const CaloClusterCellLinkContainer* cclptr=nullptr;
  if (evtStore()->contains<CaloClusterCellLinkContainer>(m_containerName.key()+"_links")) {
    CHECK(evtStore()->retrieve(cclptr,m_containerName.key()+"_links"));
    ATH_MSG_INFO("Found corresponding cell-link container with size " << cclptr->size());
  }
  else
    ATH_MSG_INFO("Did not find corresponding cell-link container");
 
  std::lock_guard<std::mutex> fileLock{m_fileMutex};
  (*m_out) << "Run " << eventInfo->runNumber() << ", evt " << eventInfo->eventNumber() << " contains " << clustercontainer->size() << " CaloClusters" << std::endl;
 
  for (const auto itr: *clustercontainer) {
    const xAOD::CaloCluster& cluster=*itr;
    (*m_out) << "Kinematics :" << std::endl;
    if (m_reducedPrecision) {
      *m_out << std::format ("E={:.0f}, eta={}, phi={}, m={}, pt={:.1f}",
                             cluster.e(), cluster.eta(), cluster.phi(),
                             cluster.m(), cluster.pt())
             << std::endl;
    }
    else {
      *m_out << std::format ("E={}, eta={}, phi={}, m={}, pt={}",
                             cluster.e(), cluster.eta(), cluster.phi(),
                             cluster.m(), cluster.pt())
             << std::endl;
    }
    (*m_out) << "Eta0=" << cluster.eta0() << ", Phi0=" << cluster.phi0() << std::endl;
 
    (*m_out) << "TLorentzVector :" << std::endl;
    const xAOD::CaloCluster::FourMom_t& p4=cluster.p4();
    if (m_reducedPrecision) {
      double mass = p4.M();
      if (std::abs(mass) < 1e-2) mass = 0;
      *m_out << std::format (" p4.E={:.0f}, x={:.0f}, y={:.0f}, z={:.0f}, m={:.2f}, pt={:.1f}",
                             p4.E(), p4.X(), p4.Y(), p4.Z(), mass, p4.Pt())
             << std::endl;
    }
    else {
      *m_out << std::format (" p4.E={}, x={}, y={}, z={}, m={}, pt={}",
                             p4.E(), p4.X(), p4.Y(), p4.Z(), p4.M(), p4.Pt())
             << std::endl;
    }
 
    (*m_out) << "Sampling variables :" << std::endl;
    for (unsigned iSamp=0;iSamp<CaloSampling::Unknown;++iSamp) {
    xAOD::CaloCluster_v1::CaloSample s=(CaloSampling::CaloSample)iSamp;
    if (cluster.hasSampling(s)) {
      (*m_out) << "  Sampling #" << s << ": E=" <<  cluster.eSample(s) << ", eta=" << cluster.etaSample(s) << ", phi=" << cluster.phiSample(s) << std::endl;
    }
      }
      
    
 
    //(*m_out) << "Auxiliary variables: " << std::endl;
    // const SG::auxid_set_t& auxIds=cluster.container()->getAuxIDs(); //->getDynamicAuxIDs();
    // const size_t idx= cluster.index();
    // for (auto ai: auxIds) {
    //   const std::string& auxName=SG::AuxTypeRegistry::instance().getName(ai);
    //   const std::type_info* ti=SG::AuxTypeRegistry::instance().getType (ai);
    //   if ((*ti)==typeid(float)) {
    //  const float v=clustercontainer->getData<float>(ai,idx);
    //  (*m_out) << "  Index=" <<idx << ", Auxid=" << ai << ", Name=" << auxName << " value=" << v << std::endl;
    //   }
    //   else
    //  (*m_out) << "  Index=" <<idx << ", Auxid=" << ai << ", Name=" << auxName << ", unknown type" << ti->name() << std::endl;
    // }
 
    constexpr auto allMoments=std::to_array<const char*>({"FIRST_PHI","FIRST_ETA","SECOND_R","SECOND_LAMBDA","DELTA_PHI","DELTA_THETA","DELTA_ALPHA","CENTER_X","CENTER_Y","CENTER_Z","CENTER_MAG","CENTER_LAMBDA","LATERAL","LONGITUDINAL","ENG_FRAC_EM","ENG_FRAC_MAX","ENG_FRAC_CORE","FIRST_ENG_DENS","SECOND_ENG_DENS","ISOLATION","ENG_BAD_CELLS","N_BAD_CELLS","N_BAD_CELLS_CORR","BAD_CELLS_CORR_E","BADLARQ_FRAC","ENG_POS","SIGNIFICANCE.3","CELL_SIGNIFICANCE.3","CELL_SIG_SAMPLING","AVG_LAR_Q","AVG_TILE_Q","EM_PROBABILITY","HAD_WEIGHT","OOC_WEIGHT","DM_WEIGHT.3","TILE_CONFIDENCE_LEVEL","VERTEX_FRACTION","NVERTEX_FRACTION","ENG_CALIB_TOT","ENG_CALIB_OUT_L","ENG_CALIB_OUT_M","ENG_CALIB_OUT_T","ENG_CALIB_DEAD_L","ENG_CALIB_DEAD_M","ENG_CALIB_DEAD_T","ENG_CALIB_EMB0","ENG_CALIB_EME0","ENG_CALIB_TILEG3","ENG_CALIB_DEAD_TOT","ENG_CALIB_DEAD_EMB0","ENG_CALIB_DEAD_TILE0","ENG_CALIB_DEAD_TILEG3","ENG_CALIB_DEAD_EME0","ENG_CALIB_DEAD_HEC0","ENG_CALIB_DEAD_FCAL","ENG_CALIB_DEAD_LEAKAGE","ENG_CALIB_DEAD_UNCLASS","ENG_CALIB_FRAC_EM","ENG_CALIB_FRAC_HAD","ENG_CALIB_FRAC_REST", "ENERGY_Truth"});
    (*m_out) << "Cluster Moments" << std::endl;
    for (std::string momName : allMoments) {
      int precision = 0;
      std::string::size_type dpos = momName.find ('.');
      if (dpos != std::string::npos) {
        precision = std::stoi (momName.substr (dpos+1));
        momName.erase (dpos, std::string::npos);
      }
      SG::AuxElement::Accessor<float> a(momName);
      if (a.isAvailable(cluster)) {
        float v = a(cluster);
        if (m_reducedPrecision && precision > 0) {
          *m_out << std::format ("   {}: {:.{}f}", momName, v, precision) << std::endl;
        }
        else {
          (*m_out) << "   " << momName << ": " << v << std::endl;
        }
      }
    }
 
    SG::AuxElement::Accessor<xAOD::CaloClusterBadChannelList> a("BadChannelList");
    if (a.isAvailable(cluster)) {
      (*m_out) << "Bad Channel data: " << std::endl;
      for (const auto& bc : cluster.badChannelList()) {
        (*m_out) << "   eta=" << bc.eta() << ", phi=" << bc.phi() << ", layer=" << bc.layer() << ", word=" << bc.badChannel() << std::endl;
      }
    }
 
    const CaloClusterCellLink* cellLinks = cluster.getCellLinks();
    if (cellLinks) {
      if (m_printCellLinks) {
        (*m_out) << "Cell-links:" << std::endl;
        CaloClusterCellLink::const_iterator lnk_it = cellLinks->begin();
        CaloClusterCellLink::const_iterator lnk_it_e = cellLinks->end();
        for (; lnk_it != lnk_it_e; ++lnk_it) {
          const CaloCell* cell = *lnk_it;
          if (m_reducedPrecision) {
            *m_out << std::format ("   ID={}, E={:.2f}, weight={:.3f}",
                                   cell->ID().getString(), cell->e(), lnk_it.weight())
                   << std::endl;
          }
          else {
            *m_out << std::format ("   ID={}, E={}, weight={}",
                                   cell->ID().getString(), cell->e(), lnk_it.weight())
                   << std::endl;
          }
        }
      } else 
       (*m_out) << "  Nbr of cells: " << cellLinks->size() << std::endl;
    } else {
       (*m_out) << "  No Cell Links found" << std::endl; 
    }
 
  }//end loop over clusters
  
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

finalize()

StatusCode ClusterDumper::finalize ( )

virtual

Definition at line 39 of file ClusterDumper.cxx.

                                   {
  if (m_fileOut.is_open()) {
    m_fileOut.close();
  }
   return StatusCode::SUCCESS;
}

initialize()

StatusCode ClusterDumper::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 14 of file ClusterDumper.cxx.

                                     {
  ATH_MSG_INFO( "Initializing" );
 
  std::lock_guard<std::mutex> fileLock{m_fileMutex};
  if (!m_fileName.empty()) {
    m_fileOut.open(m_fileName);
    if (m_fileOut.is_open()) {
      m_out=&m_fileOut;
      ATH_MSG_INFO("Writing to file " << m_fileName);
    }
    else {
      msg(MSG::ERROR) << "Failed to open file " << m_fileName << endmsg;
      return StatusCode::FAILURE;
    }
  }
  else {
    ATH_MSG_INFO("Writing to stdout");
  }
 
  ATH_CHECK(m_eventInfoKey.initialize());
  ATH_CHECK(m_containerName.initialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_containerName

SG::ReadHandleKey<xAOD::CaloClusterContainer> ClusterDumper::m_containerName {this,"ContainerName","CaloCalTopoClusters"}

private

The key for the output xAOD::CaloClusterContainer.

Definition at line 38 of file ClusterDumper.h.

{this,"ContainerName","CaloCalTopoClusters"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> ClusterDumper::m_eventInfoKey {this, "EvtInfo", "EventInfo", "EventInfo name"}

private

Definition at line 39 of file ClusterDumper.h.

{this, "EvtInfo", "EventInfo", "EventInfo name"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_fileMutex

std::mutex ClusterDumper::m_fileMutex

private

Definition at line 49 of file ClusterDumper.h.

m_fileName

Gaudi::Property<std::string> ClusterDumper::m_fileName {this,"FileName",{}}

private

Definition at line 41 of file ClusterDumper.h.

{this,"FileName",{}};

m_fileOut

std::ofstream ClusterDumper::m_fileOut

private

Definition at line 47 of file ClusterDumper.h.

m_out

std::ostream* ClusterDumper::m_out =&std::cout

private

Definition at line 46 of file ClusterDumper.h.

m_printCellLinks

Gaudi::Property<bool> ClusterDumper::m_printCellLinks {this,"PrintCellLinks",true}

private

Definition at line 42 of file ClusterDumper.h.

{this,"PrintCellLinks",true};

m_reducedPrecision

Gaudi::Property<bool> ClusterDumper::m_reducedPrecision

private

Initial value:

{this,"ReducedPrecision",false,
  "If true, use less precision in the output, to reduce exposure to FP rounding issues when comparing with a reference."}

Definition at line 43 of file ClusterDumper.h.

                                        {this,"ReducedPrecision",false,
  "If true, use less precision in the output, to reduce exposure to FP rounding issues when comparing with a reference."};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• ClusterDumper.h
• ClusterDumper.cxx