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

#include <RdStationSignalReconstructor.h>

Inheritance diagram for RdStationSignalReconstructor::RdStationSignalReconstructor:
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...
 
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 () override
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
fwk::VModule::ResultFlag Init ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 RdStationSignalReconstructor ()
 
fwk::VModule::ResultFlag Run (evt::Event &event) override
 Run: invoked once per event. More...
 
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

ROOT::Minuit2::MnUserParameterState FitAnalyticSignal (utl::Trace< double > &trace, const double noiseRMS, revt::Station &, const int, const bool fixPhaseSlope, const double phaseSlope)
 
double GetAdjustedSignalAmplitude (const double signalAmpitude, const double SNR) const
 the formula is documented in GAP 2013-059 More...
 
double GetAdjustedSignalAmplitude (const double signalAmpitude, const double SNR) const
 the formula is documented in GAP 2013-059 More...
 
double GetAntennaToAntennaUncertainty (const revt::Station &station) const
 Returns the configured uncertainty for a specific antenna type. More...
 
double GetSignalTimeUncertainty (const double SNR) const
 
double GetSignalTimeUncertainty (const double SNR) const
 
double GetSignalUncertainty (const double signalAmplitude, const double SNR) const
 
double GetSignalUncertainty (const double signalAmplitude, const double SNR) const
 
void Noisefinder (const revt::ChannelTimeSeries &channeltrace, double &RMSNoise, double &MeanNoise, double NoiseWindowStart, double NoiseWindowStop) const
 
void Pulsefinder (const revt::ChannelTimeSeries &channeltrace, double &PeakAmplitude, double &PeakTime, double &PeakTimeError, double SignalSearchWindowStart, double SignalSearchWindowStop, unsigned int &sample) const
 
void PulseFixedWindowIntegrator (const revt::ChannelTimeSeries &channeltrace, unsigned int sample, double IntegrationTime, double &IntegratedSignal, double &SignalWindowStart, double &SignalWindowStop, const bool usePower) const
 
void PulseFWHMIntegrator (const revt::ChannelTimeSeries &channeltrace, unsigned int sample, const double PeakAmplitude, double &SignalFWHM, double &IntegratedSignal, double &SignalWindowStart, double &SignalWindowStop) const
 
void PulseSlidingWindowIntegrator (const revt::ChannelTimeSeries &channeltrace, double IntegrationTime, double &IntegratedSignal, double &SignalWindowStart, double &SignalWindowStop, double SignalSearchWindowStart, double SignalSearchWindowStop) const
 
 REGISTER_MODULE ("RdStationSignalReconstructor", RdStationSignalReconstructor)
 
 REGISTER_MODULE ("RdStationSignalReconstructor", RdStationSignalReconstructor)
 

Private Attributes

bool fAddNoiseToUncertainty = false
 
bool fAdjustSignalAmplitude = false
 
double fAmplitudeUncertainty = 0
 
double fBlackSpiderAntennaUncertainty = 0
 
double fButterflyAntennaUncertainty = 0
 
double fDefaultAntennaUncertainty = 0
 
bool fFitAnalyticSignal = 0
 
int fInfoLevel = 0
 
bool fLockParameterStorage = false
 
double fMinSignal = 0
 
double fMinSignalToNoise = 0
 
std::string fNoiseDef = "Undefined"
 
std::string fNoiseSubtraction = "Undefined"
 
unsigned int fNumberOfEvents1SignalStations = 0
 
unsigned int fNumberOfEvents2SignalStations = 0
 
unsigned int fNumberOfEvents3SignalStations = 0
 
unsigned int fNumberOfEvents4SignalStations = 0
 
unsigned int fNumberOfEvents5plusSignalStations = 0
 
unsigned int fNumberOfEvents5SignalStations = 0
 
std::map< unsigned int,
unsigned int > 
fNumberOfStationsInEvents
 
std::string fPolarizationDef = "Undefined"
 
double fRelativeAmplitudeUncertainty = 0
 
double fSallaRDAntennaUncertainty = 0
 
bool fSelfTriggeredSNcut = true
 
std::string fSignalDef = "Undefined"
 
double fSignalIntegrationWindowSize = 0
 
std::string fSignalToNoiseDef = "Undefined"
 
unsigned int fTotalNumberOfEvents = 0
 
bool fUseEnvelope = false
 
unsigned int fVectorialComponent = 0
 

Detailed Description

