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

#include <RdBeamTimeOptimizer.h>

Inheritance diagram for RdBeamTimeOptimizer::RdBeamTimeOptimizer:
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

utl::TraceD crosscorr (revt::REvent &rEvent, evt::ShowerRRecData &rrec, const std::vector< double > &shifts) const
 
evt::BeamPeak findPeak (const utl::TraceD &trace)
 
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 ()
 
utl::TraceD powertrace (revt::REvent &rEvent, evt::ShowerRRecData &rrec, const std::vector< double > &shifts) const
 power beam for given sky position More...
 
 RdBeamTimeOptimizer ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
utl::TraceD xtrace (utl::TraceD ccTrace, double ccMean, utl::TraceD pwNormal)
 
virtual ~RdBeamTimeOptimizer ()
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Protected Types

enum  InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }
 

Protected Member Functions

std::vector< double > delaysFromRRec (revt::REvent &rEvent, evt::ShowerRRecData &rrec)
 
void delaysToShifts (revt::REvent &rEvent, utl::TimeStamp meanTime, std::vector< double > &times)
 
std::vector< double > shiftsFromRRec (revt::REvent &rEvent, evt::ShowerRRecData &rrec)
 
void shiftsToDelays (revt::REvent &rEvent, utl::TimeStamp meanTime, std::vector< double > &times)
 

Protected Attributes

int fInfoLevel = 0
 
enum gridtype_t gridtype
 
std::string outfile
 
int startbin
 
int stopbin
 
RdWaveModelwaveModel
 

Private Member Functions

void efieldproduct (const revt::StationTimeSeries &in1, const revt::StationTimeSeries &in2, utl::TraceD &out, int start, int stop) const
 Helper for crosscorr. More...
 
void efieldtopower (const revt::StationTimeSeries &in, utl::TraceD &out, int start, int stop) const
 Helper for powertrace. More...
 
 REGISTER_MODULE ("RdBeamTimeOptimizer", RdBeamTimeOptimizer)
 
void WriteASCII_XYZ (const utl::TraceD &power, const utl::TraceD &cc, const utl::TraceD &x, const evt::BeamPeak &pwPeak, const evt::BeamPeak &ccPeak, const evt::BeamPeak &xPeak, const utl::Triple &coords) const
 Write out results using carthesian CS. More...
 
void WriteASCIIPolar (const utl::TraceD &power, const utl::TraceD &cc, const utl::TraceD &x, const evt::BeamPeak &pwPeak, const evt::BeamPeak &ccPeak, const evt::BeamPeak &xPeak, const utl::Triple &coords) const
 Write out results using polar CS. More...
 
void WriteASCIISpectrum (const revt::Station &, const std::string &) const
 Writes out a spectrum in an ASCII file. More...
 
void writeRecData (revt::REvent &rEvent, std::vector< double > &shifts)
 
void WriteTrace3D (const utl::TraceD &trace, const std::string &filename, const utl::Triple &coords) const
 

Private Attributes

double peakTime
 

Detailed Description

Definition at line 53 of file RdBeamTimeOptimizer.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

RdBeamTimeOptimizer::RdBeamTimeOptimizer::RdBeamTimeOptimizer ( )

Definition at line 43 of file RdBeamTimeOptimizer.cc.

RdBeamTimeOptimizer::RdBeamTimeOptimizer::~RdBeamTimeOptimizer ( )
virtual

Definition at line 47 of file RdBeamTimeOptimizer.cc.

Member Function Documentation

TraceD RdBeamTimeOptimizer::RdBeamTimeOptimizer::crosscorr ( revt::REvent rEvent,
evt::ShowerRRecData rrec,
const std::vector< double > &  shifts 
) const
vector< double > RdBeamTimeOptimizer::RdBeamTimeOptimizer::delaysFromRRec ( revt::REvent rEvent,
evt::ShowerRRecData rrec 
)
protected
void RdBeamTimeOptimizer::RdBeamTimeOptimizer::delaysToShifts ( revt::REvent rEvent,
utl::TimeStamp  meanTime,
std::vector< double > &  times 
)
protected
void RdBeamTimeOptimizer::RdBeamTimeOptimizer::efieldproduct ( const revt::StationTimeSeries in1,
const revt::StationTimeSeries in2,
utl::TraceD out,
int  start,
int  stop 
) const
inlineprivate

Helper for crosscorr.

Definition at line 198 of file RdBeamTimeOptimizer.cc.

References utl::Trace< T >::Begin().

void RdBeamTimeOptimizer::RdBeamTimeOptimizer::efieldtopower ( const revt::StationTimeSeries in,
utl::TraceD out,
int  start,
int  stop 
) const
inlineprivate

Helper for powertrace.

Definition at line 149 of file RdBeamTimeOptimizer.cc.

References utl::Trace< T >::Begin().

