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

#include <RdStationTimingCalibrator/RdStationTimingCalibrator.h>

Inheritance diagram for RdStationTimingCalibratorOG::RdStationTimingCalibrator:
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 Types

typedef std::map< unsigned int,
std::pair< utl::TimeInterval,
double > > 
OffsetMap
 

Private Member Functions

 REGISTER_MODULE ("RdStationTimingCalibrator", RdStationTimingCalibrator)
 

Private Attributes

OffsetMap fOffsets
 
double fTimingOffset_Butterfly_DE = 0 * utl::ns
 
double fTimingOffset_Butterfly_NL = 0 * utl::ns
 
double fTimingOffset_LPDA_DE = 0 * utl::ns
 
double fTimingOffset_LPDA_NL = 0 * utl::ns
 
double fTimingOffset_RD = 0 * utl::ns
 
double fTimingUncertainty_Butterfly_DE = 0 * utl::ns
 
double fTimingUncertainty_Butterfly_NL = 0 * utl::ns
 
double fTimingUncertainty_LPDA_DE = 0 * utl::ns
 
double fTimingUncertainty_LPDA_NL = 0 * utl::ns
 
double fTimingUncertainty_RD = 0 * utl::ns
 

Detailed Description

This module applies a station-specific time-offset to the trace start time of each radio station. The values are listed in a txt-file in Auger-internal time units (i.e. nanoseconds). The values have to be determined with some time calibration procedure, for example with an airplane timing calibration, after already correcting the timing with the RdChannelBeaconTimingCalibrator.

This module should be included into the module sequence after the RdChannelBeaconTimingCalibrator module.

Author
Tim Huege
Date
Aug 2014

Definition at line 29 of file RdStationTimingCalibrator.h.

Member Typedef Documentation

typedef std::map<unsigned int, std::pair<utl::TimeInterval, double> > RdStationTimingCalibratorOG::RdStationTimingCalibrator::OffsetMap
private

Definition at line 37 of file RdStationTimingCalibrator.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

VModule::ResultFlag RdStationTimingCalibratorOG::RdStationTimingCalibrator::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 200 of file RdStationTimingCalibrator.cc.

References io::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 RdStationTimingCalibratorOG::RdStationTimingCalibrator::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 44 of file RdStationTimingCalibrator.cc.

References ERROR, io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), utl::ReadStream::GetLines(), utl::Branch::GetTopBranch(), ns, and WARNING.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdStationTimingCalibratorOG::RdStationTimingCalibrator::REGISTER_MODULE ( "RdStationTimingCalibrator"  ,
RdStationTimingCalibrator   
)
private
VModule::ResultFlag RdStationTimingCalibratorOG::RdStationTimingCalibrator::Run ( evt::Event event)
overridevirtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

int fwk::VModule::fInfoLevel = 0
protectedinherited
OffsetMap RdStationTimingCalibratorOG::RdStationTimingCalibrator::fOffsets
private

Definition at line 38 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingOffset_Butterfly_DE = 0 * utl::ns
private

Definition at line 41 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingOffset_Butterfly_NL = 0 * utl::ns
private

Definition at line 42 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingOffset_LPDA_DE = 0 * utl::ns
private

Definition at line 43 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingOffset_LPDA_NL = 0 * utl::ns
private

Definition at line 44 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingOffset_RD = 0 * utl::ns
private

Definition at line 45 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingUncertainty_Butterfly_DE = 0 * utl::ns
private

Definition at line 47 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingUncertainty_Butterfly_NL = 0 * utl::ns
private

Definition at line 48 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingUncertainty_LPDA_DE = 0 * utl::ns
private

Definition at line 49 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingUncertainty_LPDA_NL = 0 * utl::ns
private

Definition at line 50 of file RdStationTimingCalibrator.h.

double RdStationTimingCalibratorOG::RdStationTimingCalibrator::fTimingUncertainty_RD = 0 * utl::ns
private

Definition at line 51 of file RdStationTimingCalibrator.h.


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

, generated on Tue Sep 26 2023.