Definition at line 41 of file Deprecated/RdStationSignalReconstructorLegacy/RdStationSignalReconstructor.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

RdStationSignalReconstructor::RdStationSignalReconstructor::RdStationSignalReconstructor ( )
inline

Member Function Documentation

fwk::VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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.

VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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 849 of file Deprecated/RdStationSignalReconstructorLegacy/RdStationSignalReconstructor.cc.

References io::eSuccess, and INFO.

ROOT::Minuit2::MnUserParameterState RdStationSignalReconstructor::RdStationSignalReconstructor::FitAnalyticSignal ( utl::Trace< double > &  trace,
const double  noiseRMS,
revt::Station ,
const int  ,
const bool  fixPhaseSlope,
const double  phaseSlope 
)
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::GetAdjustedSignalAmplitude ( const double  signalAmpitude,
const double  SNR 
) const
private

the formula is documented in GAP 2013-059

double RdStationSignalReconstructor::RdStationSignalReconstructor::GetAdjustedSignalAmplitude ( const double  signalAmpitude,
const double  SNR 
) const
private

the formula is documented in GAP 2013-059

Definition at line 912 of file Deprecated/RdStationSignalReconstructorLegacy/RdStationSignalReconstructor.cc.

References OUT, std::pow(), and sqrt().

double RdStationSignalReconstructor::RdStationSignalReconstructor::GetAntennaToAntennaUncertainty ( const revt::Station station) const
private

Returns the configured uncertainty for a specific antenna type.

Definition at line 546 of file RdStationSignalReconstructor/RdStationSignalReconstructor.cc.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
double RdStationSignalReconstructor::RdStationSignalReconstructor::GetSignalTimeUncertainty ( const double  SNR) const
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::GetSignalTimeUncertainty ( const double  SNR) const
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::GetSignalUncertainty ( const double  signalAmplitude,
const double  SNR 
) const
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::GetSignalUncertainty ( const double  signalAmplitude,
const double  SNR 
) const
private
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
fwk::VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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.

VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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 72 of file Deprecated/RdStationSignalReconstructorLegacy/RdStationSignalReconstructor.cc.

References io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, and INFODebug.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

void RdStationSignalReconstructor::RdStationSignalReconstructor::Noisefinder ( const revt::ChannelTimeSeries channeltrace,
double &  RMSNoise,
double &  MeanNoise,
double  NoiseWindowStart,
double  NoiseWindowStop 
) const
private
void RdStationSignalReconstructor::RdStationSignalReconstructor::Pulsefinder ( const revt::ChannelTimeSeries channeltrace,
double &  PeakAmplitude,
double &  PeakTime,
double &  PeakTimeError,
double  SignalSearchWindowStart,
double  SignalSearchWindowStop,
unsigned int &  sample 
) const
private
void RdStationSignalReconstructor::RdStationSignalReconstructor::PulseFixedWindowIntegrator ( const revt::ChannelTimeSeries channeltrace,
unsigned int  sample,
double  IntegrationTime,
double &  IntegratedSignal,
double &  SignalWindowStart,
double &  SignalWindowStop,
const bool  usePower 
) const
private
void RdStationSignalReconstructor::RdStationSignalReconstructor::PulseFWHMIntegrator ( const revt::ChannelTimeSeries channeltrace,
unsigned int  sample,
const double  PeakAmplitude,
double &  SignalFWHM,
double &  IntegratedSignal,
double &  SignalWindowStart,
double &  SignalWindowStop 
) const
private
void RdStationSignalReconstructor::RdStationSignalReconstructor::PulseSlidingWindowIntegrator ( const revt::ChannelTimeSeries channeltrace,
double  IntegrationTime,
double &  IntegratedSignal,
double &  SignalWindowStart,
double &  SignalWindowStop,
double  SignalSearchWindowStart,
double  SignalSearchWindowStop 
) const
private
RdStationSignalReconstructor::RdStationSignalReconstructor::REGISTER_MODULE ( "RdStationSignalReconstructor"  ,
RdStationSignalReconstructor   
)
private
RdStationSignalReconstructor::RdStationSignalReconstructor::REGISTER_MODULE ( "RdStationSignalReconstructor"  ,
RdStationSignalReconstructor   
)
private
fwk::VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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.

VModule::ResultFlag RdStationSignalReconstructor::RdStationSignalReconstructor::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}

Implements fwk::VModule.

Definition at line 117 of file Deprecated/RdStationSignalReconstructorLegacy/RdStationSignalReconstructor.cc.

