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

#include <RdChannelNoisePowerAnalyser.h>

Inheritance diagram for RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser:
Inheritance graph
[legend]

Public Types

enum  Month {
  eJan = 1, eFeb = 2, eMar = 3, eApr = 4,
  eMay = 5, eJun = 6, eJul = 7, eAug = 8,
  eSep = 9, eOct = 10, eNov = 11, eDec = 12
}
 
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 ()
 
 RdChannelNoisePowerAnalyser ()
 
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)
 
double GPSSecToLSTHourAuger (const unsigned long gps)
 
 REGISTER_MODULE ("RdChannelNoisePowerAnalyser", RdChannelNoisePowerAnalyser)
 

Static Private Member Functions

static bool IsLeapYear (const int year)
 
static int NumberOfDaysInMonth (const int year, const int month)
 

Private Attributes

int fCurrentMonth
 
std::map< KeyYearMonth,
TProfile2D * > 
fDynamicPowerSpectrum
 
std::vector< double > fFrequencies
 
double fFrequencyBinWidth
 
std::map< Key, THnSparseF * > fHistogramPowerMap
 
std::map< Key, THnSparseF * > fHistogramPowerMapLinear
 
int fInfoLevel
 
const double fLocalSiderealDay
 
double fMaxFrequency
 
const int fMaximumChannelId
 
int fMaximumStationId
 
double fMinFrequency
 
const int fMinimumChannelId
 
int fMinimumStationId
 
int fNFrequencyBins
 
const int fNumberOfBinsPerDay
 
std::ofstream fOfs
 
std::ofstream fOfs_freqs
 
std::string fOutputFilename
 
std::string fOutputPath
 
const utl::UTCDateTime fReferenceTime
 
TFile * fRootOut
 
bool fUnbinnedASCIIOutput
 

Detailed Description

Definition at line 50 of file RdChannelNoisePowerAnalyser.h.

Member Enumeration Documentation

enum fwk::VModule::InfoLevel
protectedinherited
Enumerator
eInfoNone 
eInfoFinal 
eInfoIntermediate 
eInfoDebug 

Definition at line 125 of file VModule.h.

enum RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::Month
Enumerator
eJan 
eFeb 
eMar 
eApr 
eMay 
eJun 
eJul 
eAug 
eSep 
eOct 
eNov 
eDec 

Definition at line 53 of file RdChannelNoisePowerAnalyser.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

RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser ( )

Definition at line 86 of file RdChannelNoisePowerAnalyser.cc.

Member Function Documentation

double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::FindPulse ( revt::Station station)
private
fwk::VModule::ResultFlag RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::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 401 of file RdChannelNoisePowerAnalyser.cc.

References fwk::VModule::eSuccess, fDynamicPowerSpectrum, fHistogramPowerMap, fHistogramPowerMapLinear, fMaximumChannelId, fMaximumStationId, fMinimumChannelId, fMinimumStationId, fNFrequencyBins, fRootOut, 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
double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::GPSSecToLSTHourAuger ( const unsigned long  gps)
private
fwk::VModule::ResultFlag RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::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 107 of file RdChannelNoisePowerAnalyser.cc.

References fwk::VModule::eSuccess, fFrequencies, fFrequencyBinWidth, fHistogramPowerMap, fHistogramPowerMapLinear, fInfoLevel, fMaxFrequency, fMaximumChannelId, fMaximumStationId, fMinFrequency, fMinimumChannelId, fMinimumStationId, fNFrequencyBins, fNumberOfBinsPerDay, fOutputFilename, fOutputPath, fRootOut, utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), INFO, and utl::MHz.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

static bool RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::IsLeapYear ( const int  year)
inlinestaticprivate

Definition at line 79 of file RdChannelNoisePowerAnalyser.h.

Referenced by NumberOfDaysInMonth().

static int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::NumberOfDaysInMonth ( const int  year,
const int  month 
)
inlinestaticprivate

Definition at line 84 of file RdChannelNoisePowerAnalyser.h.

References eApr, eAug, eDec, eFeb, eJan, eJul, eJun, eMar, eMay, eNov, eOct, eSep, and IsLeapYear().

Referenced by Run().

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

Member Data Documentation

int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fCurrentMonth
private

Definition at line 138 of file RdChannelNoisePowerAnalyser.h.

Referenced by Run().

std::map<KeyYearMonth, TProfile2D*> RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fDynamicPowerSpectrum
private

Definition at line 137 of file RdChannelNoisePowerAnalyser.h.

Referenced by Finish(), and Run().

std::vector<double> RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fFrequencies
private

Definition at line 129 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init(), and Run().

double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fFrequencyBinWidth
private

Definition at line 112 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init().

std::map<Key, THnSparseF*> RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fHistogramPowerMap
private

Definition at line 134 of file RdChannelNoisePowerAnalyser.h.

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

std::map<Key, THnSparseF*> RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fHistogramPowerMapLinear
private

Definition at line 135 of file RdChannelNoisePowerAnalyser.h.

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

int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fInfoLevel
private

Definition at line 110 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init().

const double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fLocalSiderealDay
private

Definition at line 123 of file RdChannelNoisePowerAnalyser.h.

double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMaxFrequency
private

Definition at line 114 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init(), and Run().

const int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMaximumChannelId
private

Definition at line 121 of file RdChannelNoisePowerAnalyser.h.

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

int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMaximumStationId
private

Definition at line 119 of file RdChannelNoisePowerAnalyser.h.

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

double RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMinFrequency
private

Definition at line 113 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init(), and Run().

const int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMinimumChannelId
private

Definition at line 120 of file RdChannelNoisePowerAnalyser.h.

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

int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fMinimumStationId
private

Definition at line 118 of file RdChannelNoisePowerAnalyser.h.

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

int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fNFrequencyBins
private

Definition at line 125 of file RdChannelNoisePowerAnalyser.h.

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

const int RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fNumberOfBinsPerDay
private

Definition at line 124 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init(), and Run().

std::ofstream RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fOfs
private

Definition at line 140 of file RdChannelNoisePowerAnalyser.h.

std::ofstream RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fOfs_freqs
private

Definition at line 141 of file RdChannelNoisePowerAnalyser.h.

std::string RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fOutputFilename
private

Definition at line 117 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init().

std::string RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fOutputPath
private

Definition at line 116 of file RdChannelNoisePowerAnalyser.h.

Referenced by Init().

const utl::UTCDateTime RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fReferenceTime
private

Definition at line 127 of file RdChannelNoisePowerAnalyser.h.

TFile* RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fRootOut
private

Definition at line 131 of file RdChannelNoisePowerAnalyser.h.

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

bool RdChannelNoisePowerAnalyser::RdChannelNoisePowerAnalyser::fUnbinnedASCIIOutput
private

Definition at line 111 of file RdChannelNoisePowerAnalyser.h.


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

, generated on Tue Sep 26 2023.