GlobalSim::PU1SuppAlgTool Class Reference

Implements the IGlobalSimAlgTool interface to run PU1 suppression. More...

#include <PU1SuppAlgTool.h>

Inheritance diagram for GlobalSim::PU1SuppAlgTool:

Collaboration diagram for GlobalSim::PU1SuppAlgTool:

Public Member Functions
	PU1SuppAlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
virtual	~PU1SuppAlgTool ()=default
	Destructor.
virtual StatusCode	initialize () override
	Initialization of keys and setup.
virtual StatusCode	run (const std::unique_ptr< IDataCollector > &, const EventContext &ctx) const override
	Run suppression on input TOBs and write output TOBs.
virtual std::string	toString () const override
	Returns a string representation for diagnostics.

Private Attributes
SG::ReadHandleKey< GepAlgoPU1SuppFIFO >	m_HypoFIFOReadKey
	Key to read TOB FIFO from the event store.
SG::WriteHandleKey< GepAlgoPU1SuppPortsOutFIFO >	m_portsOutWriteKey
	Key to write suppressed TOBs to the event store.

Detailed Description

Implements the IGlobalSimAlgTool interface to run PU1 suppression.

Definition at line 31 of file PU1SuppAlgTool.h.

Constructor & Destructor Documentation

PU1SuppAlgTool()

GlobalSim::PU1SuppAlgTool::PU1SuppAlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor.

Definition at line 14 of file PU1SuppAlgTool.cxx.

    : extends(type, name, parent) {}

~PU1SuppAlgTool()

virtual GlobalSim::PU1SuppAlgTool::~PU1SuppAlgTool ( )

virtualdefault

Destructor.

Member Function Documentation

initialize()

StatusCode GlobalSim::PU1SuppAlgTool::initialize ( )

overridevirtual

Initialization of keys and setup.

Definition at line 18 of file PU1SuppAlgTool.cxx.

                                      {
  ATH_MSG_INFO("Initializing PU1SuppAlgTool");
 
  // Initialize read/write handles
  ATH_CHECK(m_HypoFIFOReadKey.initialize());
  ATH_CHECK(m_portsOutWriteKey.initialize());
 
  return StatusCode::SUCCESS;
}

run()

StatusCode GlobalSim::PU1SuppAlgTool::run ( const std::unique_ptr< IDataCollector > & dc, const EventContext & ctx ) const

overridevirtual

Run suppression on input TOBs and write output TOBs.

Definition at line 28 of file PU1SuppAlgTool.cxx.

                                                  {
  ATH_MSG_DEBUG("Running PU1SuppAlgTool");
  if (dc){dc->collect(*this, "start");}
 
  // Read input FIFO of TOBs
  SG::ReadHandle<GepAlgoPU1SuppFIFO> fifoHandle(m_HypoFIFOReadKey, ctx);
  if (!fifoHandle.isValid()) {
    ATH_MSG_ERROR(
        "Failed to retrieve PU1 TOBs with key: " << m_HypoFIFOReadKey.key());
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Read " << fifoHandle->size() << " TOBs from event store");
 
  // Create container for output TOBs
  auto ports_out = std::make_unique<GepAlgoPU1SuppPortsOutFIFO>();
 
  // Apply suppression to each input TOB
  for (const auto& tob_in : *fifoHandle) {
    PU1SuppPortsOut tob_out;
    const StatusCode ok = runPU1Suppression(tob_in, tob_out, msg());
    if (ok.isFailure()) {
      ATH_MSG_WARNING("Suppression failed for one TOB - skipping");
      continue;
    }
    ports_out->push_back(std::move(tob_out));
  }
 
  // Optionally print output TOB hex strings
  for (const auto& tob_out : *ports_out) {
    for (const auto& hexstr : tob_out.m_outputTobs) {
      ATH_MSG_DEBUG("PU1SuppPortsOut TOB hex string: " << hexstr);
    }
  }
 
  // Write output FIFO to event store
  SG::WriteHandle<GepAlgoPU1SuppPortsOutFIFO> outputHandle(m_portsOutWriteKey,
                                                           ctx);
  ATH_CHECK(outputHandle.record(std::move(ports_out)));
 
  ATH_MSG_DEBUG("PU1 suppression outputs recorded to event store under key: "
                << m_portsOutWriteKey.key());
 
 
  if (dc){dc->collect(*this, "end");}
  return StatusCode::SUCCESS;
}

toString()

std::string GlobalSim::PU1SuppAlgTool::toString ( ) const

overridevirtual

Returns a string representation for diagnostics.

Definition at line 77 of file PU1SuppAlgTool.cxx.

                                         {
  return "PU1SuppAlgTool: Tool for PU1 suppression";
}

Member Data Documentation

m_HypoFIFOReadKey

SG::ReadHandleKey<GepAlgoPU1SuppFIFO> GlobalSim::PU1SuppAlgTool::m_HypoFIFOReadKey

private

Initial value:

{
      this, "HypoFIFOReadKey", "SuppFIFO", "Input key for PU1 TOBs"
    }

Key to read TOB FIFO from the event store.

Definition at line 53 of file PU1SuppAlgTool.h.

                                                         {
      this, "HypoFIFOReadKey", "SuppFIFO", "Input key for PU1 TOBs"
    };

m_portsOutWriteKey

SG::WriteHandleKey<GepAlgoPU1SuppPortsOutFIFO> GlobalSim::PU1SuppAlgTool::m_portsOutWriteKey

private

Initial value:

{
      this, "PortsOutWriteKey", "PU1SuppOut", "Output key for suppressed TOBs"
    }

Key to write suppressed TOBs to the event store.

Definition at line 58 of file PU1SuppAlgTool.h.

                                                                   {
      this, "PortsOutWriteKey", "PU1SuppOut", "Output key for suppressed TOBs"
    };

---

The documentation for this class was generated from the following files:

• PU1SuppAlgTool.h
• PU1SuppAlgTool.cxx