Class definition for the ZDC Reconstruction class. More...

#include <ZdcRec.h>

Inheritance diagram for ZdcRec:

Collaboration diagram for ZdcRec:

Public Member Functions
	ZdcRec (const std::string &name, ISvcLocator *pSvcLocator)
	~ZdcRec ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
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
ServiceHandle< StoreGateSvc >	m_storeGate
	class member version of retrieving StoreGate
int	m_ownPolicy
	Does the collection own it's objects ?
std::string	m_digitsContainerName
	Digits data container name.
std::string	m_rawContainerName
	Raw data object name.
const ZdcDigitsCollection *	m_digitsCollection
	Pointer to Zdc input "digits" data.
ZdcRawChannelCollection *	m_rawCollection
	Pointer to Zdc output "raw" reconstructed data.
int	m_eventCount
bool	m_complainContain
bool	m_complainRetrieve
ToolHandle< ZdcRecChannelTool >	m_ChannelTool
ToolHandle< ZdcRecNoiseTool >	m_NoiseTool
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

Class definition for the ZDC Reconstruction class.

Author: Brian Cole and Peter Steinberg, bcole.nosp@m.@cer.nosp@m.n.ch, peter.nosp@m..ste.nosp@m.inber.nosp@m.g@bn.nosp@m.l.gov and M. Leite leite.nosp@m.@cer.nosp@m.n.ch

Definition at line 48 of file ZdcRec.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

◆ ZdcRec()

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

Definition at line 25 of file ZdcRec.cxx.

                                                              :
 
    AthAlgorithm(name, pSvcLocator),
    m_storeGate("StoreGateSvc", name),
    m_ownPolicy(static_cast<int> (SG::OWN_ELEMENTS)),
    m_digitsContainerName("ZdcDigitsCollection"),
    m_rawContainerName("ZdcRawChannelCollection"),
    m_digitsCollection(nullptr),
    m_rawCollection(nullptr),
    m_eventCount(0),
    m_complainContain(1),
    m_complainRetrieve(1),
        m_ChannelTool("ZdcRecChannelTool"),
        m_NoiseTool("ZdcRecNoiseTool")
 
{
    declareProperty("OwnPolicy",m_ownPolicy) ;
 
    declareProperty("DigitsContainerName", m_digitsContainerName, "ZdcDigitsCollection");
 
    declareProperty("RawContainerName",    m_rawContainerName,    "ZdcRawChannelCollection");
}

◆ ~ZdcRec()

ZdcRec::~ZdcRec ( )

Definition at line 50 of file ZdcRec.cxx.

50{}

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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode ZdcRec::execute ( )

Definition at line 101 of file ZdcRec.cxx.

