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

#include <RdChannelNoisePulseCounter.h>

Inheritance diagram for RdChannelNoisePulseCounter::RdChannelNoisePulseCounter:
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 ()
 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 ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 RdChannelNoisePulseCounter ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 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 }
 

Private Member Functions

double FindPulse (revt::Station &station)
 
 REGISTER_MODULE ("RdChannelNoisePulseCounter", RdChannelNoisePulseCounter)
 

Private Attributes

std::map< int, int > fCoincidentPulses
 
bool fFirstEvent
 
int fInfoLevel
 
double fMaximumNeighborDistance
 
int fMaximumStationId
 
int fMinimumStationId
 
NoisePulseData fNoisePulseData
 
int fNumberOfEvents
 
std::string fOutputFilename
 
std::string fOutputPath
 
double fSNRThreshold
 
std::map< int, NoisePulseDatafStationNoisePulseData
 

Detailed Description

Definition at line 39 of file RdChannelNoisePulseCounter.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.

Constructor & Destructor Documentation

RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::RdChannelNoisePulseCounter ( )

Definition at line 34 of file RdChannelNoisePulseCounter.cc.

Member Function Documentation

double RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::FindPulse ( revt::Station station)
private
VModule::ResultFlag RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::Finish ( )
virtual
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 RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::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 48 of file RdChannelNoisePulseCounter.cc.

References fwk::VModule::eSuccess, fInfoLevel, fMaximumNeighborDistance, fMaximumStationId, fMinimumStationId, fOutputFilename, fOutputPath, fSNRThreshold, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), and INFO.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::REGISTER_MODULE ( "RdChannelNoisePulseCounter"  ,
RdChannelNoisePulseCounter   
)
private
VModule::ResultFlag RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

std::map<int, int> RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fCoincidentPulses
private

Definition at line 66 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Run().

bool RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fFirstEvent
private

Definition at line 57 of file RdChannelNoisePulseCounter.h.

int RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fInfoLevel
private

Definition at line 55 of file RdChannelNoisePulseCounter.h.

Referenced by Init().

double RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fMaximumNeighborDistance
private

Definition at line 63 of file RdChannelNoisePulseCounter.h.

Referenced by Init(), and Run().

int RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fMaximumStationId
private

Definition at line 62 of file RdChannelNoisePulseCounter.h.

Referenced by Init().

int RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fMinimumStationId
private

Definition at line 61 of file RdChannelNoisePulseCounter.h.

Referenced by Init(), and Run().

NoisePulseData RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fNoisePulseData
private

Definition at line 64 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Run().

int RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fNumberOfEvents
private

Definition at line 58 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Run().

std::string RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fOutputFilename
private

Definition at line 60 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Init().

std::string RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fOutputPath
private

Definition at line 59 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Init().

double RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fSNRThreshold
private

Definition at line 56 of file RdChannelNoisePulseCounter.h.

Referenced by Init(), and Run().

std::map<int, NoisePulseData> RdChannelNoisePulseCounter::RdChannelNoisePulseCounter::fStationNoisePulseData
private

Definition at line 65 of file RdChannelNoisePulseCounter.h.

Referenced by Finish(), and Run().


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

, generated on Tue Sep 26 2023.