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

#include <RdEventInitializer.h>

Inheritance diagram for RdEventInitializer::RdEventInitializer:
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 Member Functions

fwk::VModule::ResultFlag ComputeCoordinateOrigin (const revt::REvent &rEvent, utl::Point &coordinateOrigin) const
 determines the coordinate origin to be used for all further calculations More...
 
 REGISTER_MODULE ("RdEventInitializer", RdEventInitializer)
 
fwk::VModule::ResultFlag SetSignalSearchWindowFromExternal (evt::Event &event) const
 
fwk::VModule::ResultFlag SetSignalSearchWindowFromFD (evt::Event &event) const
 
fwk::VModule::ResultFlag SetSignalSearchWindowFromFile (evt::Event &event) const
 
fwk::VModule::ResultFlag SetSignalSearchWindowFromMC (evt::Event &event) const
 
fwk::VModule::ResultFlag SetSignalSearchWindowFromSD (evt::Event &event) const
 
fwk::VModule::ResultFlag SetSignalSearchWindowManual (evt::Event &event) const
 

Private Attributes

bool fConsiderFdUncertainity = false
 
bool fConsiderSdUncertainity = false
 
utl::Branch fExternalShowerGeometries
 
std::string fFilenameWindowSettings
 
double fNoiseWindowStart = 0
 
double fNoiseWindowStop = 0
 
std::string fReferenceAxis = "RD"
 
std::string fReferenceCorePosition = "RD"
 
std::string fSetCoordinateOriginTo
 
std::string fSetSignalSearchWindowRelativeTo
 
double fSignalSearchWindowOffset = 0
 
double fSignalSearchWindowStart = 0
 
double fSignalSearchWindowStop = 0
 
bool fUseSimulationMagneticField = false
 
unsigned int fWhichEye = 0
 

Detailed Description

Definition at line 30 of file RdEventInitializer.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 RdEventInitializer::RdEventInitializer::ComputeCoordinateOrigin ( const revt::REvent rEvent,
utl::Point coordinateOrigin 
) const
private

determines the coordinate origin to be used for all further calculations

Definition at line 338 of file RdEventInitializer.cc.

References io::eSuccess, rdet::Station::GetPosition(), det::Detector::GetRDetector(), det::Detector::GetSiteCoordinateSystem(), and rdet::RDetector::GetStation().

VModule::ResultFlag RdEventInitializer::RdEventInitializer::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 331 of file RdEventInitializer.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 RdEventInitializer::RdEventInitializer::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 57 of file RdEventInitializer.cc.

References io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), and INFOFinal.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdEventInitializer::RdEventInitializer::REGISTER_MODULE ( "RdEventInitializer"  ,
RdEventInitializer   
)
private
VModule::ResultFlag RdEventInitializer::RdEventInitializer::Run ( evt::Event event)
overridevirtual

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}

///////////////////////////////////////////// compute the coordinate origin /////////////////////////////////////////////

Implements fwk::VModule.

Definition at line 99 of file RdEventInitializer.cc.

References fwk::LocalCoordinateSystemConstructor< Policy >::Create(), ERROR, io::eSuccess, fevt::FEvent::EyesBegin(), fevt::FEvent::EyesEnd(), evt::ShowerSRecData::GetCorePosition(), evt::ShowerFRecData::GetCorePosition(), revt::Header::GetEventVersion(), revt::Header::GetFileId(), fevt::EyeRecData::GetFRecShower(), utl::TimeStamp::GetGPSSecond(), revt::REvent::GetHeader(), revt::Header::GetId(), evt::ShowerSimData::GetMagneticFieldAzimuth(), evt::ShowerSimData::GetMagneticFieldStrength(), fwk::MagneticFieldModel::GetMagneticFieldVector(), evt::ShowerSimData::GetMagneticFieldZenith(), fevt::Eye::GetRecData(), evt::Event::GetRecShower(), revt::Header::GetRunNumber(), revt::Header::GetTime(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), evt::Event::HasFEvent(), fevt::EyeRecData::HasFRecShower(), fevt::Eye::HasRecData(), evt::Event::HasRecShower(), evt::Event::HasREvent(), evt::ShowerRecData::HasRRecShower(), evt::Event::HasSimShower(), evt::ShowerRecData::HasSRecShower(), INFO, INFOIntermediate, fwk::MagneticFieldModel::instance(), evt::Event::MakeRecShower(), evt::ShowerRecData::MakeRRecShower(), evt::ShowerRRecData::SetParameter(), evt::ShowerRRecData::SetReferenceAxisFlag(), evt::ShowerRRecData::SetReferenceCoreFlag(), evt::ShowerRRecData::SetWhichEye(), and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowFromExternal ( evt::Event event) const
private
VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowFromFD ( evt::Event event) const
private