{
 
  ZdcRawChannelCollection::iterator iter;
  int ncha = 0;
 
  MsgStream mLog(msgSvc(), name());
    mLog << MSG::DEBUG
         << "--> ZDC: ZdcRec execute starting on "
         << m_eventCount
         << "th event"
         << endmsg;
 
    m_eventCount++;
 
    //Look for the container presence
    bool dg = m_storeGate->contains<ZdcDigitsCollection>( m_digitsContainerName);
    if (!dg) {
      if (m_complainContain) mLog << MSG::WARNING << "--> ZDC: StoreGate does not contain " << m_digitsContainerName << endmsg;
      m_complainContain = 0;
      return StatusCode::SUCCESS;
    }
 
    // Look up the Digits "ZdcDigitsCollection" in Storegate
    StatusCode digitsLookupSC = m_storeGate->retrieve(m_digitsCollection, m_digitsContainerName);
    if (digitsLookupSC.isFailure())
    {
      if (m_complainRetrieve)
        mLog << MSG::WARNING
         << "--> ZDC: Could not retrieve "
         << m_digitsContainerName
         << " from StoreGate"
         << endmsg;
      m_complainRetrieve = 0;
      return StatusCode::SUCCESS;
    }
 
    if (digitsLookupSC.isSuccess() && !m_digitsCollection)
    {
        mLog << MSG::ERROR
             << "--> ZDC: Storegate returned zero pointer for "
             << m_digitsContainerName
             << endmsg;
        return StatusCode::SUCCESS;
    }
 
    //Create the containers to hold the reconstructed information
    m_rawCollection = new ZdcRawChannelCollection (static_cast<SG::OwnershipPolicy>(m_ownPolicy));
    ZdcRawChannelCollection tmpCollection  (static_cast<SG::OwnershipPolicy>(SG::VIEW_ELEMENTS));
 
    ncha = m_ChannelTool->makeRawFromDigits(*m_digitsCollection, tmpCollection);
 
 
    // SG has the ownership of m_rawCollection, and it should be copyed intead of just
    // being passed around.
    for (iter=tmpCollection.begin();iter!=tmpCollection.end();++iter) {
        m_rawCollection->push_back(*iter);
    }
 
    StatusCode sc = evtStore()->record(m_rawCollection, m_rawContainerName,false);
 
    mLog << MSG::DEBUG
         << "--> ZDC: ZdcRawChannelCollection size recorded into SG: "
         << m_rawCollection->size()
         << ".. and from tool " << ncha
         << endmsg;
 
    // For Debugging only
    /*
    ZdcRawChannel *z;
    int i  = 0;
    int ss = 0;
    for (iter=m_rawCollection->begin();iter!=m_rawCollection->end();iter++) {
        i++;
        z = *iter;
        ss = z->getSize();
        for (int cc = 0; cc < ss ; cc++) {
            std::cout << "...." << i << "  " << "  " << cc << "E = " <<  z->getEnergy(cc) << " T =  " << z->getTime(cc);
            }
        std::cout << std::endl;
    }
    */
 
 
    if (sc.isFailure())
    {
        mLog << MSG::WARNING
                << "execute() : cannot record Container "
                << m_rawContainerName
                << endmsg;
 
        return StatusCode::SUCCESS;
    }
 
    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 ZdcRec::finalize ( )

Definition at line 201 of file ZdcRec.cxx.

{
  MsgStream mLog(msgSvc(),name());
 
  mLog << MSG::INFO
          << "--> ZDC: ZdcRec finalize complete"
          << endmsg;
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ZdcRec::initialize ( )

Definition at line 54 of file ZdcRec.cxx.

{
    MsgStream mLog(msgSvc(), name());
 
    // Look up the Storegate service
    StatusCode sc = m_storeGate.retrieve();
    if (sc.isFailure())
    {
        mLog << MSG::FATAL << "--> ZDC: Unable to retrieve pointer to StoreGateSvc" << endmsg;
        return sc;
    }
 
 
    // Reconstruction Tool
    StatusCode scTool = m_ChannelTool.retrieve();
    if (scTool.isFailure())
    {
        mLog << MSG::WARNING << "--> ZDC: Could not retrieve " << m_ChannelTool << endmsg;
        return StatusCode::FAILURE;
    }
    mLog << MSG::INFO << "--> ZDC: SUCCESS retrieving " << m_ChannelTool << endmsg;
 
    // Noise and Pedestal Tool
    scTool = m_NoiseTool.retrieve();
    if (scTool.isFailure())
    {
        mLog << MSG::WARNING << "--> ZDC: Could not retrieve " << m_NoiseTool << endmsg;
        return StatusCode::FAILURE;
    }
    mLog << MSG::INFO << "--> ZDC: SUCCESS retrieving " << m_NoiseTool << endmsg;
 
    // Container output name
    //TODO: change MESSAGE !!
    mLog << MSG::INFO << " Output Container Name " << m_rawContainerName << endmsg;
    if (m_ownPolicy == SG::OWN_ELEMENTS)
        mLog << MSG::INFO << "...will OWN its cells." << endmsg;
    else
        mLog << MSG::INFO << "...will VIEW its cells." << endmsg;
 
 
    mLog << MSG::INFO  << "--> ZDC: ZdcRec initialization complete" << endmsg;
 
    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_ChannelTool

ToolHandle<ZdcRecChannelTool> ZdcRec::m_ChannelTool

private

Definition at line 89 of file ZdcRec.h.

◆ m_complainContain

bool ZdcRec::m_complainContain

private

Definition at line 83 of file ZdcRec.h.

◆ m_complainRetrieve

bool ZdcRec::m_complainRetrieve

private

Definition at line 84 of file ZdcRec.h.

◆ 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_digitsCollection

const ZdcDigitsCollection* ZdcRec::m_digitsCollection

private

Pointer to Zdc input "digits" data.

Definition at line 77 of file ZdcRec.h.

◆ m_digitsContainerName

std::string ZdcRec::m_digitsContainerName

private

Digits data container name.

Definition at line 71 of file ZdcRec.h.

◆ m_eventCount

int ZdcRec::m_eventCount

private

Definition at line 82 of file ZdcRec.h.

◆ 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_NoiseTool

ToolHandle<ZdcRecNoiseTool> ZdcRec::m_NoiseTool

private

Definition at line 90 of file ZdcRec.h.

◆ m_ownPolicy

int ZdcRec::m_ownPolicy

private

Does the collection own it's objects ?

Definition at line 68 of file ZdcRec.h.

◆ m_rawCollection

ZdcRawChannelCollection* ZdcRec::m_rawCollection

private

Pointer to Zdc output "raw" reconstructed data.

Definition at line 80 of file ZdcRec.h.

◆ m_rawContainerName

std::string ZdcRec::m_rawContainerName

private

Raw data object name.

Definition at line 74 of file ZdcRec.h.

◆ m_storeGate

ServiceHandle<StoreGateSvc> ZdcRec::m_storeGate

private

class member version of retrieving StoreGate

Definition at line 64 of file ZdcRec.h.

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ZdcRec()

◆ ~ZdcRec()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_ChannelTool

◆ m_complainContain

◆ m_complainRetrieve

◆ m_detStore

◆ m_digitsCollection

◆ m_digitsContainerName

◆ m_eventCount

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_NoiseTool

◆ m_ownPolicy

◆ m_rawCollection

◆ m_rawContainerName

◆ m_storeGate

◆ m_varHandleArraysDeclared

◆ m_vhka