Perform pile-up correction. More...

#include <MdPileUpCorrecterAG/MdPileUpCorrecter.h>

Inheritance diagram for MdPileUpCorrecterAG::MdPileUpCorrecter:

Public Types
enum	ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
	Flag returned by module methods to the RunController. More...

enum	Strategy { eInhibit }
	Kind of possible counting criteria to be used. 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
VModule::ResultFlag	Finish ()
	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...

VModule::ResultFlag	Init ()
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

	MdPileUpCorrecter ()

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

ResultFlag	RunWithTiming (evt::Event &event)

	~MdPileUpCorrecter ()

Static Public Member Functions
static std::string	GetResultFlagByName (const ResultFlag flag)

Static Public Attributes
static const char *const	kStrategyTags [] = { "Inhibit" }
	Tags for the types of strategy. More...

Protected Types
enum	InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }

Protected Attributes
int	fInfoLevel = 0

Private Member Functions
void	InitTable (std::unique_ptr< utl::TabularStream > &pt, unsigned int nCol) const
	Helper to init a tabular stream. More...

	REGISTER_MODULE ("MdPileUpCorrecter", MdPileUpCorrecter)

Private Attributes
std::unique_ptr < VPileUpCorrecterFunctor >	fCorrecter
	Object performing the pattern identification on individuals channels. More...

utl::MessageLoggerConfig	fLog
	Output messages handler. More...

Strategy	fStrategy
	Counting stategy to be performed. More...

utl::UnitsConfig	fUnits
	Units configuration. More...

Detailed Description

Perform pile-up correction.

Author: XX

Date: 07 June 2022

Definition at line 39 of file MdPileUpCorrecter.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 MdPileUpCorrecterAG::MdPileUpCorrecter::Strategy

Kind of possible counting criteria to be used.

Enumerator
eInhibit

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

MdPileUpCorrecterAG::MdPileUpCorrecter::MdPileUpCorrecter ( )

inline

Definition at line 49 of file MdPileUpCorrecter.h.

MdPileUpCorrecterAG::MdPileUpCorrecter::~MdPileUpCorrecter ( )

inline

Definition at line 50 of file MdPileUpCorrecter.h.

Member Function Documentation

VModule::ResultFlag MdPileUpCorrecterAG::MdPileUpCorrecter::Finish ( )

virtual

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 170 of file MdPileUpCorrecter.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 MdPileUpCorrecterAG::MdPileUpCorrecter::Init ( )

virtual

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 35 of file MdPileUpCorrecter.cc.

References utl::ConsecutiveEnumFactory< EnumType, last, tags, NoConversionPolicy, first >::Create(), io::eSuccess, fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), utl::LoadConfig(), and utl::ns.

void MdPileUpCorrecterAG::MdPileUpCorrecter::InitTable	(	std::unique_ptr< utl::TabularStream > &	pt,
		unsigned int	nCol
	)		const

private

Helper to init a tabular stream.

Definition at line 176 of file MdPileUpCorrecter.cc.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

MdPileUpCorrecterAG::MdPileUpCorrecter::REGISTER_MODULE	(	"MdPileUpCorrecter"	,
		MdPileUpCorrecter
	)

private

VModule::ResultFlag MdPileUpCorrecterAG::MdPileUpCorrecter::Run ( evt::Event & event )

virtual

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 59 of file MdPileUpCorrecter.cc.

References utl::Trace< T >::At(), mevt::MEvent::CountersBegin(), mevt::MEvent::CountersEnd(), utl::endc, utl::endr, io::eSuccess, mdet::Scintillator::GetArea(), mdet::FrontEndSiPM::GetBufferLength(), mdet::FrontEnd::GetBufferLength(), mdet::MDetector::GetCounter(), mdet::Module::GetFrontEnd(), mdet::Module::GetFrontEndSiPM(), mevt::Counter::GetId(), mevt::Module::GetId(), mdet::Counter::GetModule(), mevt::Module::GetRejectionReason(), evt::Event::HasMEvent(), utl::hline(), INFO, mevt::Counter::IsRejected(), mevt::Module::IsRejected(), mdet::Module::IsSiPM(), mevt::Counter::ModulesBegin(), mevt::Counter::ModulesEnd(), utl::s, mdet::Module::ScintillatorsBegin(), mevt::ModuleRecData::SetNumberOfEstimatedMuons(), det::DetectorComponent< C, ManagerProvider >::str(), 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

std::unique_ptr<VPileUpCorrecterFunctor> MdPileUpCorrecterAG::MdPileUpCorrecter::fCorrecter

private

Object performing the pattern identification on individuals channels.

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

utl::MessageLoggerConfig MdPileUpCorrecterAG::MdPileUpCorrecter::fLog

private

Output messages handler.

Definition at line 57 of file MdPileUpCorrecter.h.

Strategy MdPileUpCorrecterAG::MdPileUpCorrecter::fStrategy

private

Counting stategy to be performed.

Definition at line 65 of file MdPileUpCorrecter.h.

utl::UnitsConfig MdPileUpCorrecterAG::MdPileUpCorrecter::fUnits

private

Units configuration.

Definition at line 71 of file MdPileUpCorrecter.h.

const char *const MdPileUpCorrecterAG::MdPileUpCorrecter::kStrategyTags = { "Inhibit" }

static

Tags for the types of strategy.

Definition at line 47 of file MdPileUpCorrecter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation