#include <RdStationBeamFormer.h>

Inheritance diagram for RdStationBeamFormer::RdStationBeamFormer:

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::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 ()
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

	RdStationBeamFormer ()

fwk::VModule::ResultFlag	Run (evt::Event &event)
	Run: invoked once per event. More...

ResultFlag	RunWithTiming (evt::Event &event)

virtual	~RdStationBeamFormer ()

Static Public Member Functions
static std::string	GetResultFlagByName (const ResultFlag flag)

Private Types
enum	InfoLevel { eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3, eMinuit = 4, eDebug = 5 }

enum	WaveFront { ePlane = 0, eSphere = 1 }

Private Member Functions
	REGISTER_MODULE ("RdStationBeamFormer", RdStationBeamFormer)

void	timeShift (revt::Station &, const utl::TimeInterval &) const
	shifts the station trace in time by multiplying a phasegradient to the spectrum More...

Private Attributes
int	fInfoLevel
	xml settings: info level (verbosity) More...

double	fRefractionIndex
	index of refraction used to calculate speed of light More...

double	fSpeedOfLight
	speed of light used for beam forming More...

int	fWaveFront
	wave front type used for beam forming More...

Detailed Description

Definition at line 36 of file RdStationBeamFormer.h.

Member Enumeration Documentation

enum RdStationBeamFormer::RdStationBeamFormer::InfoLevel

private

Enumerator
eNone
eFinal
eIntermediate
eObscure
eMinuit
eDebug

Definition at line 51 of file RdStationBeamFormer.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.

enum RdStationBeamFormer::RdStationBeamFormer::WaveFront

private

Enumerator
ePlane
eSphere

Definition at line 62 of file RdStationBeamFormer.h.

Constructor & Destructor Documentation

RdStationBeamFormer::RdStationBeamFormer::RdStationBeamFormer ( )

Definition at line 44 of file RdStationBeamFormer.cc.

RdStationBeamFormer::RdStationBeamFormer::~RdStationBeamFormer ( )

virtual

Definition at line 53 of file RdStationBeamFormer.cc.

Member Function Documentation

VModule::ResultFlag RdStationBeamFormer::RdStationBeamFormer::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 173 of file RdStationBeamFormer.cc.

References eFinal, fwk::VModule::eSuccess, fInfoLevel, and INFO.

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 RdStationBeamFormer::RdStationBeamFormer::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 59 of file RdStationBeamFormer.cc.

References fwk::VModule::eSuccess, fInfoLevel, fRefractionIndex, fSpeedOfLight, fWaveFront, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, and utl::kSpeedOfLight.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdStationBeamFormer::RdStationBeamFormer::REGISTER_MODULE	(	"RdStationBeamFormer"	,
		RdStationBeamFormer
	)

private

VModule::ResultFlag RdStationBeamFormer::RdStationBeamFormer::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 84 of file RdStationBeamFormer.cc.

References fwk::VModule::eContinueLoop, eDebug, eFinal, eObscure, ERROR, fwk::VModule::eSuccess, fInfoLevel, fSpeedOfLight, evt::ShowerRRecData::GetAxis(), evt::ShowerRRecData::GetCorePosition(), revt::REvent::GetNumberOfStations(), rdet::Station::GetPosition(), det::Detector::GetRDetector(), evt::ShowerRecData::GetRRecShower(), rdet::RDetector::GetStation(), evt::Event::HasRecShower(), evt::Event::HasREvent(), evt::ShowerRecData::HasRRecShower(), INFO, galactic::meter, utl::nanosecond, revt::REvent::StationsBegin(), revt::REvent::StationsEnd(), and WARNING.

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().

void RdStationBeamFormer::RdStationBeamFormer::timeShift	(	revt::Station &	station,
		const utl::TimeInterval &	shift
	)		const

private

shifts the station trace in time by multiplying a phasegradient to the spectrum

Definition at line 185 of file RdStationBeamFormer.cc.

References revt::Station::GetFrequencyOfBin(), utl::TimeInterval::GetInterval(), utl::Trace< T >::GetSize(), revt::Station::GetStationFrequencySpectrum(), and utl::kTwoPi.

Member Data Documentation

int RdStationBeamFormer::RdStationBeamFormer::fInfoLevel

private

xml settings: info level (verbosity)

Definition at line 60 of file RdStationBeamFormer.h.

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

double RdStationBeamFormer::RdStationBeamFormer::fRefractionIndex

private

index of refraction used to calculate speed of light

Definition at line 70 of file RdStationBeamFormer.h.

Referenced by Init().

double RdStationBeamFormer::RdStationBeamFormer::fSpeedOfLight

private

speed of light used for beam forming

Definition at line 73 of file RdStationBeamFormer.h.

Referenced by Init(), and Run().

int RdStationBeamFormer::RdStationBeamFormer::fWaveFront

private

wave front type used for beam forming

Definition at line 67 of file RdStationBeamFormer.h.

Referenced by Init().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation