RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor Class Reference

#include <RdChannelLinearPredictorRFISuppressor.h>

Inheritance diagram for RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor:

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
void	FillSampleDataWithRelevantValuesForFirstChannel (SampleData &samples, revt::ChannelTimeSeries const &timeseries, revt::Station const &station)
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)
fwk::VModule::ResultFlag	TestSampleDataForConsistency (SampleData &samples, revt::ChannelTimeSeries const &timeseries)

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
	REGISTER_MODULE ("RdChannelLinearPredictorRFISuppressor", RdChannelLinearPredictorRFISuppressor)
bool	TestOverlap (int a1, int a2, int b1, int b2)
unsigned int	TranslateTimeToSample (double time, double binning, char const *name)

Private Attributes
double	fDelayLine = 0
double	fFudgeFactor = 0
double	fMinimumTrainRegionLength = 0
unsigned int	fNumChannels = 0
unsigned int	fOptimization = 0
double	fSegmentLength = 0
double	fTrainRegionStartOverride = 0
double	fTrainRegionStopOverride = 0
double	fWindowMargins = 0

Detailed Description

Definition at line 43 of file RdChannelLinearPredictorRFISuppressor.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

void RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::FillSampleDataWithRelevantValuesForFirstChannel	(	SampleData &	samples,
		revt::ChannelTimeSeries const &	timeseries,
		revt::Station const &	station
	)

Definition at line 127 of file RdChannelLinearPredictorRFISuppressor.cc.

References RdChannelLinearPredictorRFISuppressor::SampleData::fBinning, RdChannelLinearPredictorRFISuppressor::SampleData::fDelayLine, RdChannelLinearPredictorRFISuppressor::SampleData::fMinimumTrainRegionLength, RdChannelLinearPredictorRFISuppressor::SampleData::fNumCoefficients, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion1Start, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion1Stop, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion2Start, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion2Stop, RdChannelLinearPredictorRFISuppressor::SampleData::fTotalTraceLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTraceLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStart, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStop, utl::Trace< T >::GetBinning(), revt::StationRecData::GetParameter(), revt::Station::GetRecData(), utl::Trace< T >::GetSize(), utl::Trace< T >::GetStart(), and utl::Trace< T >::GetStop().

VModule::ResultFlag RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::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 379 of file RdChannelLinearPredictorRFISuppressor.cc.

References io::eSuccess, and INFO.

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 RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::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 100 of file RdChannelLinearPredictorRFISuppressor.cc.

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

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::REGISTER_MODULE ( "RdChannelLinearPredictorRFISuppressor"  , RdChannelLinearPredictorRFISuppressor    )

private

VModule::ResultFlag RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::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 259 of file RdChannelLinearPredictorRFISuppressor.cc.

References ERROR, io::eSuccess, RdChannelLinearPredictorRFISuppressor::SampleData::fDelayLine, RdChannelLinearPredictorRFISuppressor::SampleData::fNumCoefficients, RdChannelLinearPredictorRFISuppressor::SampleData::fTotalTraceLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTraceLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStart, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStop, revt::REvent::GetHeader(), revt::Header::GetId(), evt::Event::HasREvent(), RdChannelLinearPredictorRFISuppressor::SampleData::HelpOutput(), INFO, OUT, RdChannelLinearPredictorRFISuppressor::LinearPredictor::predict(), RdChannelLinearPredictorRFISuppressor::LinearPredictor::train(), 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().

bool RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::TestOverlap ( int  a1, int  a2, int  b1, int  b2  )

private

Definition at line 85 of file RdChannelLinearPredictorRFISuppressor.cc.

VModule::ResultFlag RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::TestSampleDataForConsistency	(	SampleData &	samples,
		revt::ChannelTimeSeries const &	timeseries
	)

Definition at line 185 of file RdChannelLinearPredictorRFISuppressor.cc.

References ERROR, io::eSuccess, RdChannelLinearPredictorRFISuppressor::SampleData::fBinning, RdChannelLinearPredictorRFISuppressor::SampleData::fDelayLine, RdChannelLinearPredictorRFISuppressor::SampleData::fMinimumTrainRegionLength, RdChannelLinearPredictorRFISuppressor::SampleData::fNumCoefficients, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion1Start, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion1Stop, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion2Start, RdChannelLinearPredictorRFISuppressor::SampleData::fOccupiedRegion2Stop, RdChannelLinearPredictorRFISuppressor::SampleData::fTraceLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionLength, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStart, RdChannelLinearPredictorRFISuppressor::SampleData::fTrainRegionStop, utl::Trace< T >::GetBinning(), utl::Trace< T >::GetSize(), utl::Trace< T >::GetStart(), utl::Trace< T >::GetStop(), RdChannelLinearPredictorRFISuppressor::SampleData::HelpOutput(), and WARNING.

unsigned int RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::TranslateTimeToSample ( double  time, double  binning, char const *  name  )

private

Definition at line 68 of file RdChannelLinearPredictorRFISuppressor.cc.

References utl::abs(), INFOIntermediate, and utl::nanosecond.

Member Data Documentation

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fDelayLine = 0

private

Definition at line 57 of file RdChannelLinearPredictorRFISuppressor.h.

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fFudgeFactor = 0

private

Definition at line 60 of file RdChannelLinearPredictorRFISuppressor.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 RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fMinimumTrainRegionLength = 0

private

Definition at line 61 of file RdChannelLinearPredictorRFISuppressor.h.

unsigned int RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fNumChannels = 0

private

Definition at line 63 of file RdChannelLinearPredictorRFISuppressor.h.

unsigned int RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fOptimization = 0

private

Definition at line 64 of file RdChannelLinearPredictorRFISuppressor.h.

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fSegmentLength = 0

private

Definition at line 56 of file RdChannelLinearPredictorRFISuppressor.h.

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fTrainRegionStartOverride = 0

private

Definition at line 58 of file RdChannelLinearPredictorRFISuppressor.h.

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fTrainRegionStopOverride = 0

private

Definition at line 59 of file RdChannelLinearPredictorRFISuppressor.h.

double RdChannelLinearPredictorRFISuppressor::RdChannelLinearPredictorRFISuppressor::fWindowMargins = 0

private

Definition at line 62 of file RdChannelLinearPredictorRFISuppressor.h.

---

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

• RdChannelLinearPredictorRFISuppressor.h
• RdChannelLinearPredictorRFISuppressor.cc