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

#include <RdStationAssociator.h>

Inheritance diagram for RdStationAssociator::RdStationAssociator:
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 &theevent) 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

void AddVirtualStations (evt::Event &event, utl::CoordinateSystemPtr corsys) const
 
int FindClosestStationFromPoint (const utl::Point &pt, const rdet::RDetector &Det, double masDistanceFactor)
 
 REGISTER_MODULE ("RdStationAssociator", RdStationAssociator)
 

Private Attributes

bool fAddEmptyTriggeredRDStations = true
 
bool fAddNoSignalStations = false
 
bool fAddVirtualStations = false
 
bool fCreateAllSDStationsWithRDTrace = false
 
std::vector< int > fExcludedStationIds
 
bool fExtrapolateTheTailOfThePulses = false
 
int fFirstStationId = -1
 
std::vector< int > fIncludedStationIds
 
double fMaximumDistance = 5 * utl::meter
 
double fMaximumDistanceOfNoSignalStations = 0 * utl::m
 
double fMinimumTraceLength = 12000 * utl::nanosecond
 
double fTracePaddingAtFront = 2000 * utl::nanosecond
 

Detailed Description

Definition at line 34 of file RdStationAssociator.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

void RdStationAssociator::RdStationAssociator::AddVirtualStations ( evt::Event event,
utl::CoordinateSystemPtr  corsys 
) const
private
int RdStationAssociator::RdStationAssociator::FindClosestStationFromPoint ( const utl::Point pt,
const rdet::RDetector Det,
double  masDistanceFactor 
)
private

Definition at line 490 of file RdStationAssociator.cc.

VModule::ResultFlag RdStationAssociator::RdStationAssociator::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 483 of file RdStationAssociator.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 RdStationAssociator::RdStationAssociator::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 49 of file RdStationAssociator.cc.

References io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFOFinal, utl::km, galactic::meter, and utl::nanosecond.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

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

Implements fwk::VModule.

Definition at line 87 of file RdStationAssociator.cc.

References ERROR, io::eSuccess, utl::eV, evt::SimRadioPulse::GetEfieldTimeSeries(), revt::REvent::GetHeader(), evt::RadioSimulation::GetLocalCoordinateSystem(), evt::SimRadioPulse::GetLocation(), evt::ShowerSimData::GetRadioSimulation(), evt::Event::GetREvent(), evt::Event::GetSEvent(), evt::Event::GetSimShower(), utl::SVector< n, T >::GetSize(), utl::Trace< T >::GetSize(), evt::SimRadioPulse::GetStartTime(), sevt::SEvent::GetStation(), revt::REvent::GetStation(), revt::Station::GetStationTimeSeries(), revt::Header::GetTime(), revt::REvent::GetTrigger(), sevt::Station::GetTriggerData(), utl::BasicVector< HepVector >::GetX(), RdStationAssociator::ExpoTail::GetY(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), evt::Event::HasREvent(), evt::Event::HasSEvent(), sevt::SEvent::HasStation(), revt::REvent::HasStation(), sevt::Station::HasTriggerData(), INFO, INFODebug, INFOFinal, INFOIntermediate, utl::kConversionRadioSignalToEnergyFluence, utl::kSpeedOfLight, utl::m2, revt::Station::MakeGPSData(), evt::Event::MakeREvent(), revt::Station::MakeSimData(), sevt::Station::MakeSimData(), sevt::SEvent::MakeStation(), revt::REvent::MakeStation(), revt::REvent::MakeTrigger(), revt::Station::MakeTriggerData(), galactic::meter, utl::microvolt, utl::Minou::Minimizer< F >::Minimize(), utl::ns, ok(), out, utl::Trace< T >::PushBack(), result, galactic::second, utl::Trace< T >::SetBinning(), RdStationAssociator::ExpoTail::SetData(), revt::EventTrigger::SetExternalTrigger(), revt::Header::SetId(), evt::SimRadioPulse::SetLocalCoordinateSystem(), revt::Station::SetRawTraceStartTime(), revt::Header::SetRunNumber(), revt::Header::SetTime(), RdStationAssociator::ExpoTail::Setx0(), utl::Sqr(), and WARNING.

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

Member Data Documentation

bool RdStationAssociator::RdStationAssociator::fAddEmptyTriggeredRDStations = true
private

Definition at line 62 of file RdStationAssociator.h.

bool RdStationAssociator::RdStationAssociator::fAddNoSignalStations = false
private

Definition at line 53 of file RdStationAssociator.h.

bool RdStationAssociator::RdStationAssociator::fAddVirtualStations = false
private

Definition at line 60 of file RdStationAssociator.h.

bool RdStationAssociator::RdStationAssociator::fCreateAllSDStationsWithRDTrace = false
private

Definition at line 55 of file RdStationAssociator.h.

std::vector<int> RdStationAssociator::RdStationAssociator::fExcludedStationIds
private

Definition at line 58 of file RdStationAssociator.h.

bool RdStationAssociator::RdStationAssociator::fExtrapolateTheTailOfThePulses = false
private

Definition at line 63 of file RdStationAssociator.h.

int RdStationAssociator::RdStationAssociator::fFirstStationId = -1
private

Definition at line 61 of file RdStationAssociator.h.

std::vector<int> RdStationAssociator::RdStationAssociator::fIncludedStationIds
private

Definition at line 57 of file RdStationAssociator.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
double RdStationAssociator::RdStationAssociator::fMaximumDistance = 5 * utl::meter
private

Definition at line 50 of file RdStationAssociator.h.

double RdStationAssociator::RdStationAssociator::fMaximumDistanceOfNoSignalStations = 0 * utl::m
private

Definition at line 54 of file RdStationAssociator.h.

double RdStationAssociator::RdStationAssociator::fMinimumTraceLength = 12000 * utl::nanosecond
private

Definition at line 52 of file RdStationAssociator.h.

double RdStationAssociator::RdStationAssociator::fTracePaddingAtFront = 2000 * utl::nanosecond
private

Definition at line 51 of file RdStationAssociator.h.


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

, generated on Tue Sep 26 2023.