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

#include <RdPlaneFit.h>

Inheritance diagram for RdPlaneFit::RdPlaneFit:
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::Stopwatch & GetStopwatch ()
 
const utl::Stopwatch & GetStopwatch () 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

void CalculateTimeResidual (const utl::Vector &axis, const double ct0, double &chi2) const
 
fwk::VModule::ResultFlag LinearFit (FitParameters &fit, const bool reuseFit=false) const
 performs a Linear fit, approximation that z= equal for all stations More...
 
fwk::VModule::ResultFlag PlaneFit3DDriver (FitParameters &fit) const
 Setting up / Executing the minimalization routines. More...
 
 REGISTER_MODULE ("RdPlaneFit", RdPlaneFit)
 

Static Private Member Functions

static void PlaneFit3DFnc (int &nPar, double *const grad, double &value, double *const par, const int flag)
 Function to minimize the plane fit, z != equal for all stations. More...
 
static void PlaneFit3DHorizonFnc (int &nPar, double *const grad, double &value, double *const par, const int flag)
 

Private Attributes

bool fAllowUnphysicalCosines
 
bool fLockParameterStorage
 
int fMinNumberOfStations
 
bool fMinuitOutput
 

Static Private Attributes

static utl::Point fgBarycenter
 
static utl::TimeStamp fgBaryTime
 
static utl::Point fgCoordinateOrigin
 
static revt::REvent * fgCurrentREvent
 
static utl::CoordinateSystemPtr fgLocalCS
 
static double fgMeanEventTime
 

Detailed Description

Definition at line 48 of file RdPlaneFit.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.

enum fwk::VModule::VersionInfoType
inherited

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 RdPlaneFit::RdPlaneFit::CalculateTimeResidual ( const utl::Vector &  axis,
const double  ct0,
double &  chi2 
) const
private

Calculation of the time residual of the individual station. Also fills them in the StationRecData

Definition at line 625 of file RdPlaneFit.cc.

References revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), rdet::RDetector::GetStation(), utl::kSpeedOfLight, std::pow(), revt::StationRecData::SetParameter(), and revt::StationRecData::SetParameterError().

VModule::ResultFlag RdPlaneFit::RdPlaneFit::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 510 of file RdPlaneFit.cc.

References io::eSuccess, and INFODebug.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited

Definition at line 8 of file VModule.cc.

References fwk::VModule::eBreakLoop, fwk::VModule::eContinueLoop, fwk::VModule::eFailure, and fwk::VModule::eSuccess.

Referenced by fwk::RunController::DoNextInSequence(), fwk::RunController::FinishBranch(), and fwk::RunController::InitBranch().

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

Retrieve different sorts of module version info.

Definition at line 26 of file VModule.cc.

Referenced by fwk::CentralConfig::GetConfig(), ThresholdCalculatorKG::ThresholdCalculator::Init(), fdDoubleBumpFinder::FdDoubleBumpFinder::Init(), LaserGeneratorNA::LaserGenerator::Init(), LaserLightSimulatorNA::LaserLightSimulator::Init(), FdElectronicsSimulatorOG::FdElectronicsSimulator::Init(), TelescopeSimulatorKG::TelescopeSimulator::Init(), TelescopeSimulatorKG2::TelescopeSimulator::Init(), SdSimpleSimKG::SdSimpleSim::Init(), ShowerPhotonGeneratorOG::ShowerPhotonGenerator::Init(), and testRunController::testModuleVersionInfo().

VModule::ResultFlag RdPlaneFit::RdPlaneFit::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 68 of file RdPlaneFit.cc.

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

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

VModule::ResultFlag RdPlaneFit::RdPlaneFit::LinearFit ( FitParameters &  fit,
const bool  reuseFit = false 
) const
private

performs a Linear fit, approximation that z= equal for all stations

Definition at line 93 of file RdPlaneFit.cc.

References RdPlaneFit::FitParameters::ct0, io::eSuccess, revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), rdet::RDetector::GetStation(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), INFO, utl::kSpeedOfLight, G4StationSimulatorOG::p, RdPlaneFit::FitParameters::sigmact02, RdPlaneFit::FitParameters::sigmaU2, RdPlaneFit::FitParameters::sigmaUV, RdPlaneFit::FitParameters::sigmaV2, utl::Sqr(), sqrt(), RdPlaneFit::FitParameters::u, RdPlaneFit::FitParameters::v, RdPlaneFit::FitParameters::w, and WARNING.

VModule::ResultFlag RdPlaneFit::RdPlaneFit::PlaneFit3DDriver ( FitParameters &  fit) const
private

Setting up / Executing the minimalization routines.

Definition at line 417 of file RdPlaneFit.cc.

References RdPlaneFit::FitParameters::ct0, io::eSuccess, INFOFinal, INFOIntermediate, galactic::meter, RdPlaneFit::FitParameters::sigmact02, RdPlaneFit::FitParameters::sigmaU2, RdPlaneFit::FitParameters::sigmaUV, RdPlaneFit::FitParameters::sigmaV2, utl::Sqr(), sqrt(), RdPlaneFit::FitParameters::u, RdPlaneFit::FitParameters::v, and RdPlaneFit::FitParameters::w.

void RdPlaneFit::RdPlaneFit::PlaneFit3DFnc ( int &  nPar,
double *const  grad,
double &  value,
double *const  par,
const int  flag 
)
staticprivate

Function to minimize the plane fit, z != equal for all stations.

Definition at line 518 of file RdPlaneFit.cc.

References revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), rdet::RDetector::GetStation(), utl::kSpeedOfLight, utl::kSpeedOfLight2, utl::Sqr(), and sqrt().

void RdPlaneFit::RdPlaneFit::PlaneFit3DHorizonFnc ( int &  nPar,
double *const  grad,
double &  value,
double *const  par,
const int  flag 
)
staticprivate

Function to minimize the plane fit, z != equal for all stations. To be used in the case of horizontal events

Definition at line 576 of file RdPlaneFit.cc.

References revt::StationRecData::GetParameter(), revt::StationRecData::GetParameterError(), rdet::Station::GetPosition(), rdet::RDetector::GetStation(), utl::kSpeedOfLight, utl::kSpeedOfLight2, and utl::Sqr().

RdPlaneFit::RdPlaneFit::REGISTER_MODULE ( "RdPlaneFit"  ,
RdPlaneFit   
)
private
VModule::ResultFlag RdPlaneFit::RdPlaneFit::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 194 of file RdPlaneFit.cc.

References RdPlaneFit::FitParameters::ct0, degree, SdMonteCarloPropagatorKVI::eCoreTime, ERROR, io::eSuccess, evt::ShowerRRecData::GetAzimuthError(), evt::ShowerRRecData::GetCoordinateOrigin(), revt::REvent::GetHeader(), revt::StationRecData::GetParameter(), rdet::Station::GetPosition(), det::Detector::GetRDetector(), revt::Station::GetRecData(), evt::Event::GetRecShower(), det::Detector::GetReferenceCoordinateSystem(), det::Detector::GetSiteCoordinateSystem(), rdet::RDetector::GetStation(), revt::Header::GetTime(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), utl::BasicVector< HepVector >::GetZ(), evt::ShowerRRecData::GetZenithError(), evt::Event::HasRecShower(), evt::Event::HasREvent(), evt::ShowerRecData::HasRRecShower(), INFO, INFOFinal, INFOIntermediate, utl::kSpeedOfLight, otoa::LinearFit(), evt::Event::MakeRecShower(), evt::ShowerRecData::MakeRRecShower(), galactic::meter, utl::nanosecond, utl::PropagateAxisErrors(), revt::StationRecData::SetParameter(), evt::ShowerRRecData::SetParameter(), evt::ShowerRRecData::SetParameterCovariance(), evt::ShowerRRecData::SetParameterError(), RdPlaneFit::FitParameters::sigmact02, RdPlaneFit::FitParameters::sigmaU2, RdPlaneFit::FitParameters::sigmaUV, RdPlaneFit::FitParameters::sigmaV2, sqrt(), RdPlaneFit::FitParameters::stage, ToString(), RdPlaneFit::FitParameters::u, RdPlaneFit::FitParameters::v, RdPlaneFit::FitParameters::w, and utl::AugerException::what().

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

Definition at line 98 of file VModule.h.

References fwk::VModule::fStopwatch, fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by fwk::RunController::DoNextInSequence().

Member Data Documentation

bool RdPlaneFit::RdPlaneFit::fAllowUnphysicalCosines
private

Definition at line 79 of file RdPlaneFit.h.

Point RdPlaneFit::RdPlaneFit::fgBarycenter
staticprivate

Definition at line 84 of file RdPlaneFit.h.

TimeStamp RdPlaneFit::RdPlaneFit::fgBaryTime
staticprivate

Definition at line 85 of file RdPlaneFit.h.

Point RdPlaneFit::RdPlaneFit::fgCoordinateOrigin
staticprivate

Definition at line 86 of file RdPlaneFit.h.

REvent * RdPlaneFit::RdPlaneFit::fgCurrentREvent
staticprivate

Definition at line 83 of file RdPlaneFit.h.

CoordinateSystemPtr RdPlaneFit::RdPlaneFit::fgLocalCS
staticprivate

Definition at line 87 of file RdPlaneFit.h.

double RdPlaneFit::RdPlaneFit::fgMeanEventTime
staticprivate

Definition at line 88 of file RdPlaneFit.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited

Definition at line 123 of file VModule.h.

Referenced by RdChannelASCIINoiseImporterRD::RdChannelASCIINoiseImporterRD::Init(), Rd2dLDFFitter::Rd2dLDFFitter::Init(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Init(), and Rd2dLDFFitter::Rd2dLDFFitter::Run().

bool RdPlaneFit::RdPlaneFit::fLockParameterStorage
private

Definition at line 80 of file RdPlaneFit.h.

int RdPlaneFit::RdPlaneFit::fMinNumberOfStations
private

Definition at line 78 of file RdPlaneFit.h.

bool RdPlaneFit::RdPlaneFit::fMinuitOutput
private

Definition at line 77 of file RdPlaneFit.h.

The documentation for this class was generated from the following files:
, generated on Tue Sep 26 2023.