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

#include <RdPolarGrid.h>

Inheritance diagram for RdPolarGrid::RdPolarGrid:
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 ()
 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 ()
 
 RdPolarGrid ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
utl::Vector skyVector (evt::Event &event)
 
 ~RdPolarGrid ()
 

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

 REGISTER_MODULE ("RdPolarGrid", RdPolarGrid)
 
evt::ShowerRRecDataRRecShower (evt::Event &event)
 
void setRRecDirection (utl::Vector dir, evt::Event &event)
 
void start (evt::Event &event)
 
bool step ()
 

Protected Attributes

utl::CoordinateSystemPtr coreCS
 
utl::Point corePos
 
int fInfoLevel = 0
 
int fNumberOfStepsFromTrueDirection
 
double fStepFromTrueDirection
 
bool fUseStepFromTrueDirection
 
bool fUseTrueDirection
 
int iB
 
int iPhi
 
int iR
 
int iRho
 
int iTh
 
double maxB
 
double maxPhi
 
double maxR
 
double maxRho
 
double maxTh
 
double minB
 
double minPhi
 
double minR
 
double minRho
 
double minTh
 
int nB
 
int nPhi
 
int nR
 
int nRho
 
int nTh
 
std::string waveModel
 

Detailed Description

Definition at line 46 of file RdPolarGrid.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

RdPolarGrid::RdPolarGrid::RdPolarGrid ( )

Definition at line 49 of file RdPolarGrid.cc.

RdPolarGrid::RdPolarGrid::~RdPolarGrid ( )

Definition at line 53 of file RdPolarGrid.cc.

Member Function Documentation

VModule::ResultFlag RdPolarGrid::RdPolarGrid::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 497 of file RdPolarGrid.cc.

References DEBUGLOG, and 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 RdPolarGrid::RdPolarGrid::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 58 of file RdPolarGrid.cc.

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

RdPolarGrid::RdPolarGrid::REGISTER_MODULE ( "RdPolarGrid"  ,
RdPolarGrid   
)
protected
evt::ShowerRRecData & RdPolarGrid::RdPolarGrid::RRecShower ( evt::Event event)
protected
VModule::ResultFlag RdPolarGrid::RdPolarGrid::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 461 of file RdPolarGrid.cc.

References DEBUGLOG, io::eSuccess, revt::REvent::GetHeader(), revt::Header::GetId(), evt::Event::HasREvent(), PRINT, and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
void RdPolarGrid::RdPolarGrid::setRRecDirection ( utl::Vector  dir,
evt::Event event 
)
protected
Vector RdPolarGrid::RdPolarGrid::skyVector ( evt::Event event)
void RdPolarGrid::RdPolarGrid::start ( evt::Event event)
protected

Definition at line 234 of file RdPolarGrid.cc.

References DEBUGLOG.

bool RdPolarGrid::RdPolarGrid::step ( )
protected

Definition at line 114 of file RdPolarGrid.cc.

References DEBUGLOG.

Member Data Documentation

utl::CoordinateSystemPtr RdPolarGrid::RdPolarGrid::coreCS
protected

Definition at line 62 of file RdPolarGrid.h.

utl::Point RdPolarGrid::RdPolarGrid::corePos
protected

Definition at line 63 of file RdPolarGrid.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
int RdPolarGrid::RdPolarGrid::fNumberOfStepsFromTrueDirection
protected

Definition at line 69 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::fStepFromTrueDirection
protected

Definition at line 68 of file RdPolarGrid.h.

bool RdPolarGrid::RdPolarGrid::fUseStepFromTrueDirection
protected

Definition at line 66 of file RdPolarGrid.h.

bool RdPolarGrid::RdPolarGrid::fUseTrueDirection
protected

Definition at line 65 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::iB
protected

Definition at line 71 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::iPhi
protected

Definition at line 71 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::iR
protected

Definition at line 71 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::iRho
protected

Definition at line 71 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::iTh
protected

Definition at line 71 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::maxB
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::maxPhi
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::maxR
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::maxRho
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::maxTh
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::minB
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::minPhi
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::minR
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::minRho
protected

Definition at line 73 of file RdPolarGrid.h.

double RdPolarGrid::RdPolarGrid::minTh
protected

Definition at line 73 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::nB
protected

Definition at line 72 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::nPhi
protected

Definition at line 72 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::nR
protected

Definition at line 72 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::nRho
protected

Definition at line 72 of file RdPolarGrid.h.

int RdPolarGrid::RdPolarGrid::nTh
protected

Definition at line 72 of file RdPolarGrid.h.

std::string RdPolarGrid::RdPolarGrid::waveModel
protected

Definition at line 74 of file RdPolarGrid.h.


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

, generated on Tue Sep 26 2023.