Athena algorithm that feeds TOB and rho data into the PU1 suppression chain. More...

#include <PU1SuppTestBench.h>

Inheritance diagram for GlobalSim::PU1SuppTestBenchAlg:

Collaboration diagram for GlobalSim::PU1SuppTestBenchAlg:

Public Member Functions
	PU1SuppTestBenchAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual StatusCode	initialize () override
	Athena initialize hook.
virtual StatusCode	execute () override
	Athena execute hook (called once per event)
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
StatusCode	init_from_file ()
	Populate m_fifos from file.
std::string	trim (const std::string &s)
	Strip whitespace from both ends of a string.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_testsFileName
	Path to input file containing 256-bit TOBs as 64-character hex strings.
Gaudi::Property< std::string >	m_rhoFileName
	Path to input file containing rho values, one per line.
SG::WriteHandleKey< GepAlgoPU1SuppFIFO >	m_suppFIFO_WriteKey
	Write handle key for TOB FIFO.
SG::WriteHandleKey< PU1SuppExpectations >	m_PU1SuppExpectations_WriteKey
	Write handle key for dummy expectations.
std::vector< std::unique_ptr< GepAlgoPU1SuppFIFO > >	m_fifos
	Preloaded list of TOB FIFOs from file.
std::size_t	m_fifo_ptr {0}
	Index of next FIFO to write during execution.
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

Athena algorithm that feeds TOB and rho data into the PU1 suppression chain.

Reads hex-encoded 256-bit TOBs and associated rho values from file, converts them into PU1SuppPortsIn structs, and pushes them into the StoreGate FIFO.

Definition at line 34 of file PU1SuppTestBench.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

◆ PU1SuppTestBenchAlg()

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

Constructor.

Constructor implementation.

Definition at line 26 of file PU1SuppTestBench.cxx.

28 : AthAlgorithm(name, pSvcLocator) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

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

overridevirtual

Athena execute hook (called once per event)

Athena execute method (runs once per event)

Definition at line 49 of file PU1SuppTestBench.cxx.

                                        {
  if (m_fifo_ptr >= m_fifos.size()) {
    ATH_MSG_ERROR("No more FIFO data to write");
    return StatusCode::FAILURE;
  }
 
  // Write TOB FIFO to event store
  SG::WriteHandle<GepAlgoPU1SuppFIFO> h_write(m_suppFIFO_WriteKey);
  CHECK(h_write.record(std::move(m_fifos[m_fifo_ptr])));
 
  // Write dummy expectation to event store (placeholder)
  auto expectations = std::make_unique<PU1SuppExpectations>("0000", "0000");
  SG::WriteHandle<PU1SuppExpectations> h_write_exp(
      m_PU1SuppExpectations_WriteKey);
  CHECK(h_write_exp.record(std::move(expectations)));
 
  ++m_fifo_ptr;
  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();
}

◆ init_from_file()

StatusCode GlobalSim::PU1SuppTestBenchAlg::init_from_file ( )

private

Populate m_fifos from file.

Read TOB and rho test vectors from input files and populate FIFO buffer.

