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

#include <RdChannelBeaconSignalExtractor.h>

Inheritance diagram for RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor:
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 ()
 
 RdChannelBeaconSignalExtractor ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
virtual ~RdChannelBeaconSignalExtractor ()
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Private Types

enum  InfoLevel {
  eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3,
  eMinuit = 4, eDebug = 5
}
 

Private Member Functions

void matchStationTimeStamps (revt::REvent &) const
 
 REGISTER_MODULE ("RdChannelBeaconSignalExtractor", RdChannelBeaconSignalExtractor)
 

Private Attributes

std::vector< double > fBeaconFrequencies
 Vector of frequencies emitted by the beacon. More...
 
int fInfoLevel
 xml settings: info level (verbosity) More...
 
int fReferenceChannel
 Reference channel (ususally 1 = NS, high gain) More...
 

Detailed Description

Definition at line 38 of file RdChannelBeaconSignalExtractor.h.

Member Enumeration Documentation

Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eMinuit 
eDebug 

Definition at line 52 of file RdChannelBeaconSignalExtractor.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

RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor ( )

Definition at line 47 of file RdChannelBeaconSignalExtractor.cc.

RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::~RdChannelBeaconSignalExtractor ( )
virtual

Definition at line 55 of file RdChannelBeaconSignalExtractor.cc.

Member Function Documentation

VModule::ResultFlag RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::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 245 of file RdChannelBeaconSignalExtractor.cc.

References fwk::VModule::eSuccess, and INFO.

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 RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::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 61 of file RdChannelBeaconSignalExtractor.cc.

References eDebug, fwk::VModule::eFailure, ERROR, fwk::VModule::eSuccess, fBeaconFrequencies, fInfoLevel, fReferenceChannel, 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().

void RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::matchStationTimeStamps ( revt::REvent rEvent) const
private

Internal storage of amplitude: for each beacon frequency one phase for each station + channel shifts all traces in time, such that they match the time stamp of the first station

Definition at line 257 of file RdChannelBeaconSignalExtractor.cc.

References revt::REvent::CandidateStationsBegin(), revt::REvent::CandidateStationsEnd(), revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), revt::Channel::GetFFTDataContainer(), revt::StationRecData::GetParameter(), revt::Station::GetRecData(), and revt::StationRecData::SetParameter().

Referenced by Run().

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

Member Data Documentation

std::vector<double> RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::fBeaconFrequencies
private

Vector of frequencies emitted by the beacon.

Definition at line 65 of file RdChannelBeaconSignalExtractor.h.

Referenced by Init(), and Run().

int RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::fInfoLevel
private

xml settings: info level (verbosity)

Definition at line 62 of file RdChannelBeaconSignalExtractor.h.

Referenced by Init(), and Run().

int RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::fReferenceChannel
private

Reference channel (ususally 1 = NS, high gain)

Definition at line 68 of file RdChannelBeaconSignalExtractor.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.