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

#include <RdLDFChargeExcessCorrector.h>

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

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

 REGISTER_MODULE ("RdLDFChargeExcessCorrector", RdLDFChargeExcessCorrector)
 

Private Attributes

std::string fAsymmetryDefinition
 
std::string fAsymmetryParametrization
 
int fInfoLevel
 
double fMeanAsymmetry
 
double fMeanAsymmetryError
 

Detailed Description

Definition at line 32 of file RdLDFChargeExcessCorrector.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.

Constructor & Destructor Documentation

RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector ( )

Definition at line 42 of file RdLDFChargeExcessCorrector.cc.

RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::~RdLDFChargeExcessCorrector ( )
virtual

Definition at line 51 of file RdLDFChargeExcessCorrector.cc.

Member Function Documentation

VModule::ResultFlag RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::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 190 of file RdLDFChargeExcessCorrector.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 RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::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}

Read in the configurations of the xml file

Implements fwk::VModule.

Definition at line 55 of file RdLDFChargeExcessCorrector.cc.

References fwk::VModule::eSuccess, fAsymmetryDefinition, fAsymmetryParametrization, fInfoLevel, fMeanAsymmetry, fMeanAsymmetryError, 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().

RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::REGISTER_MODULE ( "RdLDFChargeExcessCorrector"  ,
RdLDFChargeExcessCorrector   
)
private
VModule::ResultFlag RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::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}

Check if there are events at all

Checking reconstruction stage (we need axis and core)

Fetching all neccessary objects

Detector

Shower axis

Reference CS

Core position

Magnetic field

Transformation

Geomagnetic angle

iterator through stations

fetching station

checking if has pulse

Position of the antenna in the detector plane

Position of the antenna relative to shower core

Coordinates of the antenna in geomagnetic CS The projection of the antenna station on the shower front is (magx, magy)

Geomagnetic azimuth

temporary variables for asymmetry

Taking the definition of asymmetry

... if "Mean", taking from config

... if "Polarization", taking from measured parameter be careful, this parameter must be set in previous module!

not implemented yet do nothing

Making ROOT object from the formula given in configuration

Fetching amplitude and its uncertainty

Adjusting amplitude with given formula (see above)

Storing results

Implements fwk::VModule.

Definition at line 72 of file RdLDFChargeExcessCorrector.cc.

References utl::Angle(), revt::REvent::CandidateStationsBegin(), revt::REvent::CandidateStationsEnd(), eps, fwk::VModule::eSuccess, fAsymmetryDefinition, fAsymmetryParametrization, fMeanAsymmetry, fMeanAsymmetryError, evt::ShowerRRecData::GetAxis(), evt::ShowerRRecData::GetCoordinateOrigin(), evt::ShowerRRecData::GetCorePosition(), utl::RadioGeometryUtilities::GetDistanceToAxis(), fwk::MagneticFieldModel::GetMagneticFieldVector(), revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), revt::StationRecData::GetPulseFound(), revt::Station::GetRecData(), evt::Event::GetRecShower(), evt::ShowerRecData::GetRRecShower(), rdet::RDetector::GetStation(), utl::RadioGeometryUtilities::GetVectorInShowerPlaneVxB(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), evt::ShowerRRecData::HasAxis(), evt::ShowerRRecData::HasCorePosition(), evt::Event::HasREvent(), fwk::MagneticFieldModel::instance(), std::pow(), revt::StationRecData::SetParameter(), revt::StationRecData::SetParameterError(), sqrt(), and WARNING.

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

Member Data Documentation

std::string RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::fAsymmetryDefinition
private

Definition at line 49 of file RdLDFChargeExcessCorrector.h.

Referenced by Init(), and Run().

std::string RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::fAsymmetryParametrization
private

Definition at line 48 of file RdLDFChargeExcessCorrector.h.

Referenced by Init(), and Run().

int RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::fInfoLevel
private

Definition at line 45 of file RdLDFChargeExcessCorrector.h.

Referenced by Init().

double RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::fMeanAsymmetry
private

Definition at line 46 of file RdLDFChargeExcessCorrector.h.

Referenced by Init(), and Run().

double RdLDFChargeExcessCorrector::RdLDFChargeExcessCorrector::fMeanAsymmetryError
private

Definition at line 47 of file RdLDFChargeExcessCorrector.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.