#include <RdChannelBeaconSimulator.h>

Inheritance diagram for RdChannelBeaconSimulator::RdChannelBeaconSimulator:

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

	RdChannelBeaconSimulator ()

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

ResultFlag	RunWithTiming (evt::Event &event)

virtual	~RdChannelBeaconSimulator ()

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
	REGISTER_MODULE ("RdChannelBeaconSimulator", RdChannelBeaconSimulator)

void	RemoveDCOffset (revt::ChannelTimeSeries &)
	DC Offset subtraction. More...

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

Private Attributes
double	fAmplitude
	Amplitude of beacon signal. More...

std::vector< double >	fBeaconFrequencies
	Vector of frequencies to simulate. More...

std::vector< double >	fBeaconPosition
	Vector for the position of the beacon. More...

std::string	fOutputShiftFile
	Name of file for ASCII output of shifts (not needed for normal analysis) More...

int	fTimeJitter
	Simulate GPS time jitter. More...

double	fTimeJitterMean
	Mean of gaussian distibution for the time jitter. More...

Detailed Description

Definition at line 23 of file RdChannelBeaconSimulator.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.

Constructor & Destructor Documentation

RdChannelBeaconSimulator::RdChannelBeaconSimulator::RdChannelBeaconSimulator ( )

Definition at line 48 of file RdChannelBeaconSimulator.cc.

RdChannelBeaconSimulator::RdChannelBeaconSimulator::~RdChannelBeaconSimulator ( )

virtual

Definition at line 53 of file RdChannelBeaconSimulator.cc.

Member Function Documentation

VModule::ResultFlag RdChannelBeaconSimulator::RdChannelBeaconSimulator::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 210 of file RdChannelBeaconSimulator.cc.

References fwk::VModule::eSuccess, 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 RdChannelBeaconSimulator::RdChannelBeaconSimulator::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 RdChannelBeaconSimulator.cc.

References fwk::VModule::eSuccess, fAmplitude, fBeaconFrequencies, fBeaconPosition, fOutputShiftFile, fTimeJitter, fTimeJitterMean, 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().

RdChannelBeaconSimulator::RdChannelBeaconSimulator::REGISTER_MODULE	(	"RdChannelBeaconSimulator"	,
		RdChannelBeaconSimulator
	)

private

void RdChannelBeaconSimulator::RdChannelBeaconSimulator::RemoveDCOffset ( revt::ChannelTimeSeries & )

private

DC Offset subtraction.

VModule::ResultFlag RdChannelBeaconSimulator::RdChannelBeaconSimulator::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 82 of file RdChannelBeaconSimulator.cc.

References utl::abs(), revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), fwk::VModule::eContinueLoop, fwk::VModule::eSuccess, fAmplitude, fBeaconFrequencies, fBeaconPosition, fOutputShiftFile, fTimeJitter, fTimeJitterMean, revt::Channel::GetChannelFrequencySpectrum(), revt::Channel::GetFFTDataContainer(), revt::Channel::GetFrequencyOfBin(), revt::Channel::GetId(), rdet::Station::GetId(), rdet::Station::GetPosition(), det::Detector::GetRDetector(), det::Detector::GetReferenceCoordinateSystem(), utl::Trace< T >::GetSize(), rdet::RDetector::GetStation(), evt::Event::HasREvent(), utl::hertz, INFO, revt::Channel::IsActive(), utl::kPi, utl::kTwoPi, max, utl::megahertz, mod(), std::pow(), result, sqrt(), RdChannelBeaconSimulator::ToString(), 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 RdChannelBeaconSimulator::RdChannelBeaconSimulator::timeShift	(	revt::Channel &	,
		const utl::TimeInterval &
	)		const

private

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

Member Data Documentation

double RdChannelBeaconSimulator::RdChannelBeaconSimulator::fAmplitude

private

Amplitude of beacon signal.

Definition at line 48 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

std::vector<double> RdChannelBeaconSimulator::RdChannelBeaconSimulator::fBeaconFrequencies

private

Vector of frequencies to simulate.

Definition at line 54 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

std::vector<double> RdChannelBeaconSimulator::RdChannelBeaconSimulator::fBeaconPosition

private

Vector for the position of the beacon.

Definition at line 39 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

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

std::string RdChannelBeaconSimulator::RdChannelBeaconSimulator::fOutputShiftFile

private

Name of file for ASCII output of shifts (not needed for normal analysis)

Definition at line 51 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

int RdChannelBeaconSimulator::RdChannelBeaconSimulator::fTimeJitter

private

Simulate GPS time jitter.

Definition at line 42 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

double RdChannelBeaconSimulator::RdChannelBeaconSimulator::fTimeJitterMean

private

Mean of gaussian distibution for the time jitter.

Definition at line 45 of file RdChannelBeaconSimulator.h.

Referenced by Init(), and Run().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation