#include <RdStationRiseTimeCalculator.h>

Inheritance diagram for RdStationRiseTimeCalculator::RdStationRiseTimeCalculator:

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 ()

	RdStationRiseTimeCalculator ()

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

ResultFlag	RunWithTiming (evt::Event &event)

virtual	~RdStationRiseTimeCalculator ()

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	GetRiseTime (const unsigned int startCumulative, const unsigned int stopCumulative, std::vector< double > &normalizedCumulative, unsigned int &minCumulative, unsigned int &maxCumulative) const

void	MakeCumulative (const revt::StationTimeSeries &Stationtrace, const unsigned int startRiseTimeWindow, const unsigned int stopRiseTimeWindow, std::vector< double > &cumulative, double &cumulativeSum, unsigned int chwithmaxSNR) const

	REGISTER_MODULE ("RdStationRiseTimeCalculator", RdStationRiseTimeCalculator)

Private Attributes
unsigned int	fRiseTimeWindow = 0

Detailed Description

Definition at line 29 of file RdStationRiseTimeCalculator.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.

Constructor & Destructor Documentation

RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::RdStationRiseTimeCalculator ( )

inline

Definition at line 32 of file RdStationRiseTimeCalculator.h.

virtual RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::~RdStationRiseTimeCalculator ( )

inlinevirtual

Definition at line 33 of file RdStationRiseTimeCalculator.h.

Member Function Documentation

fwk::VModule::ResultFlag RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::Finish ( )

inlineoverridevirtual

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 37 of file RdStationRiseTimeCalculator.h.

References fwk::VModule::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().

void RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::GetRiseTime	(	const unsigned int	startCumulative,
		const unsigned int	stopCumulative,
		std::vector< double > &	normalizedCumulative,
		unsigned int &	minCumulative,
		unsigned int &	maxCumulative
	)		const

private

Definition at line 173 of file RdStationRiseTimeCalculator.cc.

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 RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::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 37 of file RdStationRiseTimeCalculator.cc.

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

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

void RdStationRiseTimeCalculator::RdStationRiseTimeCalculator::MakeCumulative	(	const revt::StationTimeSeries &	Stationtrace,
		const unsigned int	startRiseTimeWindow,
		const unsigned int	stopRiseTimeWindow,
		std::vector< double > &	cumulative,
		double &	cumulativeSum,
		unsigned int	chwithmaxSNR
	)		const