IDecoderFilter interface class definiton. More...

#include <INoiseFilter.h>

Inheritance diagram for daq::INoiseFilter:

Public Types
using	ChannelPlanePair = std::pair< unsigned int, unsigned int >
	Given a set of recob hits, run DBscan to form 3D clusters. More...

using	ChannelPlaneVec = std::vector< ChannelPlanePair >

Public Member Functions
virtual	~INoiseFilter () 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 &, const daq::INoiseFilter::ChannelPlaneVec &, const icarus_signal_processing::ArrayFloat &, const size_t &)=0

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 INoiseFilter.h.

Member Typedef Documentation

using daq::INoiseFilter::ChannelPlanePair = std::pair<unsigned int,unsigned int>

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

Parameters

ChannelVec	list of channels associated to input data array
ArrayFloat	array by channel of the waveforms

Definition at line 53 of file INoiseFilter.h.

using daq::INoiseFilter::ChannelPlaneVec = std::vector<ChannelPlanePair>

Definition at line 54 of file INoiseFilter.h.

Constructor & Destructor Documentation

virtual daq::INoiseFilter::~INoiseFilter ( )

virtualdefaultnoexcept

Virtual Destructor.

Member Function Documentation

virtual void daq::INoiseFilter::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::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::VectorInt& daq::INoiseFilter::getChannelIDs ( ) const

pure virtual

Recover the channels for the processed fragment.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getCorrectedMedians ( ) const

pure virtual

Recover the correction median values.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::VectorFloat& daq::INoiseFilter::getFullRMSVals ( ) const

pure virtual

Recover the full RMS before coherent noise.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getIntrinsicRMS ( ) const

pure virtual

Recover the "intrinsic" RMS.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getMorphedWaveforms ( ) const

pure virtual

Recover the morphological filter waveforms.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::VectorInt& daq::INoiseFilter::getNumTruncBins ( ) const

pure virtual

Recover the number of bins after truncation.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getPedCorWaveforms ( ) const

pure virtual

Recover the pedestal corrected waveforms.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::VectorFloat& daq::INoiseFilter::getPedestalVals ( ) const

pure virtual

Recover the pedestals for each channel.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getRawWaveforms ( ) const

pure virtual

Recover the original raw waveforms.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayBool& daq::INoiseFilter::getROIVals ( ) const

pure virtual

Recover the ROI values.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayBool& daq::INoiseFilter::getSelectionVals ( ) const

pure virtual

Recover the selection values.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::VectorFloat& daq::INoiseFilter::getTruncRMSVals ( ) const

pure virtual

Recover the truncated RMS noise.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual const icarus_signal_processing::ArrayFloat& daq::INoiseFilter::getWaveLessCoherent ( ) const

pure virtual

Recover the waveforms less coherent noise.

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

virtual void daq::INoiseFilter::process_fragment	(	detinfo::DetectorClocksData const &	,
		const daq::INoiseFilter::ChannelPlaneVec &	,
		const icarus_signal_processing::ArrayFloat &	,
		const size_t &
	)

pure virtual

Implemented in daq::TPCNoiseFilterCannyMC, and daq::TPCNoiseFilter1DMC.

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

INoiseFilter.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation