CaloCellDumper Class Reference

#include <CaloCellDumper.h>

Inheritance diagram for CaloCellDumper:

Collaboration diagram for CaloCellDumper:

Public Member Functions
	CaloCellDumper (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
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
std::ofstream	m_outfile
std::ifstream	m_reffile
SG::ReadHandleKey< CaloCellContainer >	m_key {this,"InputContainer","AllCalo","Input CaloCellContainer key"}
Gaudi::Property< std::string >	m_fileName {this,"FileName","CaloCells.txt","Name of the output text file"}
Gaudi::Property< std::string >	m_refName {this,"RefName","","Name of reference file to which cells are to be compared."}
Gaudi::Property< float >	m_eCut {this,"EnergyCut",std::numeric_limits<float>::lowest(),"Energy cut for cell dumping"}
Gaudi::Property< bool >	m_compact {this,"Compact",true,"compact or detailed cell identifer"}
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 15 of file CaloCellDumper.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CaloCellDumper()

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

Definition at line 23 of file CaloCellDumper.cxx.

                                                                                :
  AthAlgorithm(name,pSvcLocator) {}

Member Function Documentation

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 CaloCellDumper::execute ( )

overridevirtual

Definition at line 62 of file CaloCellDumper.cxx.

                                   {
 
  bool badCompare = false;
  const EventContext& ctx = getContext();
  
  SG::ReadHandle<CaloCellContainer> cells{m_key,ctx};
  
  const unsigned evt=ctx.eventID().event_number();
  m_outfile << "Event " << evt << " contains " << cells->size() << " CaloCells" << std::endl;
  m_outfile << "ID\tEnergy\tTime\tQual\tprov" << std::endl;
 
  if (m_reffile.is_open()) {
    std::string Event, contains, CaloCells;
    size_t evt_in, cells_size_in;
    m_reffile >> Event >> evt_in >> contains >> cells_size_in >> CaloCells;
    if (!m_reffile.good() || evt_in != evt || cells_size_in != cells->size())
    {
      ATH_MSG_ERROR ("Reference file miscompare.  Read: " <<
                     Event << " " << evt_in << " " << contains << " "
                     << cells_size_in << " " << CaloCells <<
                     "; expected event number " << evt << " and cell count " <<
                     cells->size());
      badCompare = true;
    }
 
    std::string ID, Energy, Time, Qual, prov;
    m_reffile >> ID >> Energy  >> Time >> Qual >> prov;
    if (!m_reffile.good()) {
      ATH_MSG_ERROR ("Bad read of reference file header: " <<
                     ID  << " " << Energy << " " << Time << " " <<
                     Qual << " " << prov);
      badCompare = true;
    }
  }
 
  double remainingEne=0;
  unsigned nRemaining=0;
 
  for (const auto *cell : *cells) {
    if (cell->e()>m_eCut.value()) {
      std::stringstream id;
      if (!m_compact.value()) {
    const CaloDetDescrElement* dde=cell->caloDDE();
    if (dde->is_lar_em_barrel()) {
      id << "LAr Bar";
    }
    else if (dde->is_lar_em_endcap_inner()){
      id << "LAR ECI";
    }
    else if (dde->is_lar_em_endcap_outer()){
      id << "LAR ECO";
    }
    else if (dde->is_lar_hec()) {
      id << "LAr_HEC";
    }
    else if (dde->is_lar_fcal()) {
      id << "LAr_FCAL";
    }
    else if (dde->is_tile()) {
      id << "TILE    ";
    }
    else {
      id << "UNKNOWN";
    }
    id << ", samp=" << dde->getSampling() << ", ";
      }
     
      m_outfile << id.str() << "0x" << std::hex << cell->ID().get_identifier32().get_compact() << std::dec 
      //m_outfile << 
        << "\t" << cell->e() << "\t" << cell->time() << "\t" << cell->gain() 
        << "\t" << cell->quality() << "\t0x" << std::hex << cell->provenance() << std::dec << std::endl;
      if (m_reffile.is_open()) {
        unsigned id_in;
        float energy_in, time_in;
        int quality_in, provenance_in, gain_in;
        if (!m_compact) {
          std::string id, samp;
          m_reffile >> id >> samp;
        }
        m_reffile >> std::hex >> id_in >> std::dec >> energy_in >> time_in >>
          gain_in >> quality_in >> std::hex >> provenance_in >> std::dec;
        if (!m_reffile.good() ||
            !isEqual (energy_in, cell->e(), 1e-5) ||
            !isEqual (time_in, cell->time(), 1e-5) ||
            id_in != cell->ID().get_identifier32().get_compact() ||
            gain_in != cell->gain() ||
            quality_in != cell->quality() ||
            provenance_in != cell->provenance())
        {
          ATH_MSG_ERROR ("Bad read of reference file: " <<
                         std::hex << "0x" << id_in << " " << std::dec <<
                         energy_in << " "
                         << time_in << " " <<
                         gain_in << " " << quality_in << " " <<
                         std::hex << "0x" << provenance_in << std::dec);
          ATH_MSG_ERROR ("Expected " << id.str() << "0x" << std::hex <<
                         cell->ID().get_identifier32().get_compact() << std::dec << " " <<
                         cell->e() << " " << cell->time() << " "
                         << cell->gain() << " " <<
                         cell->quality() << " 0x" << std::hex << cell->provenance() << std::dec);
          badCompare = true;
        }
      }
    }
    else {//not bigger that m_eCut
      ++nRemaining;
      remainingEne+=cell->e();
    }
  }
  if (nRemaining) {
    m_outfile << "Sum of " << nRemaining << " cell energies: " << remainingEne << std::endl;
    if (m_reffile.is_open()) {
      std::string Sum, Of, Cell, Energies;
      unsigned nRemaining_in;
      float remainingEne_in;
      m_reffile >> Sum >> Of >> nRemaining_in >> Cell >> Energies >>
        remainingEne_in;
      if (!m_reffile.good() ||
          nRemaining_in != nRemaining ||
          !isEqual (remainingEne_in, remainingEne))
      {
        ATH_MSG_ERROR ("Bad read of reference file: " <<
                       Sum << Of << nRemaining_in << Cell << Energies <<
                       remainingEne_in);
        ATH_MSG_ERROR ("Expected: " <<
                       "Sum of " << nRemaining << " cell energies: " << remainingEne);
        badCompare = true;
      }
    }
  }
  if (badCompare) {
    ATH_MSG_ERROR ("Reference file miscompare");
    return StatusCode::FAILURE;
  }
  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 CaloCellDumper::finalize ( )

overridevirtual

Definition at line 52 of file CaloCellDumper.cxx.

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

initialize()

StatusCode CaloCellDumper::initialize ( )

overridevirtual

Definition at line 27 of file CaloCellDumper.cxx.

                                      {
  ATH_CHECK(m_key.initialize());
  m_outfile.open(m_fileName,std::ios::out);
 
  if (!m_outfile.good()) {
    ATH_MSG_ERROR("Failed to open output text file " << m_fileName);
    return StatusCode::FAILURE;
  }
 
  if (!m_refName.value().empty()) {
    m_reffile.open(m_refName, std::ios::in);
    if (!m_reffile.good()) {
      ATH_MSG_ERROR("Failed to open reference file " << m_refName);
      return StatusCode::FAILURE;
    }
    else {
      ATH_MSG_INFO("Using reference file " << m_refName.value());
    }
  }
 
  ATH_MSG_INFO("Cell energy cut=" << m_eCut.value());
  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_compact

Gaudi::Property<bool> CaloCellDumper::m_compact {this,"Compact",true,"compact or detailed cell identifer"}

private

Definition at line 32 of file CaloCellDumper.h.

{this,"Compact",true,"compact or detailed cell identifer"};

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_eCut

Gaudi::Property<float> CaloCellDumper::m_eCut {this,"EnergyCut",std::numeric_limits<float>::lowest(),"Energy cut for cell dumping"}

private

Definition at line 31 of file CaloCellDumper.h.

{this,"EnergyCut",std::numeric_limits<float>::lowest(),"Energy cut for cell dumping"};

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_fileName

Gaudi::Property<std::string> CaloCellDumper::m_fileName {this,"FileName","CaloCells.txt","Name of the output text file"}

private

Definition at line 29 of file CaloCellDumper.h.

{this,"FileName","CaloCells.txt","Name of the output text file"};

m_key

SG::ReadHandleKey<CaloCellContainer> CaloCellDumper::m_key {this,"InputContainer","AllCalo","Input CaloCellContainer key"}

private

Definition at line 28 of file CaloCellDumper.h.

{this,"InputContainer","AllCalo","Input CaloCellContainer key"};

m_outfile

std::ofstream CaloCellDumper::m_outfile

private

Definition at line 26 of file CaloCellDumper.h.

m_reffile

std::ifstream CaloCellDumper::m_reffile

private

Definition at line 27 of file CaloCellDumper.h.

m_refName

Gaudi::Property<std::string> CaloCellDumper::m_refName {this,"RefName","","Name of reference file to which cells are to be compared."}

private

Definition at line 30 of file CaloCellDumper.h.

{this,"RefName","","Name of reference file to which cells are to be compared."};

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:

• CaloCellDumper.h
• CaloCellDumper.cxx