List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | Private Attributes
SdBaselineFinderOG::SdBaselineFinder Class Reference

Finds baseline (based on flat pieces) More...

#include "SdBaselineFinderOG/SdBaselineFinder.h"

Inheritance diagram for SdBaselineFinderOG::SdBaselineFinder:
Inheritance graph
[legend]

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::StopwatchGetStopwatch ()
 
const utl::StopwatchGetStopwatch () 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

bool ComputeBaseline (const sevt::Station &station, sevt::PMT &pmt, const sdet::PMTConstants::PMTGain gain) const
 
bool ComputeBaselines (sevt::Station &station) const
 
void MakeFlatBaseline (sevt::PMT &pmt, const sdet::PMTConstants::PMTGain gain) const
 
 REGISTER_MODULE ("SdBaselineFinderOG", SdBaselineFinder)
 

Private Attributes

bool fApplyBackwardFlatPieceCheck = false
 
bool fDecreaseLGFlatPieceTolerance = false
 

Detailed Description

Finds baseline (based on flat pieces)

Author
Stefano Argiro
Darko Veberic
Xavier Bertou
Allan Payeras
Date
08 Oct 2003
30 Sep 2004 DV: update, CDAS v3r2 sync
20 Oct 2004 DV: update, CDAS v3r4 sync
05 Apr 2005 DV: update, CDAS v4r0 sync, not much changed
02 Oct 2007 DV: update based on Xavier's code in CDAS v4r6
Jun 2022 AP: split SdCalibratorOG into separate modules

Definition at line 30 of file SdBaselineFinder.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.

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

bool SdBaselineFinderOG::SdBaselineFinder::ComputeBaseline ( const sevt::Station station,
sevt::PMT pmt,
const sdet::PMTConstants::PMTGain  gain 
) const
private
bool SdBaselineFinderOG::SdBaselineFinder::ComputeBaselines ( sevt::Station station) const
private
fwk::VModule::ResultFlag SdBaselineFinderOG::SdBaselineFinder::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 35 of file SdBaselineFinder.h.

References fwk::VModule::eSuccess.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
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
VModule::ResultFlag SdBaselineFinderOG::SdBaselineFinder::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 42 of file SdBaselineFinder.cc.

References io::eSuccess, 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().

void SdBaselineFinderOG::SdBaselineFinder::MakeFlatBaseline ( sevt::PMT pmt,
const sdet::PMTConstants::PMTGain  gain 
) const
private
SdBaselineFinderOG::SdBaselineFinder::REGISTER_MODULE ( "SdBaselineFinderOG"  ,
SdBaselineFinder   
)
private
VModule::ResultFlag SdBaselineFinderOG::SdBaselineFinder::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 60 of file SdBaselineFinder.cc.

References utl::abs(), cevt::StationConstants::eBadCalib, io::eSuccess, and evt::Event::HasSEvent().

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

bool SdBaselineFinderOG::SdBaselineFinder::fApplyBackwardFlatPieceCheck = false
private

Definition at line 44 of file SdBaselineFinder.h.

bool SdBaselineFinderOG::SdBaselineFinder::fDecreaseLGFlatPieceTolerance = false
private

Definition at line 43 of file SdBaselineFinder.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited

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

, generated on Tue Sep 26 2023.