References revt::REvent::CandidateStationsBegin(), revt::REvent::CandidateStationsEnd(), revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), fwk::LocalCoordinateSystemConstructor< Policy >::Create(), ERROR, revt::StationTriggerData::eSelf, io::eSuccess, utl::Trace< T >::GetBinning(), revt::Station::GetFFTDataContainer(), revt::Channel::GetId(), revt::Station::GetId(), evt::ShowerRRecData::GetMagneticFieldVector(), revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), revt::Station::GetRecData(), evt::ShowerRRecData::GetReferenceAxis(), evt::ShowerRRecData::GetReferenceCorePosition(), evt::ShowerRecData::GetRRecShower(), utl::Trace< T >::GetSize(), utl::FFTDataContainer< C, T, F >::GetTimeSeries(), utl::RadioGeometryUtilities::GetTraceInShowerPlaneVxB(), revt::Station::GetTriggerData(), revt::StationTriggerData::GetTriggerSource(), revt::StationRecData::HasParameter(), revt::Station::HasRecData(), evt::Event::HasRecShower(), evt::ShowerRRecData::HasReferenceAxis(), evt::ShowerRRecData::HasReferenceCorePosition(), evt::Event::HasREvent(), evt::ShowerRecData::HasRRecShower(), INFO, INFODebug, INFOFinal, INFOIntermediate, utl::kConversionRadioSignalToEnergyFluence, evt::Event::MakeRecShower(), evt::ShowerRecData::MakeRRecShower(), max, SdAreaSelectorWG::next(), OUT, std::pow(), utl::Trace< T >::PushBack(), utl::Trace< T >::SetBinning(), revt::Station::SetNoSignal(), revt::StationRecData::SetParameter(), evt::ShowerRRecData::SetParameter(), revt::StationRecData::SetParameterError(), revt::StationRecData::SetPulseFound(), revt::Station::SetSignal(), utl::Sqr(), sqrt(), and WARNING.

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

Member Data Documentation

bool RdStationSignalReconstructor::RdStationSignalReconstructor::fAddNoiseToUncertainty = false
private
bool RdStationSignalReconstructor::RdStationSignalReconstructor::fAdjustSignalAmplitude = false
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fAmplitudeUncertainty = 0
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fBlackSpiderAntennaUncertainty = 0
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fButterflyAntennaUncertainty = 0
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fDefaultAntennaUncertainty = 0
private
bool RdStationSignalReconstructor::RdStationSignalReconstructor::fFitAnalyticSignal = 0
private
int RdStationSignalReconstructor::RdStationSignalReconstructor::fInfoLevel = 0
private
bool RdStationSignalReconstructor::RdStationSignalReconstructor::fLockParameterStorage = false
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fMinSignal = 0
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fMinSignalToNoise = 0
private
std::string RdStationSignalReconstructor::RdStationSignalReconstructor::fNoiseDef = "Undefined"
private
std::string RdStationSignalReconstructor::RdStationSignalReconstructor::fNoiseSubtraction = "Undefined"
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents1SignalStations = 0
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents2SignalStations = 0
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents3SignalStations = 0
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents4SignalStations = 0
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents5plusSignalStations = 0
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfEvents5SignalStations = 0
private
std::map<unsigned int, unsigned int> RdStationSignalReconstructor::RdStationSignalReconstructor::fNumberOfStationsInEvents
private
std::string RdStationSignalReconstructor::RdStationSignalReconstructor::fPolarizationDef = "Undefined"
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fRelativeAmplitudeUncertainty = 0
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fSallaRDAntennaUncertainty = 0
private
bool RdStationSignalReconstructor::RdStationSignalReconstructor::fSelfTriggeredSNcut = true
private
std::string RdStationSignalReconstructor::RdStationSignalReconstructor::fSignalDef = "Undefined"
private
double RdStationSignalReconstructor::RdStationSignalReconstructor::fSignalIntegrationWindowSize = 0
private
std::string RdStationSignalReconstructor::RdStationSignalReconstructor::fSignalToNoiseDef = "Undefined"
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fTotalNumberOfEvents = 0
private
bool RdStationSignalReconstructor::RdStationSignalReconstructor::fUseEnvelope = false
private
unsigned int RdStationSignalReconstructor::RdStationSignalReconstructor::fVectorialComponent = 0
private

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

, generated on Tue Sep 26 2023.