evt::BeamPeak RdBeamTimeOptimizer::RdBeamTimeOptimizer::findPeak ( const utl::TraceD trace)
VModule::ResultFlag RdBeamTimeOptimizer::RdBeamTimeOptimizer::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 458 of file RdBeamTimeOptimizer.cc.

References io::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 RdBeamTimeOptimizer::RdBeamTimeOptimizer::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 52 of file RdBeamTimeOptimizer.cc.

References io::eSuccess, 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().

TraceD RdBeamTimeOptimizer::RdBeamTimeOptimizer::powertrace ( revt::REvent rEvent,
evt::ShowerRRecData rrec,
const std::vector< double > &  shifts 
) const
RdBeamTimeOptimizer::RdBeamTimeOptimizer::REGISTER_MODULE ( "RdBeamTimeOptimizer"  ,
RdBeamTimeOptimizer   
)
private
VModule::ResultFlag RdBeamTimeOptimizer::RdBeamTimeOptimizer::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 291 of file RdBeamTimeOptimizer.cc.

References DEBUGLOG, io::eSuccess, revt::REvent::GetHeader(), revt::Header::GetId(), revt::REvent::GetNumberOfStations(), evt::Event::HasRecShower(), evt::Event::HasREvent(), INFO, utl::m, utl::nanosecond, and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
vector< double > RdBeamTimeOptimizer::RdBeamTimeOptimizer::shiftsFromRRec ( revt::REvent rEvent,
evt::ShowerRRecData rrec 
)
protected
void RdBeamTimeOptimizer::RdBeamTimeOptimizer::shiftsToDelays ( revt::REvent rEvent,
utl::TimeStamp  meanTime,
std::vector< double > &  times 
)
protected
void RdBeamTimeOptimizer::RdBeamTimeOptimizer::WriteASCII_XYZ ( const utl::TraceD power,
const utl::TraceD cc,
const utl::TraceD x,
const evt::BeamPeak &  pwPeak,
const evt::BeamPeak &  ccPeak,
const evt::BeamPeak &  xPeak,
const utl::Triple coords 
) const
private

Write out results using carthesian CS.

Definition at line 519 of file RdBeamTimeOptimizer.cc.

References km.

void RdBeamTimeOptimizer::RdBeamTimeOptimizer::WriteASCIIPolar ( const utl::TraceD power,
const utl::TraceD cc,
const utl::TraceD x,
const evt::BeamPeak &  pwPeak,
const evt::BeamPeak &  ccPeak,
const evt::BeamPeak &  xPeak,
const utl::Triple coords 
) const
private

Write out results using polar CS.

Definition at line 492 of file RdBeamTimeOptimizer.cc.

References degree, and km.

void RdBeamTimeOptimizer::RdBeamTimeOptimizer::WriteASCIISpectrum ( const revt::Station station,
const std::string &  filename 
) const
private

Writes out a spectrum in an ASCII file.

Definition at line 467 of file RdBeamTimeOptimizer.cc.

References utl::abs(), revt::Station::GetFrequencyOfBin(), utl::Trace< T >::GetSize(), utl::megahertz, galactic::meter, utl::micro, out, and galactic::volt.

void RdBeamTimeOptimizer::RdBeamTimeOptimizer::writeRecData ( revt::REvent rEvent,
std::vector< double > &  shifts 
)
private
void RdBeamTimeOptimizer::RdBeamTimeOptimizer::WriteTrace3D ( const utl::TraceD trace,
const std::string &  filename,
const utl::Triple coords 
) const
private
TraceD RdBeamTimeOptimizer::RdBeamTimeOptimizer::xtrace ( utl::TraceD  ccTrace,
double  ccMean,
utl::TraceD  pwNormal 
)

Member Data Documentation

int fwk::VModule::fInfoLevel = 0
protectedinherited
enum gridtype_t RdBeamTimeOptimizer::RdBeamTimeOptimizer::gridtype
protected

Definition at line 76 of file RdBeamTimeOptimizer.h.

std::string RdBeamTimeOptimizer::RdBeamTimeOptimizer::outfile
protected

Definition at line 78 of file RdBeamTimeOptimizer.h.

double RdBeamTimeOptimizer::RdBeamTimeOptimizer::peakTime
private

Definition at line 134 of file RdBeamTimeOptimizer.h.

int RdBeamTimeOptimizer::RdBeamTimeOptimizer::startbin
protected

Definition at line 75 of file RdBeamTimeOptimizer.h.

int RdBeamTimeOptimizer::RdBeamTimeOptimizer::stopbin
protected

Definition at line 75 of file RdBeamTimeOptimizer.h.

RdWaveModel* RdBeamTimeOptimizer::RdBeamTimeOptimizer::waveModel
protected

Definition at line 74 of file RdBeamTimeOptimizer.h.


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

, generated on Tue Sep 26 2023.