#include <LISAnalysisTool.h>

Inheritance diagram for ZDC::LISAnalysisTool:

Collaboration diagram for ZDC::LISAnalysisTool:

Public Member Functions
	LISAnalysisTool (std::string const &name)
virtual	~LISAnalysisTool () override=default
StatusCode	initialize () override
	Dummy implementation of the initialisation function.
StatusCode	recoZdcModules (xAOD::ZdcModuleContainer const &moduleContainer, xAOD::ZdcModuleContainer const &moduleSumContainer) override
StatusCode	reprocessZdc () override
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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
void	initialize_default ()
LISModuleResults	processLISModule (const xAOD::ZdcModule &module)
LISModuleResults	processModuleData (int side, int channel, const std::vector< unsigned short > &data, unsigned int startSample, unsigned int endSample)
double	getAmplitudeCorrection (int iside, int imod, bool highGain, float fitAmp)
void	setFADCCorrections (unsigned int runNumber)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_init {false}
std::string	m_name
Gaudi::Property< std::string >	m_configuration {this, "Configuration", "default", "Which config to use"}
Gaudi::Property< bool >	m_writeAux {this, "WriteAux", true, "Write auxiliary data"}
Gaudi::Property< std::string >	m_auxSuffix {this, "AuxSuffix", "", "Suffix for aux data names"}
Gaudi::Property< unsigned int >	m_nBaselineStart {this, "BaselineStart", 0, "Start index for baseline calculation"}
Gaudi::Property< unsigned int >	m_nBaselineEnd {this, "BaselineEnd", 5, "End index for baseline calculation"}
std::vector< unsigned int >	m_LEDCalreqIdx
std::vector< unsigned int >	m_LEDBCID
const std::vector< std::string >	m_LEDNames = {"Blue1", "Green", "Blue2"}
const std::vector< std::string >	m_calreqNames = {"CalReq1", "CalReq2", "CalReq3"}
unsigned int	m_numSamples {24}
unsigned int	m_preSample {0}
float	m_deltaTSample {3.125}
unsigned int	m_sampleAnaStart {5}
unsigned int	m_sampleAnaEnd {23}
unsigned int	m_nBaselineSamples {5}
Gaudi::Property< std::string >	m_zdcModuleContainerName {this, "ZdcModuleContainerName", "ZdcModules", "Location of ZDC processed data"}
Gaudi::Property< std::string >	m_zdcSumContainerName {this, "ZdcSumContainerName", "ZdcSums", "Location of ZDC processed sums"}
const xAOD::ZdcModuleContainer *	m_zdcModules {nullptr}
const xAOD::ZdcModuleContainer *	m_zdcSums {nullptr}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfoKey", "EventInfo", "Location of the event info"}
SG::ReadDecorHandleKey< xAOD::ZdcModuleContainer >	m_eventTypeKey {this, "ZdcEventTypeKey", "", "ZDC Event type"}
SG::ReadDecorHandleKey< xAOD::ZdcModuleContainer >	m_robBCIDKey {this, "ROBBCIDKey", "", "BCID from LUCROD ROB headers"}
SG::ReadDecorHandleKey< xAOD::ZdcModuleContainer >	m_DAQModeKey {this, "ZdcDAQModeKey", "", "ZDC DAQ mode"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_ZdcLEDType {this, "ZdcLEDType", "", "ZDC LED Type (0-Blue1, 1-Green, 2-Blue2}"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_LISPresampleADC {this, "LISPresampleADC", "", "LIS presample ADC"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_LISADCSum {this, "LISADCSum", "", "LIS pulse FADC sum"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_LISMaxADC {this, "LISMaxADC", "", "LIS pulse max FADC value"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_LISMaxSample {this, "LISMaxSample", "", "LIS max FADC sample"}
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer >	m_LISAvgTime {this, "LISAvgTime", "", "LIS average time"}
bool	m_doFADCCorr {}
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 48 of file LISAnalysisTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LISAnalysisTool()

ZDC::LISAnalysisTool::LISAnalysisTool ( std::string const & name )

explicit

Definition at line 16 of file LISAnalysisTool.cxx.

                                                      : 
  asg::AsgTool(name),
  m_name(name)
{
#ifndef XAOD_STANDALONE
  declareInterface<IZdcAnalysisTool>(this);
#endif
}

◆ ~LISAnalysisTool()

virtual ZDC::LISAnalysisTool::~LISAnalysisTool ( )

overridevirtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

◆ getAmplitudeCorrection()

double ZDC::LISAnalysisTool::getAmplitudeCorrection	(	int	iside,
		int	imod,
		bool	highGain,
		float	fitAmp )

private

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode ZDC::LISAnalysisTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 25 of file LISAnalysisTool.cxx.

                                       {
  ATH_MSG_INFO("Initializing LISAnalysisTool with configuration: " << m_configuration);
  ATH_MSG_INFO("Initializing LISAnalysisTool with BaselineStart: " << m_nBaselineStart << ", BaselineEnd: " << m_nBaselineEnd);
  
  initialize_default();
 
  ATH_MSG_INFO("LIS Configuration:");
  ATH_MSG_INFO("  NumSamples: " << m_numSamples);
  ATH_MSG_INFO("  Presample: " << m_preSample);
  ATH_MSG_INFO("  DeltaTSample: " << m_deltaTSample << " ns");
  ATH_MSG_INFO("  SampleAnaStart: " << m_sampleAnaStart);
  ATH_MSG_INFO("  SampleAnaEnd: " << m_sampleAnaEnd);
 
  // If an aux suffix is provided, prepend it with "_"
  std::string auxSuffix = m_auxSuffix;
  if (auxSuffix != "") auxSuffix = "_" + auxSuffix;
 
  // Initialize eventInfo access
  ATH_CHECK(m_eventInfoKey.initialize());
 
  // Initialize keys for reading ZDC event-level aux decor information
  m_eventTypeKey = m_zdcSumContainerName + ".EventType";
  ATH_CHECK(m_eventTypeKey.initialize());
 
  m_DAQModeKey = m_zdcSumContainerName + ".DAQMode";
  ATH_CHECK(m_DAQModeKey.initialize());
 
  m_robBCIDKey = m_zdcSumContainerName + ".rodBCID";
  ATH_CHECK(m_robBCIDKey.initialize());
 
  // Initialize WriteDecor handles
  if (m_writeAux) {
    m_ZdcLEDType = m_zdcSumContainerName + ".ZdcLEDType" + auxSuffix;
    ATH_CHECK(m_ZdcLEDType.initialize());
 
    m_LISPresampleADC = m_zdcModuleContainerName + ".LISPresample" + auxSuffix;
    ATH_CHECK(m_LISPresampleADC.initialize());
 
    m_LISADCSum = m_zdcModuleContainerName + ".LISADCSum" + auxSuffix;
    ATH_CHECK(m_LISADCSum.initialize());
 
    m_LISMaxADC = m_zdcModuleContainerName + ".LISMaxADC" + auxSuffix;
    ATH_CHECK(m_LISMaxADC.initialize());
 
    m_LISMaxSample = m_zdcModuleContainerName + ".LISMaxSample" + auxSuffix;
    ATH_CHECK(m_LISMaxSample.initialize());
 
    m_LISAvgTime = m_zdcModuleContainerName + ".LISAvgTime" + auxSuffix;
    ATH_CHECK(m_LISAvgTime.initialize());
 
  }
 
  m_init = true;
  ATH_MSG_INFO("LISAnalysisTool initialization complete");
  
  return StatusCode::SUCCESS;
}

◆ initialize_default()

void ZDC::LISAnalysisTool::initialize_default ( )

private

Definition at line 83 of file LISAnalysisTool.cxx.

                                         {
  // PbPb 2025 configuration
  m_numSamples = 24;
  m_preSample = 0;
  m_deltaTSample = 3.125;
  m_sampleAnaStart = 5;
  m_sampleAnaEnd = 23;
  m_nBaselineSamples = m_nBaselineEnd - m_nBaselineStart;
 
  m_LEDBCID = {3476, 3479, 3482};
  m_LEDCalreqIdx = {0 ,1 ,2};}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

◆ processLISModule()

LISModuleResults ZDC::LISAnalysisTool::processLISModule ( const xAOD::ZdcModule & module )

private

Definition at line 154 of file LISAnalysisTool.cxx.

                                                                              {
  ATH_MSG_DEBUG("Processing LIS module: side=" << module.zdcSide() 
               << ", module=" << module.zdcModule()
               << ", channel=" << module.zdcChannel());
 
  int LISModuleGain = 0; 
 
  if(module.zdcChannel() > 3){
    LISModuleGain = 1; // gain 1 for channels 4-7
  }
  else{
    LISModuleGain = 0; // gain 0 for channels 0-3
  }
 
   ATH_MSG_DEBUG("LIS module gain: " << LISModuleGain);
 
  // Determine which gain data to use
  static SG::ConstAccessor<std::vector<uint16_t>> g0dataAccessor("g0data");
  static SG::ConstAccessor<std::vector<uint16_t>> g1dataAccessor("g1data");
  const SG::ConstAccessor<std::vector<uint16_t>> &gainDataAccessor = (LISModuleGain == 0) ? g0dataAccessor : g1dataAccessor;
 
  // Get waveform data
  if (!gainDataAccessor.isAvailable(module)) {
    ATH_MSG_DEBUG("No gain data available for this module");
    return LISModuleResults();
  }
  
  const std::vector<uint16_t> &waveform = gainDataAccessor(module);
  if (waveform.empty()) {
    ATH_MSG_DEBUG("Empty waveform");
    return LISModuleResults();
  }
 
  return processModuleData(module.zdcSide(), module.zdcChannel(), 
                          waveform, m_sampleAnaStart, m_sampleAnaEnd);
}

◆ processModuleData()

LISModuleResults ZDC::LISAnalysisTool::processModuleData	(	int	side,
		int	channel,
		const std::vector< unsigned short > &	data,
		unsigned int	startSample,
		unsigned int	endSample )

private

Definition at line 95 of file LISAnalysisTool.cxx.

{
  ATH_MSG_DEBUG("Processing LIS data for side " << side << ", channel " << channel);
 
  int ADCSum = 0;
  int maxADCsub = -999;
  unsigned int maxSample = 0;
  float avgTime = 0.f;
 
  if (data.empty()) {
    ATH_MSG_DEBUG("Empty waveform data");
    return LISModuleResults();
  }
 
  if (startSample >= data.size() || endSample >= data.size()) {
    ATH_MSG_WARNING("Start or end sample number greater than number of samples");
    return LISModuleResults();
  }
 
  // Calculate presample (baseline) from first few samples
  float preFADC = 0;
  unsigned int nBaseline = std::min(m_nBaselineSamples, static_cast<unsigned int>(data.size()));
  for (unsigned int i = m_nBaselineStart; i < m_nBaselineEnd; ++i) {
    preFADC += data[i];
  }
  preFADC /= nBaseline;
 
  // Process samples in analysis window
  for (unsigned int sample = startSample; sample <= endSample; sample++) {
    int FADCsub = static_cast<int>(data[sample]) - static_cast<int>(std::round(preFADC));
 
    float time = (sample + 0.5f) * m_deltaTSample;
    ADCSum += FADCsub;
 
    if (FADCsub > maxADCsub) {
      maxADCsub = FADCsub;
      maxSample = sample;
    }
 
    avgTime += time * FADCsub;
  }
 
  // Calculate average time
  if (ADCSum != 0) {
    avgTime /= ADCSum;
  } else {
    avgTime = 0.f;
  }
 
  ATH_MSG_DEBUG("  Presample: " << preFADC << ", ADCSum: " << ADCSum 
               << ", MaxADC: " << maxADCsub << ", MaxSample: " << maxSample
               << ", AvgTime: " << avgTime);
 
  return LISModuleResults(preFADC, ADCSum, maxADCsub, maxSample, avgTime);
}

◆ recoZdcModules()

StatusCode ZDC::LISAnalysisTool::recoZdcModules	(	xAOD::ZdcModuleContainer const &	moduleContainer,
		xAOD::ZdcModuleContainer const &	moduleSumContainer )

overridevirtual

Implements ZDC::IZdcAnalysisTool.

Definition at line 191 of file LISAnalysisTool.cxx.

                                                      {
  
  ATH_MSG_DEBUG("LISAnalysisTool::recoZdcModules processing event");
  
  if (!m_init) {
    ATH_MSG_WARNING("Tool not initialized!");
    return StatusCode::FAILURE;
  }
 
  if (moduleContainer.empty()) {
    return StatusCode::SUCCESS;
  }
  // Check for decoding errors
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfoKey);
  if (!eventInfo.isValid()) {
    ATH_MSG_WARNING("EventInfo not valid");
    return StatusCode::FAILURE;
  }
 
  bool lisErr = eventInfo->isEventFlagBitSet(xAOD::EventInfo::ForwardDet, ZdcEventInfo::LISDECODINGERROR);
  if (lisErr) {
    ATH_MSG_WARNING("LIS decoding error found - abandoning LISAnalysisTool!");
    return StatusCode::SUCCESS;
  }
 
  SG::ReadDecorHandle<xAOD::ZdcModuleContainer, unsigned int> eventTypeHandle(m_eventTypeKey);
  SG::ReadDecorHandle<xAOD::ZdcModuleContainer, std::vector<uint16_t>> rodBCIDHandle(m_robBCIDKey);
 
  // Loop over the sum container to find event-level info (side == 0)
  //
  bool haveZdcEventInfo = false;
  unsigned int eventType = ZdcEventInfo::ZdcEventUnknown;
  unsigned int bcid = 0;
 
  const xAOD::ZdcModule* moduleSumEventInfo_ptr = 0;
 
  for (auto modSum : moduleSumContainer) {
    //
    // Module sum object with side == 0 contains event-level information
    //
    if (modSum->zdcSide() == 0) {
      //
      // Add the event type and bcid as aux decors
      //
      ATH_MSG_DEBUG("Found global sum");
      eventType = eventTypeHandle(*modSum);
      haveZdcEventInfo = true;
      moduleSumEventInfo_ptr = modSum;
    }
  }
 
    if (!haveZdcEventInfo) {
    ATH_MSG_ERROR("Zdc event data not available (moduleSum with side = 0)");
    return StatusCode::FAILURE;
  }
 
  // Get the BCID from the rodBCID vector
  const std::vector<uint16_t>& rodBCID = rodBCIDHandle(*moduleSumEventInfo_ptr);
  if (!rodBCID.empty()) {
    bcid = rodBCID[0]; // Use first BCID from LUCROD
    ATH_MSG_DEBUG("Retrieved BCID from rodBCID: " << bcid);
  } else {
    ATH_MSG_WARNING("rodBCID vector is empty, using EventInfo BCID");
    bcid = eventInfo->bcid();
  }
   
  // Determine the LED type
  //
  unsigned int evtLEDType = ZdcEventInfo::LEDNone;
 
  for (unsigned int idxLED = 0; idxLED < ZdcEventInfo::NumLEDs; idxLED++) {
    //
    //  Does the BCID match one of those associated with the LEDs?
    //
    if (m_LEDBCID[idxLED] == bcid) {
    
      evtLEDType = idxLED;
      break;
    }
  }
 
  if (evtLEDType == ZdcEventInfo::LEDNone && eventType == ZdcEventInfo::ZdcEventLED) {
    //
    // Thie BCID does not appear to be associated with one of the LEDs, print warning and quit processing
    //
    ATH_MSG_WARNING("LED event: Unexpected BCID found in data: bcid = " << bcid  << m_configuration);
    return StatusCode::SUCCESS;
  }
  else {
    ATH_MSG_DEBUG("Event with BCID = " << bcid << " has LED type " << evtLEDType);
  }
 
 
  // Create write decoration handles
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer,unsigned int> LEDTypeHandle(m_ZdcLEDType);
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer, float> presampleHandle(m_LISPresampleADC);
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer, int> adcSumHandle(m_LISADCSum);
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer, int> maxADCHandle(m_LISMaxADC);
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer, unsigned int> maxSampleHandle(m_LISMaxSample);
  SG::WriteDecorHandle<xAOD::ZdcModuleContainer, float> avgTimeHandle(m_LISAvgTime);
 
  ATH_MSG_DEBUG("Processing " << moduleContainer.size() << " modules");
 
  // Loop over modules and process LIS channels (module=5, type=2)
  for (const auto* zdcModule : moduleContainer) {
      
      LISModuleResults results = processLISModule(*zdcModule);
 
 
 
      ATH_MSG_DEBUG("Writing aux decors to LIS module: side=" << zdcModule->zdcSide() 
                   << ", channel=" << zdcModule->zdcChannel());
 
      // Write decorations
      presampleHandle(*zdcModule) = results.getPresampleADC();
      adcSumHandle(*zdcModule) = results.getADCSum();
      maxADCHandle(*zdcModule) = results.getMaxADC();
      maxSampleHandle(*zdcModule) = results.getMaxSample();
      avgTimeHandle(*zdcModule) = results.getAvgTime();
    
  }
 
 
  if(eventType == ZdcEventInfo::ZdcEventLED){
  // Write the LED type to the moduleSum container keep event-level data
  //
  LEDTypeHandle(*moduleSumEventInfo_ptr) = evtLEDType;
  }
 
  ATH_MSG_DEBUG("Finished event processing");
 
  return StatusCode::SUCCESS;
}

◆ 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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ reprocessZdc()

StatusCode ZDC::LISAnalysisTool::reprocessZdc ( )

overridevirtual

Implements ZDC::IZdcAnalysisTool.

Definition at line 327 of file LISAnalysisTool.cxx.

                                         {
  if (!m_init) {
    ATH_MSG_WARNING("Tool not initialized!");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Trying to retrieve " << m_zdcModuleContainerName);
 
  m_zdcModules = nullptr;
  ATH_CHECK(evtStore()->retrieve(m_zdcModules, m_zdcModuleContainerName));
 
  m_zdcSums = nullptr;
  ATH_CHECK(evtStore()->retrieve(m_zdcSums, m_zdcSumContainerName));
 
  ATH_CHECK(recoZdcModules(*m_zdcModules, *m_zdcSums));
 
  return StatusCode::SUCCESS;
}

◆ setFADCCorrections()

void ZDC::LISAnalysisTool::setFADCCorrections ( unsigned int runNumber )

private

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_auxSuffix

Gaudi::Property<std::string> ZDC::LISAnalysisTool::m_auxSuffix {this, "AuxSuffix", "", "Suffix for aux data names"}

private

Definition at line 75 of file LISAnalysisTool.h.

75{this, "AuxSuffix", "", "Suffix for aux data names"};

◆ m_calreqNames

const std::vector<std::string> ZDC::LISAnalysisTool::m_calreqNames = {"CalReq1", "CalReq2", "CalReq3"}

private

Definition at line 83 of file LISAnalysisTool.h.

83{"CalReq1", "CalReq2", "CalReq3"};

◆ m_configuration

Gaudi::Property<std::string> ZDC::LISAnalysisTool::m_configuration {this, "Configuration", "default", "Which config to use"}

private

Definition at line 73 of file LISAnalysisTool.h.

73{this, "Configuration", "default", "Which config to use"};

◆ m_DAQModeKey

SG::ReadDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_DAQModeKey {this, "ZdcDAQModeKey", "", "ZDC DAQ mode"}

private

Definition at line 103 of file LISAnalysisTool.h.

103{this, "ZdcDAQModeKey", "", "ZDC DAQ mode"};

◆ m_deltaTSample

float ZDC::LISAnalysisTool::m_deltaTSample {3.125}

private

Definition at line 88 of file LISAnalysisTool.h.

88{3.125}; // ns per sample

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doFADCCorr

bool ZDC::LISAnalysisTool::m_doFADCCorr {}

private

Definition at line 113 of file LISAnalysisTool.h.

113{};

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> ZDC::LISAnalysisTool::m_eventInfoKey {this, "EventInfoKey", "EventInfo", "Location of the event info"}

private

Definition at line 100 of file LISAnalysisTool.h.

100{this, "EventInfoKey", "EventInfo", "Location of the event info"};

◆ m_eventTypeKey

SG::ReadDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_eventTypeKey {this, "ZdcEventTypeKey", "", "ZDC Event type"}

private

Definition at line 101 of file LISAnalysisTool.h.

101{this, "ZdcEventTypeKey", "", "ZDC Event type"};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_init

bool ZDC::LISAnalysisTool::m_init {false}

private

Definition at line 69 of file LISAnalysisTool.h.

69{false};

◆ m_LEDBCID

std::vector<unsigned int> ZDC::LISAnalysisTool::m_LEDBCID

private

Definition at line 80 of file LISAnalysisTool.h.

◆ m_LEDCalreqIdx

std::vector<unsigned int> ZDC::LISAnalysisTool::m_LEDCalreqIdx

private

Definition at line 79 of file LISAnalysisTool.h.

◆ m_LEDNames

const std::vector<std::string> ZDC::LISAnalysisTool::m_LEDNames = {"Blue1", "Green", "Blue2"}

private

Definition at line 82 of file LISAnalysisTool.h.

82{"Blue1", "Green", "Blue2"};

◆ m_LISADCSum

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_LISADCSum {this, "LISADCSum", "", "LIS pulse FADC sum"}

private

Definition at line 108 of file LISAnalysisTool.h.

108{this, "LISADCSum", "", "LIS pulse FADC sum"};

◆ m_LISAvgTime

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_LISAvgTime {this, "LISAvgTime", "", "LIS average time"}

private

Definition at line 111 of file LISAnalysisTool.h.

111{this, "LISAvgTime", "", "LIS average time"};

◆ m_LISMaxADC

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_LISMaxADC {this, "LISMaxADC", "", "LIS pulse max FADC value"}

private

Definition at line 109 of file LISAnalysisTool.h.

109{this, "LISMaxADC", "", "LIS pulse max FADC value"};

◆ m_LISMaxSample

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_LISMaxSample {this, "LISMaxSample", "", "LIS max FADC sample"}

private

Definition at line 110 of file LISAnalysisTool.h.

110{this, "LISMaxSample", "", "LIS max FADC sample"};

◆ m_LISPresampleADC

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_LISPresampleADC {this, "LISPresampleADC", "", "LIS presample ADC"}

private

Definition at line 107 of file LISAnalysisTool.h.

107{this, "LISPresampleADC", "", "LIS presample ADC"};

◆ m_name

std::string ZDC::LISAnalysisTool::m_name

private

Definition at line 70 of file LISAnalysisTool.h.

◆ m_nBaselineEnd

Gaudi::Property<unsigned int> ZDC::LISAnalysisTool::m_nBaselineEnd {this, "BaselineEnd", 5, "End index for baseline calculation"}

private

Definition at line 77 of file LISAnalysisTool.h.

77{this, "BaselineEnd", 5, "End index for baseline calculation"};

◆ m_nBaselineSamples

unsigned int ZDC::LISAnalysisTool::m_nBaselineSamples {5}

private

Definition at line 91 of file LISAnalysisTool.h.

91{5}; // default to 5 samples for baseline calculation

◆ m_nBaselineStart

Gaudi::Property<unsigned int> ZDC::LISAnalysisTool::m_nBaselineStart {this, "BaselineStart", 0, "Start index for baseline calculation"}

private

Definition at line 76 of file LISAnalysisTool.h.

76{this, "BaselineStart", 0, "Start index for baseline calculation"};

◆ m_numSamples

unsigned int ZDC::LISAnalysisTool::m_numSamples {24}

private

Definition at line 86 of file LISAnalysisTool.h.

86{24};

◆ m_preSample

unsigned int ZDC::LISAnalysisTool::m_preSample {0}

private

Definition at line 87 of file LISAnalysisTool.h.

87{0};

◆ m_robBCIDKey

SG::ReadDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_robBCIDKey {this, "ROBBCIDKey", "", "BCID from LUCROD ROB headers"}

private

Definition at line 102 of file LISAnalysisTool.h.

102{this, "ROBBCIDKey", "", "BCID from LUCROD ROB headers"};

◆ m_sampleAnaEnd

unsigned int ZDC::LISAnalysisTool::m_sampleAnaEnd {23}

private

Definition at line 90 of file LISAnalysisTool.h.

90{23};

◆ m_sampleAnaStart

unsigned int ZDC::LISAnalysisTool::m_sampleAnaStart {5}

private

Definition at line 89 of file LISAnalysisTool.h.

89{5};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writeAux

Gaudi::Property<bool> ZDC::LISAnalysisTool::m_writeAux {this, "WriteAux", true, "Write auxiliary data"}

private

Definition at line 74 of file LISAnalysisTool.h.

74{this, "WriteAux", true, "Write auxiliary data"};

◆ m_ZdcLEDType

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZDC::LISAnalysisTool::m_ZdcLEDType {this, "ZdcLEDType", "", "ZDC LED Type (0-Blue1, 1-Green, 2-Blue2}"}

private

Definition at line 106 of file LISAnalysisTool.h.

106{this, "ZdcLEDType", "", "ZDC LED Type (0-Blue1, 1-Green, 2-Blue2}"};

◆ m_zdcModuleContainerName

Gaudi::Property<std::string> ZDC::LISAnalysisTool::m_zdcModuleContainerName {this, "ZdcModuleContainerName", "ZdcModules", "Location of ZDC processed data"}

private

Definition at line 94 of file LISAnalysisTool.h.

94{this, "ZdcModuleContainerName", "ZdcModules", "Location of ZDC processed data"};

◆ m_zdcModules

const xAOD::ZdcModuleContainer* ZDC::LISAnalysisTool::m_zdcModules {nullptr}

private

Definition at line 96 of file LISAnalysisTool.h.

96{nullptr};

◆ m_zdcSumContainerName

Gaudi::Property<std::string> ZDC::LISAnalysisTool::m_zdcSumContainerName {this, "ZdcSumContainerName", "ZdcSums", "Location of ZDC processed sums"}

private

Definition at line 95 of file LISAnalysisTool.h.

95{this, "ZdcSumContainerName", "ZdcSums", "Location of ZDC processed sums"};

◆ m_zdcSums

const xAOD::ZdcModuleContainer* ZDC::LISAnalysisTool::m_zdcSums {nullptr}

private

Definition at line 97 of file LISAnalysisTool.h.

97{nullptr};

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

◆ LISAnalysisTool()

◆ ~LISAnalysisTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getAmplitudeCorrection()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ initialize_default()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ processLISModule()

◆ processModuleData()

◆ recoZdcModules()

◆ renounce()

◆ renounceArray()

◆ reprocessZdc()

◆ setFADCCorrections()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_auxSuffix

◆ m_calreqNames

◆ m_configuration

◆ m_DAQModeKey

◆ m_deltaTSample

◆ m_detStore

◆ m_doFADCCorr

◆ m_eventInfoKey

◆ m_eventTypeKey

◆ m_evtStore

◆ m_init

◆ m_LEDBCID

◆ m_LEDCalreqIdx

◆ m_LEDNames

◆ m_LISADCSum

◆ m_LISAvgTime

◆ m_LISMaxADC

◆ m_LISMaxSample

◆ m_LISPresampleADC

◆ m_name

◆ m_nBaselineEnd

◆ m_nBaselineSamples

◆ m_nBaselineStart

◆ m_numSamples

◆ m_preSample

◆ m_robBCIDKey

◆ m_sampleAnaEnd

◆ m_sampleAnaStart

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeAux

◆ m_ZdcLEDType

◆ m_zdcModuleContainerName

◆ m_zdcModules

◆ m_zdcSumContainerName

◆ m_zdcSums