Correct gain ratio (D/A) for UB. More...

#include <SdGainRatioCorrector.h>

Inheritance diagram for SdGainRatioCorrectorKG::SdGainRatioCorrector:

Classes
struct	Factors

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::map< int, Factors >	StationFactors

typedef std::map< int, StationFactors >	YearStationFactors

Private Member Functions
	REGISTER_MODULE ("SdGainRatioCorrectorKG", SdGainRatioCorrector)

Private Attributes
double	fCalibrationVersion12GainFactor = 0

YearStationFactors	fFactors

bool	fUseGainRatioCorrections = false

Detailed Description

Correct gain ratio (D/A) for UB.

Author: Tobias Schulz; Darko Veberic

Date: 28 March 2023

Definition at line 24 of file SdGainRatioCorrector.h.

Member Typedef Documentation

typedef std::map<int, Factors> SdGainRatioCorrectorKG::SdGainRatioCorrector::StationFactors

private

Definition at line 39 of file SdGainRatioCorrector.h.

typedef std::map<int, StationFactors> SdGainRatioCorrectorKG::SdGainRatioCorrector::YearStationFactors

private

Definition at line 40 of file SdGainRatioCorrector.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

fwk::VModule::ResultFlag SdGainRatioCorrectorKG::SdGainRatioCorrector::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 29 of file SdGainRatioCorrector.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().

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

fwk::VModule::ResultFlag SdGainRatioCorrectorKG::SdGainRatioCorrector::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 162 of file SdGainRatioCorrector.cc.

References fwk::VModule::eFailure, ERROR, fwk::VModule::eSuccess, fCalibrationVersion12GainFactor, fFactors, SdGainRatioCorrectorKG::SdGainRatioCorrector::Factors::fgNPmts, filename, fUseGainRatioCorrections, utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), utl::Accumulator::Min< T >::GetMin(), fwk::CentralConfig::GetTopBranch(), SdGainRatioCorrectorKG::HasAllCounts(), INFO, and utl::s.