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

#include <RdTimeCalibration.h>

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

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 ("RdTimeCalibration", RdTimeCalibration)
 

Private Attributes

bool fAdjustTime
 adjust time yes or no (usually no = 0) More...
 
char fBand
 
std::string fEllipsoidName
 
bool fFirstRun
 flag, that the expectation is calculated just once More...
 
int fInfoLevel
 xml settings: info level (verbosity) More...
 
int fReferenceAntennaID
 Reference Antenna (ususally 113) More...
 
int fReferenceChannel
 Reference channel (ususally 1 = NS, high gain) More...
 
std::map< int, std::vector
< double > > 
fRunTimeExpectation
 map of the expected runtime More...
 
std::vector< double > fSourcePosition
 Postion of the calibration source. More...
 
int fZone
 Band, zone, ellipsoid for the used coordinates. More...
 

Detailed Description

Definition at line 46 of file RdTimeCalibration.h.

Member Enumeration Documentation

Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eMinuit 
eDebug 

Definition at line 60 of file RdTimeCalibration.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

RdTimeCalibration::RdTimeCalibration::RdTimeCalibration ( )

Definition at line 55 of file RdTimeCalibration.cc.

virtual RdTimeCalibration::RdTimeCalibration::~RdTimeCalibration ( )
inlinevirtual

Definition at line 53 of file RdTimeCalibration.h.

Member Function Documentation

VModule::ResultFlag RdTimeCalibration::RdTimeCalibration::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 296 of file RdTimeCalibration.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 RdTimeCalibration::RdTimeCalibration::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 70 of file RdTimeCalibration.cc.

References fwk::VModule::eBreakLoop, eDebug, fwk::VModule::eFailure, ERROR, fwk::VModule::eSuccess, fAdjustTime, fEllipsoidName, fInfoLevel, fReferenceAntennaID, fReferenceChannel, fSourcePosition, utl::Branch::GetChild(), utl::Branch::GetData(), utl::UTMPoint::GetEasting(), utl::UTMPoint::GetHeight(), utl::UTMPoint::GetNorthing(), utl::Branch::GetTopBranch(), INFO, and WARNING.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

void RdTimeCalibration::RdTimeCalibration::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 308 of file RdTimeCalibration.cc.

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

Referenced by Run().

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

Member Data Documentation

bool RdTimeCalibration::RdTimeCalibration::fAdjustTime
private

adjust time yes or no (usually no = 0)

Definition at line 85 of file RdTimeCalibration.h.

Referenced by Init(), and Run().

char RdTimeCalibration::RdTimeCalibration::fBand
private

Definition at line 92 of file RdTimeCalibration.h.

std::string RdTimeCalibration::RdTimeCalibration::fEllipsoidName
private

Definition at line 93 of file RdTimeCalibration.h.

Referenced by Init().

bool RdTimeCalibration::RdTimeCalibration::fFirstRun
private

flag, that the expectation is calculated just once

Definition at line 88 of file RdTimeCalibration.h.

Referenced by Run().

int RdTimeCalibration::RdTimeCalibration::fInfoLevel
private

xml settings: info level (verbosity)

Definition at line 70 of file RdTimeCalibration.h.

Referenced by Init(), MatchStationTimeStamps(), and Run().

int RdTimeCalibration::RdTimeCalibration::fReferenceAntennaID
private

Reference Antenna (ususally 113)

Definition at line 79 of file RdTimeCalibration.h.

Referenced by Init(), and Run().

int RdTimeCalibration::RdTimeCalibration::fReferenceChannel
private

Reference channel (ususally 1 = NS, high gain)

Definition at line 82 of file RdTimeCalibration.h.

Referenced by Init(), and Run().

std::map<int, std::vector<double> > RdTimeCalibration::RdTimeCalibration::fRunTimeExpectation
private

map of the expected runtime

Definition at line 73 of file RdTimeCalibration.h.

Referenced by Run().

std::vector<double> RdTimeCalibration::RdTimeCalibration::fSourcePosition
private

Postion of the calibration source.

Definition at line 76 of file RdTimeCalibration.h.

Referenced by Init(), and Run().

int RdTimeCalibration::RdTimeCalibration::fZone
private

Band, zone, ellipsoid for the used coordinates.

Definition at line 91 of file RdTimeCalibration.h.


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

, generated on Tue Sep 26 2023.