Definition at line 70 of file PU1SuppTestBench.cxx.

                                               {
  std::ifstream tobFile(m_testsFileName);
  std::ifstream rhoFile(m_rhoFileName);
 
  if (!tobFile) {
    ATH_MSG_FATAL("Failed to open TOB input file: " << m_testsFileName);
    return StatusCode::FAILURE;
  }
  if (!rhoFile) {
    ATH_MSG_FATAL("Failed to open rho input file: " << m_rhoFileName);
    return StatusCode::FAILURE;
  }
 
  std::string tobLine, rhoLine;
  int lineNum = 0;
 
  while (std::getline(tobFile, tobLine) && std::getline(rhoFile, rhoLine)) {
    ++lineNum;
 
    std::string tobStr = trim(tobLine);
    std::string rhoStr = trim(rhoLine);
 
    const bool isHex = (tobStr.length() == 64 &&
                        std::all_of(tobStr.begin(), tobStr.end(), ::isxdigit));
 
    const bool isBinary =
        (tobStr.length() == 256 &&
         std::all_of(tobStr.begin(), tobStr.end(),
                     [](char c) { return c == '0' || c == '1'; }));
 
    if (!isHex && !isBinary) {
      ATH_MSG_WARNING("Skipping bad TOB line "
                      << lineNum
                      << ": expected 64 length hex or 256 length bit");
      continue;
    }
 
    auto fifo = std::make_unique<GepAlgoPU1SuppFIFO>();
    PU1SuppPortsIn ports_in;
 
    const int chunkSize = isHex ? 16 : 64;
    std::string_view tobView = tobStr;
    bool parseError = false;
 
    for (int i=0; i < 4; ++i) {
      auto tobWord = tobView.substr(i * chunkSize, chunkSize);
      uint64_t value = 0;
      auto [ptr, ec] = std::from_chars(
          tobWord.data(),
          tobWord.data() + tobWord.size(),
          value,
          isHex ? 16 : 2
      );
      if (ec != std::errc{}) {
        ATH_MSG_WARNING("Skipping bad TOB line " << lineNum
                        << ": failed to parse section " << i);
        parseError = true;
        break;
      }
      ports_in.m_I_PU1TobData[i] = value;
    }
 
    if (parseError) continue;
    
    ports_in.m_rho = static_cast<uint16_t>(std::stoul(rhoStr, nullptr, 2));
 
    fifo->push_back(ports_in);
    m_fifos.push_back(std::move(fifo));
  }
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode GlobalSim::PU1SuppTestBenchAlg::initialize ( )

overridevirtual

Athena initialize hook.

Athena initialize method.

Definition at line 31 of file PU1SuppTestBench.cxx.

                                           {
  ATH_MSG_INFO("Initializing PU1SuppTestBench");
 
  CHECK(m_suppFIFO_WriteKey.initialize());
  CHECK(m_PU1SuppExpectations_WriteKey.initialize());
 
  if (m_testsFileName.empty()) {
    ATH_MSG_FATAL("testsFileName is empty");
    return StatusCode::FAILURE;
  }
 
  CHECK(init_from_file());
 
  ATH_MSG_INFO("Loaded " << m_fifos.size() << " FIFOs for input");
  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.

◆ trim()

std::string GlobalSim::PU1SuppTestBenchAlg::trim ( const std::string & s )

private

Strip whitespace from both ends of a string.

Helper to trim leading and trailing whitespace from a string.

Definition at line 144 of file PU1SuppTestBench.cxx.

                                                      {
  std::string result = s;
  boost::algorithm::trim(result);
  return result;
}

◆ 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_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_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_fifo_ptr

std::size_t GlobalSim::PU1SuppTestBenchAlg::m_fifo_ptr {0}

private

Index of next FIFO to write during execution.

Definition at line 70 of file PU1SuppTestBench.h.

70{0};

◆ m_fifos

std::vector<std::unique_ptr<GepAlgoPU1SuppFIFO> > GlobalSim::PU1SuppTestBenchAlg::m_fifos

private

Preloaded list of TOB FIFOs from file.

Definition at line 67 of file PU1SuppTestBench.h.

◆ m_PU1SuppExpectations_WriteKey

SG::WriteHandleKey<PU1SuppExpectations> GlobalSim::PU1SuppTestBenchAlg::m_PU1SuppExpectations_WriteKey

private

Initial value:

{
      this, "ExpectationsKey", "ExpectedTOBs", "Key to write dummy expectations (optional)"
    }

Write handle key for dummy expectations.

Definition at line 62 of file PU1SuppTestBench.h.

                                                                        {
      this, "ExpectationsKey", "ExpectedTOBs", "Key to write dummy expectations (optional)"
    };

◆ m_rhoFileName

Gaudi::Property<std::string> GlobalSim::PU1SuppTestBenchAlg::m_rhoFileName

private

Initial value:

{
      this, "RhoFileName", "", "Path to file containing rho values"
    }

Path to input file containing rho values, one per line.

Definition at line 52 of file PU1SuppTestBench.h.

                                          {
      this, "RhoFileName", "", "Path to file containing rho values"
    };

◆ m_suppFIFO_WriteKey

SG::WriteHandleKey<GepAlgoPU1SuppFIFO> GlobalSim::PU1SuppTestBenchAlg::m_suppFIFO_WriteKey

private

Initial value:

{
      this, "SuppFIFOKey", "SuppFIFO", "Key to write FIFO of TOBs to SG"
    }

Write handle key for TOB FIFO.

Definition at line 57 of file PU1SuppTestBench.h.

                                                            {
      this, "SuppFIFOKey", "SuppFIFO", "Key to write FIFO of TOBs to SG"
    };

◆ m_testsFileName

Gaudi::Property<std::string> GlobalSim::PU1SuppTestBenchAlg::m_testsFileName

private

Initial value:

{
      this, "TestsFileName", "", "Path to file containing 256-bit TOB hex strings"
    }

Path to input file containing 256-bit TOBs as 64-character hex strings.

Definition at line 47 of file PU1SuppTestBench.h.

                                            {
      this, "TestsFileName", "", "Path to file containing 256-bit TOB hex strings"
    };

◆ 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

◆ PU1SuppTestBenchAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ init_from_file()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ trim()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fifo_ptr

◆ m_fifos

◆ m_PU1SuppExpectations_WriteKey

◆ m_rhoFileName

◆ m_suppFIFO_WriteKey

◆ m_testsFileName

◆ m_varHandleArraysDeclared

◆ m_vhka