#include <RdChannelBandpassFilter.h>

Inheritance diagram for RdChannelBandpassFilter::RdChannelBandpassFilter:

Public Types
enum	ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
	Flag returned by module methods to the RunController. More...

enum	VersionInfoType { eFilename = 1, eRevisionNumber = 2, eDate = 3, eTime = 4, eLastEditor = 5 }
	Different types of version info that can be retrieved from GetVersionInfo. More...

Public Member Functions
fwk::VModule::ResultFlag	Finish () override
	Finish: invoked at end of the run (NOT end of the event) More...

utl::Stopwatch &	GetStopwatch ()

const utl::Stopwatch &	GetStopwatch () const

std::string	GetVersionInfo (const VersionInfoType v) const
	Retrieve different sorts of module version info. More...

fwk::VModule::ResultFlag	Init () override
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

fwk::VModule::ResultFlag	Run (evt::Event &event) override
	Run: invoked once per event. More...

ResultFlag	RunWithTiming (evt::Event &event)

Static Public Member Functions
static std::string	GetResultFlagByName (const ResultFlag flag)

Protected Types
enum	InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }

Protected Attributes
int	fInfoLevel = 0

Private Types
enum	eFilterType { Undefined, Rectangle, Gauss }

Private Member Functions
	REGISTER_MODULE ("RdChannelBandpassFilter", RdChannelBandpassFilter)

Private Attributes
double	fDelay = 0

utl::AnalyticFilter *	fFilter = nullptr

eFilterType	fFilterType = Undefined

std::string	fFilterTypeString = "Undefined"

double	fLowerCutoffFrequency = 0

double	fUpperCutoffFrequency = 0

Detailed Description

Definition at line 22 of file RdChannelBandpassFilter.h.

Member Enumeration Documentation

enum RdChannelBandpassFilter::RdChannelBandpassFilter::eFilterType

private

Enumerator
Undefined
Rectangle
Gauss

Definition at line 30 of file RdChannelBandpassFilter.h.

enum fwk::VModule::InfoLevel

protectedinherited

Enumerator
eInfoNone
eInfoFinal
eInfoIntermediate
eInfoDebug

Definition at line 125 of file VModule.h.

enum fwk::VModule::ResultFlag

inherited

Flag returned by module methods to the RunController.

Enumerator
eSuccess	Report success to RunController.
eFailure	Report failure to RunController, causing RunController to terminate execution.
eBreakLoop	Break current loop. It works for nested loops too!
eContinueLoop	Skip remaining modules in the current loop and continue with next iteration of the loop.

Definition at line 60 of file VModule.h.

enum fwk::VModule::VersionInfoType

inherited

Different types of version info that can be retrieved from GetVersionInfo.

Enumerator
eFilename
eRevisionNumber
eDate
eTime
eLastEditor

Definition at line 110 of file VModule.h.

Member Function Documentation

VModule::ResultFlag RdChannelBandpassFilter::RdChannelBandpassFilter::Finish ( )

overridevirtual

Finish: invoked at end of the run (NOT end of the event)

This method is for things that should be done at the end of the run (for example, closing files or writing out histograms) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 85 of file RdChannelBandpassFilter.cc.

References io::eSuccess.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag flag )

staticinherited

Definition at line 8 of file VModule.cc.

References fwk::VModule::eBreakLoop, fwk::VModule::eContinueLoop, fwk::VModule::eFailure, and fwk::VModule::eSuccess.

Referenced by fwk::RunController::DoNextInSequence(), fwk::RunController::FinishBranch(), and fwk::RunController::InitBranch().

utl::Stopwatch& fwk::VModule::GetStopwatch ( )

inlineinherited

Definition at line 106 of file VModule.h.

References fwk::VModule::fStopwatch.

const utl::Stopwatch& fwk::VModule::GetStopwatch ( ) const

inlineinherited

Definition at line 107 of file VModule.h.

References fwk::VModule::fStopwatch.

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType v ) const

inherited

Retrieve different sorts of module version info.

Definition at line 26 of file VModule.cc.

Referenced by fwk::CentralConfig::GetConfig(), ThresholdCalculatorKG::ThresholdCalculator::Init(), fdDoubleBumpFinder::FdDoubleBumpFinder::Init(), LaserGeneratorNA::LaserGenerator::Init(), LaserLightSimulatorNA::LaserLightSimulator::Init(), FdElectronicsSimulatorOG::FdElectronicsSimulator::Init(), TelescopeSimulatorKG::TelescopeSimulator::Init(), TelescopeSimulatorKG2::TelescopeSimulator::Init(), SdSimpleSimKG::SdSimpleSim::Init(), ShowerPhotonGeneratorOG::ShowerPhotonGenerator::Init(), and testRunController::testModuleVersionInfo().

VModule::ResultFlag RdChannelBandpassFilter::RdChannelBandpassFilter::Init ( )

overridevirtual

Initialize: invoked at beginning of run (NOT beginning of event)

This method is for things that should be done once at the beginning of a run (for example, booking histograms, performing calculations that need to be done only once, initializing parameters) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 24 of file RdChannelBandpassFilter.cc.

References io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, utl::megahertz, and ns.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

References fwk::VModule::fStopwatch, and utl::Stopwatch::Reset().

RdChannelBandpassFilter::RdChannelBandpassFilter::REGISTER_MODULE	(	"RdChannelBandpassFilter"	,
		RdChannelBandpassFilter
	)

private

VModule::ResultFlag RdChannelBandpassFilter::RdChannelBandpassFilter::Run ( evt::Event & event )

overridevirtual

Run: invoked once per event.

This method is for things that should be done once per event {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 53 of file RdChannelBandpassFilter.cc.

References io::eSuccess, utl::Trace< T >::GetSize(), evt::Event::HasREvent(), and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event & event )

inlineinherited

Definition at line 98 of file VModule.h.

References fwk::VModule::fStopwatch, fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by fwk::RunController::DoNextInSequence().

Member Data Documentation

double RdChannelBandpassFilter::RdChannelBandpassFilter::fDelay = 0

private

Definition at line 38 of file RdChannelBandpassFilter.h.

utl::AnalyticFilter* RdChannelBandpassFilter::RdChannelBandpassFilter::fFilter = nullptr

private

Definition at line 41 of file RdChannelBandpassFilter.h.

eFilterType RdChannelBandpassFilter::RdChannelBandpassFilter::fFilterType = Undefined

private

Definition at line 39 of file RdChannelBandpassFilter.h.

std::string RdChannelBandpassFilter::RdChannelBandpassFilter::fFilterTypeString = "Undefined"

private

Definition at line 40 of file RdChannelBandpassFilter.h.

int fwk::VModule::fInfoLevel = 0

protectedinherited

Definition at line 123 of file VModule.h.

Referenced by RdChannelASCIINoiseImporterRD::RdChannelASCIINoiseImporterRD::Init(), Rd2dLDFFitter::Rd2dLDFFitter::Init(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Init(), and Rd2dLDFFitter::Rd2dLDFFitter::Run().

double RdChannelBandpassFilter::RdChannelBandpassFilter::fLowerCutoffFrequency = 0

private

Definition at line 36 of file RdChannelBandpassFilter.h.

double RdChannelBandpassFilter::RdChannelBandpassFilter::fUpperCutoffFrequency = 0

private

Definition at line 37 of file RdChannelBandpassFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation