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

#include <RdStationPulseShapeRejector.h>

Inheritance diagram for RdStationPulseShapeRejector::RdStationPulseShapeRejector:
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

bool CheckT1Crossings (revt::Station &station, int peakInt)
 
void CheckT2Crossings (revt::Station &station, int peakInt)
 
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

int FindTraceMaximum (revt::Station &station)
 
bool IsSignalRising (const revt::StationTimeSeries &trace, int point)
 
 REGISTER_MODULE ("RdStationPulseShapeRejector", RdStationPulseShapeRejector)
 

Private Attributes

bool fCheckT1Crossings = true
 
bool fCheckT2Crossings = false
 
int fNCMax = 0
 
double fPulseRegion = 0
 
int fRejectedStations = 0
 
double fT1 = 0
 
double fT1MinSNR = 0
 
double fT2 = 0
 
double fT2MinSNR = 0
 
int fTotalStations = 0
 
double fTPer = 0
 
bool fUseVerticalComponent = true
 

Detailed Description

Definition at line 23 of file RdStationPulseShapeRejector.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 RdStationPulseShapeRejector::RdStationPulseShapeRejector::CheckT1Crossings ( revt::Station station,
int  peakInt 
)
void RdStationPulseShapeRejector::RdStationPulseShapeRejector::CheckT2Crossings ( revt::Station station,
int  peakInt 
)
int RdStationPulseShapeRejector::RdStationPulseShapeRejector::FindTraceMaximum ( revt::Station station)
private
fwk::VModule::ResultFlag RdStationPulseShapeRejector::RdStationPulseShapeRejector::Finish ( )
overridevirtual

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 275 of file RdStationPulseShapeRejector.cc.

References io::eSuccess, and INFOFinal.

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
fwk::VModule::ResultFlag RdStationPulseShapeRejector::RdStationPulseShapeRejector::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 31 of file RdStationPulseShapeRejector.cc.

References io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), and fwk::CentralConfig::GetTopBranch().

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

bool RdStationPulseShapeRejector::RdStationPulseShapeRejector::IsSignalRising ( const revt::StationTimeSeries trace,
int  point 
)
private
RdStationPulseShapeRejector::RdStationPulseShapeRejector::REGISTER_MODULE ( "RdStationPulseShapeRejector"  ,
RdStationPulseShapeRejector   
)
private
fwk::VModule::ResultFlag RdStationPulseShapeRejector::RdStationPulseShapeRejector::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 49 of file RdStationPulseShapeRejector.cc.

References revt::ePulseShapeDeselected, io::eSuccess, revt::Station::GetId(), INFODebug, INFOFinal, revt::Station::SetRejectedReason(), revt::REvent::SignalStationsBegin(), and revt::REvent::SignalStationsEnd().

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

Member Data Documentation

bool RdStationPulseShapeRejector::RdStationPulseShapeRejector::fCheckT1Crossings = true
private

Definition at line 38 of file RdStationPulseShapeRejector.h.

bool RdStationPulseShapeRejector::RdStationPulseShapeRejector::fCheckT2Crossings = false
private

Definition at line 39 of file RdStationPulseShapeRejector.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
int RdStationPulseShapeRejector::RdStationPulseShapeRejector::fNCMax = 0
private

Definition at line 46 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fPulseRegion = 0
private

Definition at line 43 of file RdStationPulseShapeRejector.h.

int RdStationPulseShapeRejector::RdStationPulseShapeRejector::fRejectedStations = 0
private

Definition at line 36 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fT1 = 0
private

Definition at line 40 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fT1MinSNR = 0
private

Definition at line 42 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fT2 = 0
private

Definition at line 41 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fT2MinSNR = 0
private

Definition at line 45 of file RdStationPulseShapeRejector.h.

int RdStationPulseShapeRejector::RdStationPulseShapeRejector::fTotalStations = 0
private

Definition at line 37 of file RdStationPulseShapeRejector.h.

double RdStationPulseShapeRejector::RdStationPulseShapeRejector::fTPer = 0
private

Definition at line 44 of file RdStationPulseShapeRejector.h.

bool RdStationPulseShapeRejector::RdStationPulseShapeRejector::fUseVerticalComponent = true
private

Definition at line 47 of file RdStationPulseShapeRejector.h.


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

, generated on Tue Sep 26 2023.