#include <RdStationRejector.h>

Inheritance diagram for RdStationRejector::RdStationRejector:

Classes
class	TimeRangeMap

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
typedef std::multimap < utl::TimeStamp, std::pair < utl::TimeStamp, size_t > >	ParentMap

Private Member Functions
void	ExcludeOrRejectStation (revt::Station &station, unsigned long long int reason)

	REGISTER_MODULE ("RdStationRejector", RdStationRejector)

Private Attributes
unsigned long long int	fBadPeriodReasons = 0

bool	fExcludeNlStations = true

bool	fExcludeStations = true

TimeRangeMap	fRejectMap

std::vector< int >	fStationList

bool	fUseBadPeriodDB = false

bool	fUseStationsInStationList = true

Detailed Description

Definition at line 23 of file RdStationRejector.h.

Member Typedef Documentation

typedef std::multimap<utl::TimeStamp, std::pair<utl::TimeStamp, size_t> > RdStationRejector::RdStationRejector::ParentMap

private

Definition at line 40 of file RdStationRejector.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 RdStationRejector::RdStationRejector::ExcludeOrRejectStation	(	revt::Station &	station,
		unsigned long long int	reason = `1`
	)

private

Definition at line 30 of file RdStationRejector.cc.

References revt::eInBadPeriod, revt::eManuallyExcluded, revt::Station::SetExcludedReason(), and revt::Station::SetRejectedReason().

VModule::ResultFlag RdStationRejector::RdStationRejector::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 204 of file RdStationRejector.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 RdStationRejector::RdStationRejector::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 44 of file RdStationRejector.cc.

References RdGeoCeLDFFitter::b, cevt::StationConstants::eNumRejectionStatusBits, ERROR, io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetFirstChild(), utl::Branch::GetTopBranch(), revt::gMapRejectionStatus, and INFOFinal.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdStationRejector::RdStationRejector::REGISTER_MODULE	(	"RdStationRejector"	,
		RdStationRejector
	)

private

VModule::ResultFlag RdStationRejector::RdStationRejector::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 103 of file RdStationRejector.cc.

References revt::eManuallyExcluded, io::eSuccess, rdet::RDetector::GetBadStationReason(), evt::Event::GetHeader(), rdet::Station::GetId(), det::Detector::GetRDetector(), rdet::RDetector::GetStation(), revt::REvent::GetStation(), evt::Header::GetTime(), det::Detector::GetTime(), evt::Event::HasREvent(), revt::REvent::HasStation(), INFO, INFOFinal, INFOIntermediate, utl::String::OfSortedIds(), utl::String::Plural(), det::Detector::Update(), 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

unsigned long long int RdStationRejector::RdStationRejector::fBadPeriodReasons = 0

private

Definition at line 38 of file RdStationRejector.h.

bool RdStationRejector::RdStationRejector::fExcludeNlStations = true

private

Definition at line 35 of file RdStationRejector.h.

bool RdStationRejector::RdStationRejector::fExcludeStations = true

private

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

TimeRangeMap RdStationRejector::RdStationRejector::fRejectMap

private

Definition at line 64 of file RdStationRejector.h.

std::vector<int> RdStationRejector::RdStationRejector::fStationList

private

Definition at line 33 of file RdStationRejector.h.

bool RdStationRejector::RdStationRejector::fUseBadPeriodDB = false

private

Definition at line 37 of file RdStationRejector.h.

bool RdStationRejector::RdStationRejector::fUseStationsInStationList = true

private

Definition at line 32 of file RdStationRejector.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation