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

#include <RdCheckFootprint.h>

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

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Private Types

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

Private Member Functions

 REGISTER_MODULE ("RdCheckFootprint", RdCheckFootprint)
 

Private Attributes

int fCheckOutliers
 xml configs: Switches check for outliers on More...
 
double fCherenkovRadius
 xml configs: Radius of Cherenkov ring. Inside this radius the module is not applied More...
 
int fInfoLevel
 xml configs: verbosity More...
 
std::vector< ldffLDF
 sorted lateral distribution of amplitudes More...
 
double fLDFUncertainty
 xml configs: The uncertainty of LDF model (as fraction of amplitude) More...
 
double fSigmaMultiplier
 xml configs: The maximum tolerated deviation from LDF More...
 
int fTolerance
 xml configs: If number of antennas wthout signal exceeds this value, all antennas after regected as eLonelyStation More...
 

Detailed Description

Definition at line 50 of file RdCheckFootprint.h.

Member Enumeration Documentation

enum RdCheckFootprint::RdCheckFootprint::InfoLevel
private
Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eDebug 

Definition at line 62 of file RdCheckFootprint.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

RdCheckFootprint::RdCheckFootprint::RdCheckFootprint ( )

Definition at line 14 of file RdCheckFootprint.cc.

RdCheckFootprint::RdCheckFootprint::~RdCheckFootprint ( )
virtual

Definition at line 24 of file RdCheckFootprint.cc.

Member Function Documentation

VModule::ResultFlag RdCheckFootprint::RdCheckFootprint::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 122 of file RdCheckFootprint.cc.

References fwk::VModule::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 RdCheckFootprint::RdCheckFootprint::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}

Reading configuration from XML

Implements fwk::VModule.

Definition at line 28 of file RdCheckFootprint.cc.

References fwk::VModule::eSuccess, fCheckOutliers, fCherenkovRadius, fInfoLevel, fLDF, fLDFUncertainty, fSigmaMultiplier, fTolerance, 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().

RdCheckFootprint::RdCheckFootprint::REGISTER_MODULE ( "RdCheckFootprint"  ,
RdCheckFootprint   
)
private
VModule::ResultFlag RdCheckFootprint::RdCheckFootprint::Run ( evt::Event event)
virtual

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}

Getting all necessary variables

Defining coordinate system and shower axis

Cleaning lateral distribution of amplitudes

Runing through stations and create ordered lateral distribution

number of antennas without signal

maximum tolerated amplitude (for LDF check)

amplitude of current antenna

Runing through lateral distribution and reject stations

Skip if antenna is alredy deselected

Skip if inside Cherenkov ring

Check as LDF outlier

Check if antenna is must be rejected

Updating the counters

Incrementing number of antennas without signal

Implements fwk::VModule.

Definition at line 46 of file RdCheckFootprint.cc.

References revt::eCheckAntennaBackgroundLevel, revt::eCheckFootprintDeselected, revt::eLonelyStation, revt::ePolarizationDeselected, fwk::VModule::eSuccess, fCheckOutliers, fCherenkovRadius, fLDF, fLDFUncertainty, fSigmaMultiplier, fTolerance, evt::ShowerRRecData::GetAxis(), evt::ShowerRRecData::GetCoordinateOrigin(), evt::ShowerRRecData::GetCorePosition(), utl::RadioGeometryUtilities::GetDistanceToAxis(), revt::Station::GetId(), revt::StationRecData::GetParameter(), evt::ShowerRRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), revt::StationRecData::GetPulseFound(), revt::Station::GetRecData(), rdet::RDetector::GetStation(), revt::REvent::GetStation(), INFO, evt::ShowerRRecData::SetParameter(), revt::StationRecData::SetPulseFound(), RdCheckFootprint::sort_ldf(), revt::REvent::StationsBegin(), and revt::REvent::StationsEnd().

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

Member Data Documentation

int RdCheckFootprint::RdCheckFootprint::fCheckOutliers
private

xml configs: Switches check for outliers on

Definition at line 73 of file RdCheckFootprint.h.

Referenced by Init(), and Run().

double RdCheckFootprint::RdCheckFootprint::fCherenkovRadius
private

xml configs: Radius of Cherenkov ring. Inside this radius the module is not applied

Definition at line 70 of file RdCheckFootprint.h.

Referenced by Init(), and Run().

int RdCheckFootprint::RdCheckFootprint::fInfoLevel
private

xml configs: verbosity

Definition at line 67 of file RdCheckFootprint.h.

Referenced by Init().

std::vector<ldf> RdCheckFootprint::RdCheckFootprint::fLDF
private

sorted lateral distribution of amplitudes

Definition at line 85 of file RdCheckFootprint.h.

Referenced by Init(), and Run().

double RdCheckFootprint::RdCheckFootprint::fLDFUncertainty
private

xml configs: The uncertainty of LDF model (as fraction of amplitude)

Definition at line 82 of file RdCheckFootprint.h.

Referenced by Init(), and Run().

double RdCheckFootprint::RdCheckFootprint::fSigmaMultiplier
private

xml configs: The maximum tolerated deviation from LDF

Definition at line 76 of file RdCheckFootprint.h.

Referenced by Init(), and Run().

int RdCheckFootprint::RdCheckFootprint::fTolerance
private

xml configs: If number of antennas wthout signal exceeds this value, all antennas after regected as eLonelyStation

Definition at line 79 of file RdCheckFootprint.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.