Class definition for the ZDC decoder class for Run 3 This class is responsible for taking the ZdcLucrodData and rendering them as ZdcModules for subsequent steps, and for defining the two output ZdcModuleContainers. More...

#include <ZdcRecRun3Decode.h>

Inheritance diagram for ZdcRecRun3Decode:

Collaboration diagram for ZdcRecRun3Decode:

Public Member Functions
	ZdcRecRun3Decode (const std::string &name, ISvcLocator *pSvcLocator)
	~ZdcRecRun3Decode ()
StatusCode	initialize () override
StatusCode	execute () override
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
int	m_ownPolicy
Gaudi::Property< unsigned int >	m_nFragments {this,"NFragments",6,"Number of expected LUCROD fragments"}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this,"EventInfoKey","EventInfo"}
SG::WriteDecorHandleKey< xAOD::EventInfo >	m_eventInfoDecorKey {this, "eventInfoDecorKey", m_eventInfoKey, "forwardDetFlags", "Key for EventInfo decoration object"}
SG::ReadHandleKey< ZdcLucrodDataContainer >	m_zldContainerName { this, "ZdcLucrodDataContainerKey", "ZdcLucrodDataContainer", "" }
SG::WriteHandleKey< xAOD::ZdcModuleContainer >	m_zdcModuleContainerName { this, "ZdcModuleContainerName", "ZdcModules", "" }
SG::WriteHandleKey< xAOD::ZdcModuleContainer >	m_zdcSumContainerName { this, "ZdcSumContainerName", "ZdcSums", "" }
ToolHandle< ZdcRecChannelToolLucrod >	m_ChannelTool { this, "ChannelTool", "ZdcRecChannelToolLucrod", "" }
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 decoder class for Run 3 This class is responsible for taking the ZdcLucrodData and rendering them as ZdcModules for subsequent steps, and for defining the two output ZdcModuleContainers.

Author: Brian Cole and Peter Steinberg, bcole.nosp@m.@cer.nosp@m.n.ch, stein.nosp@m.berg.nosp@m.@bnl..nosp@m.gov

Definition at line 42 of file ZdcRecRun3Decode.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

◆ ZdcRecRun3Decode()

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

Definition at line 30 of file ZdcRecRun3Decode.cxx.

                                                                                  :
 
    AthAlgorithm(name, pSvcLocator),
    m_ownPolicy(static_cast<int> (SG::OWN_ELEMENTS))
{
  declareProperty("OwnPolicy",m_ownPolicy) ;
}

◆ ~ZdcRecRun3Decode()

ZdcRecRun3Decode::~ZdcRecRun3Decode ( )

Definition at line 41 of file ZdcRecRun3Decode.cxx.

41{}

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

override

Definition at line 73 of file ZdcRecRun3Decode.cxx.

