#include <RdChannelBeaconSuppressor.h>

Inheritance diagram for RdChannelBeaconSuppressor::RdChannelBeaconSuppressor:

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
void	BeaconSuppressor (revt::ChannelFrequencySpectrum &)
	Replaces the amplitude of the spectrum by a median amplitude. More...

	REGISTER_MODULE ("RdChannelBeaconSuppressor", RdChannelBeaconSuppressor)

Private Attributes
bool	fCompensateTotalSpectrumPower = true
	Compensate total spectrum power. More...

bool	fGetBeaconFrequenciesFromDatabase = true
	Flag noting if beacon frequencies should be taken automatically from database. More...

double	fNeighbouringBandwidthToBeSurpressed = 0
	Surrounding bandwidth (left + right) to be surpressed in addition to the specified bins. More...

unsigned int	fNeighbouringBinsToBeSurpressed = 0
	Surrounding bins (left + right) to be surpressed in addition to the specified bins. More...

double	fSurpressionFactor = 1e-20
	Surpression factor to be multiplied to the spectrum amplitude of the surpressed bins. More...

std::vector< double >	fXMLFrequencies
	Vector of frequencies imported from the XML file. More...

Detailed Description

Definition at line 29 of file RdChannelBeaconSuppressor.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 RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::BeaconSuppressor ( revt::ChannelFrequencySpectrum & )

private

Replaces the amplitude of the spectrum by a median amplitude.

VModule::ResultFlag RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::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 202 of file RdChannelBeaconSuppressor.cc.

References io::eSuccess, and INFOFinal.

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 RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::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 41 of file RdChannelBeaconSuppressor.cc.

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

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::REGISTER_MODULE	(	"RdChannelBeaconSuppressor"	,
		RdChannelBeaconSuppressor
	)

private

VModule::ResultFlag RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::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}

instantiate set of frequency bins, regenerated for each station as in principle the binning can be different from station to station

Implements fwk::VModule.

Definition at line 61 of file RdChannelBeaconSuppressor.cc.

References utl::abs(), revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), ERROR, io::eSuccess, rdet::RDetector::GetBeaconFrequencies(), revt::Channel::GetChannelFrequencySpectrum(), rdet::Channel::GetDesignLowerFreq(), rdet::Channel::GetDesignUpperFreq(), revt::Channel::GetFrequencyOfBin(), revt::Channel::GetId(), revt::Station::GetId(), det::Detector::GetRDetector(), rdet::RDetector::GetStation(), revt::Channel::GetStationId(), evt::Event::HasREvent(), INFODebug, INFOFinal, INFOIntermediate, revt::Channel::IsActive(), max, utl::megahertz, utl::MHz, sqrt(), revt::REvent::StationsBegin(), and revt::REvent::StationsEnd().

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

bool RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fCompensateTotalSpectrumPower = true

private

Compensate total spectrum power.

Definition at line 53 of file RdChannelBeaconSuppressor.h.

bool RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fGetBeaconFrequenciesFromDatabase = true

private

Flag noting if beacon frequencies should be taken automatically from database.

Definition at line 41 of file RdChannelBeaconSuppressor.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 RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fNeighbouringBandwidthToBeSurpressed = 0

private

Surrounding bandwidth (left + right) to be surpressed in addition to the specified bins.

Definition at line 50 of file RdChannelBeaconSuppressor.h.

unsigned int RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fNeighbouringBinsToBeSurpressed = 0

private

Surrounding bins (left + right) to be surpressed in addition to the specified bins.

Definition at line 47 of file RdChannelBeaconSuppressor.h.

double RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fSurpressionFactor = 1e-20

private

Surpression factor to be multiplied to the spectrum amplitude of the surpressed bins.

Definition at line 44 of file RdChannelBeaconSuppressor.h.

std::vector<double> RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::fXMLFrequencies

private

Vector of frequencies imported from the XML file.

Definition at line 38 of file RdChannelBeaconSuppressor.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