daq::IDecoderFilter Class Reference

IDecoderFilter interface class definiton. More...

#include <IDecoderFilter.h>

Inheritance diagram for daq::IDecoderFilter:

Public Member Functions
virtual	~IDecoderFilter () noexcept=default
	Virtual Destructor. More...
virtual void	configure (const fhicl::ParameterSet &)=0
	Interface for configuring the particular algorithm tool. More...
virtual void	process_fragment (detinfo::DetectorClocksData const &clockData, const artdaq::Fragment &fragment)=0
	Given a set of recob hits, run DBscan to form 3D clusters. More...
virtual const icarus_signal_processing::VectorInt	getChannelIDs () const =0
	Recover the channels for the processed fragment. More...
virtual const icarus_signal_processing::ArrayBool	getSelectionVals () const =0
	Recover the selection values. More...
virtual const icarus_signal_processing::ArrayBool	getROIVals () const =0
	Recover the ROI values. More...
virtual const icarus_signal_processing::ArrayFloat	getRawWaveforms () const =0
	Recover the original raw waveforms. More...
virtual const icarus_signal_processing::ArrayFloat	getPedCorWaveforms () const =0
	Recover the pedestal corrected waveforms. More...
virtual const icarus_signal_processing::ArrayFloat	getIntrinsicRMS () const =0
	Recover the "intrinsic" RMS. More...
virtual const icarus_signal_processing::ArrayFloat	getCorrectedMedians () const =0
	Recover the correction median values. More...
virtual const icarus_signal_processing::ArrayFloat	getWaveLessCoherent () const =0
	Recover the waveforms less coherent noise. More...
virtual const icarus_signal_processing::ArrayFloat	getMorphedWaveforms () const =0
	Recover the morphological filter waveforms. More...
virtual const icarus_signal_processing::VectorFloat	getPedestalVals () const =0
	Recover the pedestals for each channel. More...
virtual const icarus_signal_processing::VectorFloat	getFullRMSVals () const =0
	Recover the full RMS before coherent noise. More...
virtual const icarus_signal_processing::VectorFloat	getTruncRMSVals () const =0
	Recover the truncated RMS noise. More...
virtual const icarus_signal_processing::VectorInt	getNumTruncBins () const =0
	Recover the number of bins after truncation. More...

Detailed Description

IDecoderFilter interface class definiton.

Definition at line 32 of file IDecoderFilter.h.

Constructor & Destructor Documentation

virtual daq::IDecoderFilter::~IDecoderFilter ( )

virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void daq::IDecoderFilter::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::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::VectorInt daq::IDecoderFilter::getChannelIDs ( ) const

pure virtual

Recover the channels for the processed fragment.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getCorrectedMedians ( ) const

pure virtual

Recover the correction median values.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::VectorFloat daq::IDecoderFilter::getFullRMSVals ( ) const

pure virtual

Recover the full RMS before coherent noise.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getIntrinsicRMS ( ) const

pure virtual

Recover the "intrinsic" RMS.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getMorphedWaveforms ( ) const

pure virtual

Recover the morphological filter waveforms.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::VectorInt daq::IDecoderFilter::getNumTruncBins ( ) const

pure virtual

Recover the number of bins after truncation.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getPedCorWaveforms ( ) const

pure virtual

Recover the pedestal corrected waveforms.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::VectorFloat daq::IDecoderFilter::getPedestalVals ( ) const

pure virtual

Recover the pedestals for each channel.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getRawWaveforms ( ) const

pure virtual

Recover the original raw waveforms.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayBool daq::IDecoderFilter::getROIVals ( ) const

pure virtual

Recover the ROI values.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayBool daq::IDecoderFilter::getSelectionVals ( ) const

pure virtual

Recover the selection values.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::VectorFloat daq::IDecoderFilter::getTruncRMSVals ( ) const

pure virtual

Recover the truncated RMS noise.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual const icarus_signal_processing::ArrayFloat daq::IDecoderFilter::getWaveLessCoherent ( ) const

pure virtual

Recover the waveforms less coherent noise.

Implemented in daq::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

virtual void daq::IDecoderFilter::process_fragment ( detinfo::DetectorClocksData const &  clockData, 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::TPCDecoderFilter1D, and daq::TPCDecoderFilter2D.

---

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

• IDecoderFilter.h