{
 
  ATH_MSG_DEBUG("In ZdRecRun3");
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  ATH_MSG_DEBUG ("--> ZDC: ZdcRecRun3Decode execute starting on "
                 << ctx.evt()
                 << "th event");
 
  //Look for the container presence
  if (m_zldContainerName.empty()) {
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_DEBUG("Trying to get LUCROD DATA!");
  SG::ReadHandle<ZdcLucrodDataContainer> zldContainer    (m_zldContainerName, ctx);
  ATH_MSG_DEBUG("Did I get LUCROD DATA?");
 
  if (zldContainer->size() < m_nFragments)
    {
      int zdcLucrod = 0;
      int rpdLucrod = 0;
      for (auto zld : *zldContainer)
    {
      uint32_t lucrod_id =  zld->GetLucrodID();
      if (lucrod_id == ZdcEventInfo::LucrodLowGain || lucrod_id == ZdcEventInfo::LucrodHighGain) // ZDC LUCRODs
        {
          zdcLucrod++;
        }
      else if (lucrod_id == ZdcEventInfo::LucrodRPD1A
           || lucrod_id == ZdcEventInfo::LucrodRPD1C
           || lucrod_id == ZdcEventInfo::LucrodRPD2A
           || lucrod_id == ZdcEventInfo::LucrodRPD2C)
        {
          rpdLucrod++;
        }
      else
        {
          ATH_MSG_WARNING("Unidentified LUCROD ID = " << lucrod_id);
        }
    }
      SG::ReadHandle<xAOD::EventInfo> eventInfo (m_eventInfoKey);
      if (!eventInfo->updateErrorState(xAOD::EventInfo::ForwardDet,xAOD::EventInfo::Error))
    {
      ATH_MSG_WARNING( " cannot set EventInfo error state for ForwardDet "  );
    }
      if (!eventInfo->updateEventFlagBit(xAOD::EventInfo::ForwardDet,ZdcEventInfo::DECODINGERROR)) 
    {
      ATH_MSG_WARNING( " cannot set flag bit for ForwardDet "  );      
    }
      if (rpdLucrod < ZdcEventInfo::nTotalRpdLucrod)
    {
      if (!eventInfo->updateEventFlagBit(xAOD::EventInfo::ForwardDet,ZdcEventInfo::RPDDECODINGERROR)) 
        {
          ATH_MSG_WARNING( " cannot set RPDDECODINGERROR flag bit for ForwardDet "  );      
        }
    }
      if (zdcLucrod < ZdcEventInfo::nTotalZdcLucrod)
    {
      if (!eventInfo->updateEventFlagBit(xAOD::EventInfo::ForwardDet,ZdcEventInfo::ZDCDECODINGERROR)) 
        {
          ATH_MSG_WARNING( " cannot set ZDCDECODINGERROR flag bit for ForwardDet "  );      
        }
    }
    }
 
  //Create the containers to hold the reconstructed information (you just pass the pointer and the converter does the work) 
  std::unique_ptr<xAOD::ZdcModuleContainer> moduleContainer( new xAOD::ZdcModuleContainer());
  std::unique_ptr<xAOD::ZdcModuleAuxContainer> moduleAuxContainer( new xAOD::ZdcModuleAuxContainer() );
  moduleContainer->setStore( moduleAuxContainer.get() );
 
  //Create the containers to hold the reconstructed information (you just pass the pointer and the converter does the work) 
  std::unique_ptr<xAOD::ZdcModuleContainer> moduleSumContainer( new xAOD::ZdcModuleContainer());
  std::unique_ptr<xAOD::ZdcModuleAuxContainer> moduleSumAuxContainer( new xAOD::ZdcModuleAuxContainer() );
  moduleSumContainer->setStore( moduleSumAuxContainer.get() );
 
  ATH_MSG_DEBUG("Trying to convert!");
 
  // rearrange ZDC channels and perform fast reco on all channels (including non-big tubes)
  int ncha = m_ChannelTool->convertLucrod2ZM(zldContainer.get(), moduleContainer.get(), moduleSumContainer.get() );
  ATH_MSG_DEBUG("m_ChannelTool->convertLucrod2ZM returned " << ncha << " channels");
 
  ATH_MSG_DEBUG("Dumping modules");
  ATH_MSG_DEBUG( ZdcModuleToString(*moduleContainer) );
  ATH_MSG_DEBUG("Dumping module sums");
  ATH_MSG_DEBUG( ZdcModuleToString(*moduleSumContainer) );
  
  // eventually reconstruct RPD, using ML libraries
  // ATH_CHECK( m_rpdTool...)
 
  SG::WriteHandle<xAOD::ZdcModuleContainer> moduleContainerH (m_zdcModuleContainerName, ctx);
  ATH_CHECK( moduleContainerH.record (std::move(moduleContainer),
                      std::move(moduleAuxContainer)) );
 
  SG::WriteHandle<xAOD::ZdcModuleContainer> moduleSumContainerH (m_zdcSumContainerName, ctx);
  ATH_CHECK( moduleSumContainerH.record (std::move(moduleSumContainer),
                     std::move(moduleSumAuxContainer)) );
 
  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 ZdcRecRun3Decode::finalize ( )

override

Definition at line 179 of file ZdcRecRun3Decode.cxx.

{
 
  ATH_MSG_DEBUG( "--> ZDC: ZdcRecRun3Decode finalize complete" );
 
  return StatusCode::SUCCESS;
 
}

◆ initialize()

StatusCode ZdcRecRun3Decode::initialize ( )

override

Definition at line 45 of file ZdcRecRun3Decode.cxx.

{
    MsgStream mLog(msgSvc(), name());
 
    // Reconstruction Tool
    ATH_CHECK( m_ChannelTool.retrieve() );
 
    // Reconstruction Tool
 
    ATH_CHECK( m_zdcModuleContainerName.initialize() );
    ATH_CHECK( m_zdcSumContainerName.initialize() );
    ATH_CHECK( m_zldContainerName.initialize(SG::AllowEmpty) );
    ATH_CHECK( m_eventInfoKey.initialize() );
    ATH_CHECK( m_eventInfoDecorKey.initialize() );
 
    if (m_ownPolicy == SG::OWN_ELEMENTS)
        mLog << MSG::DEBUG << "...will OWN its cells." << endmsg;
    else
        mLog << MSG::DEBUG << "...will VIEW its cells." << endmsg;
 
 
    mLog << MSG::DEBUG << "--> ZDC: ZdcRecRun3Decode 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<ZdcRecChannelToolLucrod> ZdcRecRun3Decode::m_ChannelTool { this, "ChannelTool", "ZdcRecChannelToolLucrod", "" }

private

Definition at line 71 of file ZdcRecRun3Decode.h.

72{ this, "ChannelTool", "ZdcRecChannelToolLucrod", "" };

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

SG::WriteDecorHandleKey<xAOD::EventInfo> ZdcRecRun3Decode::m_eventInfoDecorKey {this, "eventInfoDecorKey", m_eventInfoKey, "forwardDetFlags", "Key for EventInfo decoration object"}

private

Definition at line 60 of file ZdcRecRun3Decode.h.

60{this, "eventInfoDecorKey", m_eventInfoKey, "forwardDetFlags", "Key for EventInfo decoration object"};

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> ZdcRecRun3Decode::m_eventInfoKey {this,"EventInfoKey","EventInfo"}

private

Definition at line 59 of file ZdcRecRun3Decode.h.

59{this,"EventInfoKey","EventInfo"};

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

Gaudi::Property<unsigned int> ZdcRecRun3Decode::m_nFragments {this,"NFragments",6,"Number of expected LUCROD fragments"}

private

Definition at line 57 of file ZdcRecRun3Decode.h.

57{this,"NFragments",6,"Number of expected LUCROD fragments"};

◆ m_ownPolicy

int ZdcRecRun3Decode::m_ownPolicy

private

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

◆ m_zdcModuleContainerName

SG::WriteHandleKey<xAOD::ZdcModuleContainer> ZdcRecRun3Decode::m_zdcModuleContainerName { this, "ZdcModuleContainerName", "ZdcModules", "" }

private

Definition at line 65 of file ZdcRecRun3Decode.h.

66{ this, "ZdcModuleContainerName", "ZdcModules", "" };

◆ m_zdcSumContainerName

SG::WriteHandleKey<xAOD::ZdcModuleContainer> ZdcRecRun3Decode::m_zdcSumContainerName { this, "ZdcSumContainerName", "ZdcSums", "" }

private

Definition at line 68 of file ZdcRecRun3Decode.h.

69{ this, "ZdcSumContainerName", "ZdcSums", "" };

◆ m_zldContainerName

SG::ReadHandleKey<ZdcLucrodDataContainer> ZdcRecRun3Decode::m_zldContainerName { this, "ZdcLucrodDataContainerKey", "ZdcLucrodDataContainer", "" }

private

Definition at line 62 of file ZdcRecRun3Decode.h.

63{ this, "ZdcLucrodDataContainerKey", "ZdcLucrodDataContainer", "" };

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

◆ ZdcRecRun3Decode()

◆ ~ZdcRecRun3Decode()

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_detStore

◆ m_eventInfoDecorKey

◆ m_eventInfoKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_nFragments

◆ m_ownPolicy

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_zdcModuleContainerName

◆ m_zdcSumContainerName

◆ m_zldContainerName