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
RdBeamFormer::RdBeamFormer Class Reference

#include <RdBeamFormer.h>

Inheritance diagram for RdBeamFormer::RdBeamFormer:
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 (std::vector< revt::StationFFTDataContainer > &stationData, int nStat, double binning, int start, int stop)
 
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 (std::vector< revt::StationFFTDataContainer > &stationData, int nStat, double binning, int start, int stop)
 
 RdBeamFormer ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
double shiftTraces (std::vector< revt::StationFFTDataContainer > &stationData, int &nStat, double &binning, int &start, int &stop, evt::Event &event)
 
utl::TraceD xtrace (utl::TraceD ccTrace, utl::TraceD ccNormal, utl::TraceD pwNormal)
 
 ~RdBeamFormer ()
 

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

evt::BeamPeak findPeak (const utl::TraceD &trace, const double timeOffset)
 

Protected Attributes

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

Private Member Functions

void efieldproduct (const revt::StationTimeSeries &in1, const revt::StationTimeSeries &in2, utl::TraceD &out, int start, int stop)
 
void efieldtopower (const revt::StationTimeSeries &in, utl::TraceD &out, int start, int stop)
 
 REGISTER_MODULE ("RdBeamFormer", RdBeamFormer)
 
void WriteASCII (const utl::TraceD &cc, const utl::TraceD &power, const utl::TraceD &x, const evt::BeamPeak &ccPeak, const evt::BeamPeak &pwPeak, const evt::BeamPeak &xPeak, const evt::Event &event) const
 
void WritePeak (const evt::BeamPeak &Peak, const std::string &filename, const evt::ShowerRRecData &rrec) const
 
void WriteTrace (const utl::TraceD &trace, const evt::BeamPeak &Peak, const std::string &filename, const evt::ShowerRRecData &rrec) const
 

Private Attributes

utl::CoordinateSystemPtr coreCS
 
long fNumCalls
 

Detailed Description

Definition at line 60 of file RdBeamFormer.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

RdBeamFormer::RdBeamFormer::RdBeamFormer ( )

Definition at line 82 of file RdBeamFormer.cc.

RdBeamFormer::RdBeamFormer::~RdBeamFormer ( )

Definition at line 86 of file RdBeamFormer.cc.

Member Function Documentation

TraceD RdBeamFormer::RdBeamFormer::crosscorr ( std::vector< revt::StationFFTDataContainer > &  stationData,
int  nStat,
double  binning,
int  start,
int  stop 
)

Definition at line 517 of file RdBeamFormer.cc.

References efieldproduct().

Referenced by Run().

void RdBeamFormer::RdBeamFormer::efieldproduct ( const revt::StationTimeSeries in1,
const revt::StationTimeSeries in2,
utl::TraceD out,
int  start,
int  stop 
)
inlineprivate

Definition at line 499 of file RdBeamFormer.cc.

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

Referenced by crosscorr().

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

Definition at line 546 of file RdBeamFormer.cc.

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

Referenced by powertrace().

evt::BeamPeak RdBeamFormer::RdBeamFormer::findPeak ( const utl::TraceD trace,
const double  timeOffset 
)
protected
VModule::ResultFlag RdBeamFormer::RdBeamFormer::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 1138 of file RdBeamFormer.cc.

References fwk::VModule::eSuccess, INFO, and waveModel.

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 RdBeamFormer::RdBeamFormer::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 91 of file RdBeamFormer.cc.

References RdBeamFormer::carthesian, fwk::VModule::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), gridtype, INFO, RdBeamFormer::none, offsetfactor, outfile, RdBeamFormer::polar, startbin, stopbin, waveModel, and waveModelConf.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

TraceD RdBeamFormer::RdBeamFormer::powertrace ( std::vector< revt::StationFFTDataContainer > &  stationData,
int  nStat,
double  binning,
int  start,
int  stop 
)

Definition at line 554 of file RdBeamFormer.cc.

References efieldtopower().

Referenced by Run().

RdBeamFormer::RdBeamFormer::REGISTER_MODULE ( "RdBeamFormer"  ,
RdBeamFormer   
)
private
VModule::ResultFlag RdBeamFormer::RdBeamFormer::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
double RdBeamFormer::RdBeamFormer::shiftTraces ( std::vector< revt::StationFFTDataContainer > &  stationData,
int &  nStat,
double &  binning,
int &  start,
int &  stop,
evt::Event event 
)
void RdBeamFormer::RdBeamFormer::WriteASCII ( const utl::TraceD cc,
const utl::TraceD power,
const utl::TraceD x,
const evt::BeamPeak &  ccPeak,
const evt::BeamPeak &  pwPeak,
const evt::BeamPeak &  xPeak,
const evt::Event event 
) const
private
void RdBeamFormer::RdBeamFormer::WritePeak ( const evt::BeamPeak &  Peak,
const std::string &  filename,
const evt::ShowerRRecData rrec 
) const
private
void RdBeamFormer::RdBeamFormer::WriteTrace ( const utl::TraceD trace,
const evt::BeamPeak &  Peak,
const std::string &  filename,
const evt::ShowerRRecData rrec 
) const
private
TraceD RdBeamFormer::RdBeamFormer::xtrace ( utl::TraceD  ccTrace,
utl::TraceD  ccNormal,
utl::TraceD  pwNormal 
)

Definition at line 577 of file RdBeamFormer.cc.

References utl::abs(), utl::Trace< T >::Begin(), utl::Trace< T >::End(), and result.

Referenced by Run().

Member Data Documentation

utl::CoordinateSystemPtr RdBeamFormer::RdBeamFormer::coreCS
private

Definition at line 97 of file RdBeamFormer.h.

Referenced by shiftTraces(), WriteASCII(), WritePeak(), and WriteTrace().

int fwk::VModule::fInfoLevel = 0
protectedinherited
long RdBeamFormer::RdBeamFormer::fNumCalls
mutableprivate

Definition at line 116 of file RdBeamFormer.h.

Referenced by WriteASCII(), and WritePeak().

enum gridtype_t RdBeamFormer::RdBeamFormer::gridtype
protected

Definition at line 90 of file RdBeamFormer.h.

Referenced by Init(), WritePeak(), and WriteTrace().

double RdBeamFormer::RdBeamFormer::offsetfactor
protected

Definition at line 88 of file RdBeamFormer.h.

Referenced by Init(), and shiftTraces().

std::string RdBeamFormer::RdBeamFormer::outfile
protected

Definition at line 91 of file RdBeamFormer.h.

Referenced by Init(), and WriteASCII().

int RdBeamFormer::RdBeamFormer::startbin
protected

Definition at line 87 of file RdBeamFormer.h.

Referenced by Init(), and WriteTrace().

int RdBeamFormer::RdBeamFormer::stopbin
protected

Definition at line 87 of file RdBeamFormer.h.

Referenced by Init().

RdWaveModel* RdBeamFormer::RdBeamFormer::waveModel
protected

Definition at line 84 of file RdBeamFormer.h.

Referenced by Finish(), Init(), and shiftTraces().

std::string RdBeamFormer::RdBeamFormer::waveModelConf
protected

Definition at line 85 of file RdBeamFormer.h.

Referenced by Init(), WriteASCII(), WritePeak(), and WriteTrace().


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

, generated on Tue Sep 26 2023.