daq::IDecoder Class Reference

IDecoder interface class definiton. More...

#include <IDecoder.h>

Inheritance diagram for daq::IDecoder:

Public Member Functions
virtual	~IDecoder () noexcept=default
	Virtual Destructor. More...
virtual void	consumes (art::ConsumesCollector &)
	Declare to the framework what you expect to read. More...
virtual void	produces (art::ProducesCollector &)=0
	The space point building should output the hit collection for those hits which combine to form space points - a nice noise filter! More...
virtual void	configure (const fhicl::ParameterSet &)=0
	Interface for configuring the particular algorithm tool. More...
virtual void	setupRun (art::Run const &run)
	Preparation to process a new run. More...
virtual void	setupEvent (art::Event const &event)
	Preparation to process a new event. More...
virtual void	initializeDataProducts ()=0
	Initialize any data products the tool will output. More...
virtual void	process_fragment (const artdaq::Fragment &fragment)=0
	Given a set of recob hits, run DBscan to form 3D clusters. More...
virtual void	outputDataProducts (art::Event &event)=0
	Output the data products to the event store. More...

Detailed Description

IDecoder interface class definiton.

Definition at line 34 of file IDecoder.h.

Constructor & Destructor Documentation

virtual daq::IDecoder::~IDecoder ( )

virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void daq::IDecoder::configure ( const fhicl::ParameterSet &  )

pure virtual

Interface for configuring the particular algorithm tool.

Parameters

ParameterSet

The input set of parameters for configuration

Implemented in daq::PMTDecoder, daq::TriggerDecoder, daq::TriggerDecoder, and daq::TPCDecoder.

virtual void daq::IDecoder::consumes ( art::ConsumesCollector &  )

inlinevirtual

Declare to the framework what you expect to read.

Reimplemented in daq::PMTDecoder, and daq::TriggerDecoder.

Definition at line 45 of file IDecoder.h.

{}

virtual void daq::IDecoder::initializeDataProducts ( )

pure virtual

Initialize any data products the tool will output.

Implemented in daq::PMTDecoder, daq::TriggerDecoder, daq::TriggerDecoder, and daq::TPCDecoder.

virtual void daq::IDecoder::outputDataProducts ( art::Event &  event )

pure virtual

Output the data products to the event store.

Parameters

event

The event store objects

Implemented in daq::PMTDecoder, daq::TriggerDecoder, daq::TriggerDecoder, and daq::TPCDecoder.

virtual void daq::IDecoder::process_fragment ( const artdaq::Fragment &  fragment )

pure virtual

Given a set of recob hits, run DBscan to form 3D clusters.

Parameters

fragment

The artdaq fragment to process

Implemented in daq::PMTDecoder, daq::TriggerDecoder, daq::TriggerDecoder, and daq::TPCDecoder.

virtual void daq::IDecoder::produces ( art::ProducesCollector &  )

pure virtual

The space point building should output the hit collection for those hits which combine to form space points - a nice noise filter!

Implemented in daq::PMTDecoder, daq::TriggerDecoder, daq::TriggerDecoder, and daq::TPCDecoder.

virtual void daq::IDecoder::setupEvent ( art::Event const &  event )

inlinevirtual

Preparation to process a new event.

To be called on every art event transition.

Reimplemented in daq::PMTDecoder.

Definition at line 72 of file IDecoder.h.

{}

virtual void daq::IDecoder::setupRun ( art::Run const &  run )

inlinevirtual

Preparation to process a new run.

To be called on every art run transition.

Reimplemented in daq::PMTDecoder, and daq::TriggerDecoder.

Definition at line 65 of file IDecoder.h.

{}

---

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

• IDecoder.h