Definition at line 726 of file RdEventInitializer.cc.

References fwk::LocalCoordinateSystemConstructor< Policy >::Create(), ERROR, io::eSuccess, fevt::FEvent::EyesBegin(), fevt::FEvent::EyesEnd(), utl::CorrelationMatrix::Get(), evt::ShowerFRecData::GetAxis(), evt::ShowerFRecData::GetAxisError(), fevt::EyeRecData::GetChiZero(), fevt::EyeRecData::GetChiZeroError(), evt::ShowerFRecData::GetCorePosition(), evt::ShowerFRecData::GetCoreTime(), fdet::Eye::GetEyeCoordinateSystem(), fevt::EyeRecData::GetFRecShower(), revt::REvent::GetHeader(), fevt::Eye::GetId(), utl::BasicVector< HepVector >::GetPhi(), rdet::Station::GetPosition(), utl::NumericalErrorPropagation::GetPropagatedCorrelations(), utl::NumericalErrorPropagation::GetPropagatedErrors(), fevt::Eye::GetRecData(), evt::Event::GetRecShower(), fevt::EyeRecData::GetRp(), fevt::EyeRecData::GetRpChi0Correlation(), fevt::EyeRecData::GetRpError(), fevt::EyeRecData::GetSDP(), fevt::EyeRecData::GetSDPCorrThetaPhi(), fevt::EyeRecData::GetSDPPhiError(), fevt::EyeRecData::GetSDPThetaError(), rdet::RDetector::GetStation(), utl::BasicVector< HepVector >::GetTheta(), revt::Header::GetTime(), fevt::EyeRecData::GetTZeroError(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), evt::Event::HasFEvent(), fevt::EyeRecData::HasFRecShower(), fevt::Eye::HasRecData(), evt::Event::HasRecShower(), evt::ShowerRecData::HasRRecShower(), utl::kSpeedOfLight, evt::Event::MakeRecShower(), evt::ShowerRecData::MakeRRecShower(), utl::CorrelationMatrix::Set(), sqrt(), and WARNING.

VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowFromFile ( evt::Event event) const
private
VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowFromMC ( evt::Event event) const
private

Definition at line 862 of file RdEventInitializer.cc.

References ERROR, and io::eSuccess.

VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowFromSD ( evt::Event event) const
private
VModule::ResultFlag RdEventInitializer::RdEventInitializer::SetSignalSearchWindowManual ( evt::Event event) const
private

Definition at line 366 of file RdEventInitializer.cc.

References io::eSuccess.

Member Data Documentation

bool RdEventInitializer::RdEventInitializer::fConsiderFdUncertainity = false
private

Definition at line 60 of file RdEventInitializer.h.

bool RdEventInitializer::RdEventInitializer::fConsiderSdUncertainity = false
private

Definition at line 59 of file RdEventInitializer.h.

utl::Branch RdEventInitializer::RdEventInitializer::fExternalShowerGeometries
private

Definition at line 65 of file RdEventInitializer.h.

std::string RdEventInitializer::RdEventInitializer::fFilenameWindowSettings
private

Definition at line 67 of file RdEventInitializer.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
double RdEventInitializer::RdEventInitializer::fNoiseWindowStart = 0
private

Definition at line 49 of file RdEventInitializer.h.

double RdEventInitializer::RdEventInitializer::fNoiseWindowStop = 0
private

Definition at line 50 of file RdEventInitializer.h.

std::string RdEventInitializer::RdEventInitializer::fReferenceAxis = "RD"
private

Definition at line 64 of file RdEventInitializer.h.

std::string RdEventInitializer::RdEventInitializer::fReferenceCorePosition = "RD"
private

Definition at line 63 of file RdEventInitializer.h.

std::string RdEventInitializer::RdEventInitializer::fSetCoordinateOriginTo
private

Definition at line 56 of file RdEventInitializer.h.

std::string RdEventInitializer::RdEventInitializer::fSetSignalSearchWindowRelativeTo
private

Definition at line 57 of file RdEventInitializer.h.

double RdEventInitializer::RdEventInitializer::fSignalSearchWindowOffset = 0
private

Definition at line 61 of file RdEventInitializer.h.

double RdEventInitializer::RdEventInitializer::fSignalSearchWindowStart = 0
private

Definition at line 51 of file RdEventInitializer.h.

double RdEventInitializer::RdEventInitializer::fSignalSearchWindowStop = 0
private

Definition at line 52 of file RdEventInitializer.h.

bool RdEventInitializer::RdEventInitializer::fUseSimulationMagneticField = false
private

Definition at line 54 of file RdEventInitializer.h.

unsigned int RdEventInitializer::RdEventInitializer::fWhichEye = 0
private

Definition at line 68 of file RdEventInitializer.h.


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

, generated on Tue Sep 26 2023.