#include <RdChannelBandstopFilter.h>

Inheritance diagram for RdChannelBandstopFilter::RdChannelBandstopFilter:

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 Member Functions
bool	CloseTo (const double a, const double b, const double tolerance)

void	CutNoiseFrequencies (revt::Channel &channel, const rdet::Channel &detChannel)

	REGISTER_MODULE ("RdChannelBandstopFilter", RdChannelBandstopFilter)

Private Attributes
const double	fEastWest = -0.0607375

std::vector< double >	fLowerBoundsEW

std::vector< double >	fLowerBoundsNS

const double	fNorthSouth = 1.51006

double	fOnlineBandstopFilterDeviationFactor = 0

std::string	fOnlineBandstopFilterSpectrumBaseline

const double	fTolerance = 2 * utl::deg

std::vector< double >	fUpperBoundsEW

std::vector< double >	fUpperBoundsNS

bool	fUseOnlineBandstopFilter = false

Detailed Description

Definition at line 23 of file RdChannelBandstopFilter.h.

Member Enumeration Documentation

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

bool RdChannelBandstopFilter::RdChannelBandstopFilter::CloseTo	(	const double	a,
		const double	b,
		const double	tolerance
	)

private

Definition at line 195 of file RdChannelBandstopFilter.cc.

void RdChannelBandstopFilter::RdChannelBandstopFilter::CutNoiseFrequencies	(	revt::Channel &	channel,
		const rdet::Channel &	detChannel
	)

private

Definition at line 156 of file RdChannelBandstopFilter.cc.

References revt::Channel::GetFFTDataContainer(), utl::FFTDataContainer< C, T, F >::GetFrequencySpectrum(), revt::Channel::GetId(), rdet::Channel::GetOrientationAzimuth(), INFOIntermediate, and utl::MHz.

VModule::ResultFlag RdChannelBandstopFilter::RdChannelBandstopFilter::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 149 of file RdChannelBandstopFilter.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 RdChannelBandstopFilter::RdChannelBandstopFilter::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 28 of file RdChannelBandstopFilter.cc.

References ERROR, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), and utl::Branch::GetTopBranch().

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelBandstopFilter::RdChannelBandstopFilter::REGISTER_MODULE	(	"RdChannelBandstopFilter"	,
		RdChannelBandstopFilter
	)

private

VModule::ResultFlag RdChannelBandstopFilter::RdChannelBandstopFilter::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 70 of file RdChannelBandstopFilter.cc.

References utl::abs(), io::eSuccess, freq, rdet::Channel::GetDesignLowerFreq(), rdet::Channel::GetDesignUpperFreq(), utl::FFTDataContainer< C, T, F >::GetFrequencySpectrum(), rdet::RDetector::GetStation(), evt::Event::HasREvent(), INFODebug, INFOIntermediate, un2::Mean(), utl::MHz, utl::Trace< T >::PushBack(), un2::StandardDeviation(), 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

const double RdChannelBandstopFilter::RdChannelBandstopFilter::fEastWest = -0.0607375

private

Definition at line 44 of file RdChannelBandstopFilter.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().

std::vector<double> RdChannelBandstopFilter::RdChannelBandstopFilter::fLowerBoundsEW

private

Definition at line 34 of file RdChannelBandstopFilter.h.

std::vector<double> RdChannelBandstopFilter::RdChannelBandstopFilter::fLowerBoundsNS

private

Definition at line 32 of file RdChannelBandstopFilter.h.

const double RdChannelBandstopFilter::RdChannelBandstopFilter::fNorthSouth = 1.51006

private

Definition at line 43 of file RdChannelBandstopFilter.h.

double RdChannelBandstopFilter::RdChannelBandstopFilter::fOnlineBandstopFilterDeviationFactor = 0

private

Definition at line 39 of file RdChannelBandstopFilter.h.

std::string RdChannelBandstopFilter::RdChannelBandstopFilter::fOnlineBandstopFilterSpectrumBaseline

private

Definition at line 38 of file RdChannelBandstopFilter.h.

const double RdChannelBandstopFilter::RdChannelBandstopFilter::fTolerance = 2 * utl::deg

private

Definition at line 42 of file RdChannelBandstopFilter.h.

std::vector<double> RdChannelBandstopFilter::RdChannelBandstopFilter::fUpperBoundsEW

private

Definition at line 35 of file RdChannelBandstopFilter.h.

std::vector<double> RdChannelBandstopFilter::RdChannelBandstopFilter::fUpperBoundsNS

private

Definition at line 33 of file RdChannelBandstopFilter.h.

bool RdChannelBandstopFilter::RdChannelBandstopFilter::fUseOnlineBandstopFilter = false

private

Definition at line 37 of file RdChannelBandstopFilter.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 Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation