#include <RdChannelNoiseGenerator.h>

Inheritance diagram for RdChannelNoiseGenerator::RdChannelNoiseGenerator:

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

void	InitTiming ()

	RdChannelNoiseGenerator ()

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

ResultFlag	RunWithTiming (evt::Event &event)

	~RdChannelNoiseGenerator () override

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

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

Private Member Functions
	REGISTER_MODULE ("RdChannelNoiseGenerator", RdChannelNoiseGenerator)

Private Attributes
int	fInfoLevel

utl::ShadowPtr< utl::Noise >	fNoise

utl::ShadowPtr< utl::NoiseSaS >	fNoise_time_domain

double	fNoiseRMS

std::string	fNoiseType

double	fSaSAlphaOverride

double	fSaSSigmaOverride

boost::uniform_real< double >	interval_h

boost::uniform_real< double >	interval_noise

boost::mt19937	randgen

boost::variate_generator < boost::mt19937, boost::uniform_real< double > >	randomGenerator_h

boost::variate_generator < boost::mt19937, boost::uniform_real< double > >	randomGenerator_sigma

Friends
class	utl::ShadowPtr< utl::Noise >

Detailed Description

Definition at line 38 of file RdChannelNoiseGenerator.h.

Member Enumeration Documentation

enum RdChannelNoiseGenerator::RdChannelNoiseGenerator::InfoLevel

private

Enumerator
eNone
eFinal
eIntermediate
eObscure
eDebug

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

RdChannelNoiseGenerator::RdChannelNoiseGenerator::RdChannelNoiseGenerator ( )

Definition at line 37 of file RdChannelNoiseGenerator.cc.

RdChannelNoiseGenerator::RdChannelNoiseGenerator::~RdChannelNoiseGenerator ( )

inlineoverride

Definition at line 45 of file RdChannelNoiseGenerator.h.

Member Function Documentation

VModule::ResultFlag RdChannelNoiseGenerator::RdChannelNoiseGenerator::Finish ( )

overridevirtual

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 196 of file RdChannelNoiseGenerator.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 RdChannelNoiseGenerator::RdChannelNoiseGenerator::Init ( )

overridevirtual

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 51 of file RdChannelNoiseGenerator.cc.

References utl::eDayAtmosphereNoise, fwk::VModule::eFailure, utl::eNightAtmosphereNoise, utl::eNoAtmosphereNoise, utl::eNoIndustryNoise, utl::eRuralIndustryNoise, fwk::VModule::eSuccess, utl::eUrbanIndustryNoise, fInfoLevel, fNoise, fNoise_time_domain, fNoiseRMS, fNoiseType, fSaSAlphaOverride, fSaSSigmaOverride, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, utl::StringEquivalent(), and WARNING.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelNoiseGenerator::RdChannelNoiseGenerator::REGISTER_MODULE	(	"RdChannelNoiseGenerator"	,
		RdChannelNoiseGenerator
	)

private

VModule::ResultFlag RdChannelNoiseGenerator::RdChannelNoiseGenerator::Run ( evt::Event & event )

overridevirtual

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 107 of file RdChannelNoiseGenerator.cc.

References revt::Station::ChannelsBegin(), revt::Station::ChannelsEnd(), utl::NoiseSaS::CreateSaSNoiseInTimeDomain(), fwk::VModule::eContinueLoop, fwk::VModule::eSuccess, fNoise, fNoise_time_domain, fNoiseRMS, fNoiseType, fSaSAlphaOverride, fSaSSigmaOverride, utl::Trace< T >::GetBinning(), revt::Channel::GetChannelFrequencySpectrum(), revt::Channel::GetChannelTimeSeries(), revt::Channel::GetFFTDataContainer(), revt::Channel::GetFrequencyOfBin(), utl::FFTDataContainer< C, T, F >::GetFrequencySpectrum(), revt::Channel::GetId(), revt::Station::GetId(), rdet::Channel::GetIntegratedEffectiveAntennaHeight(), det::Detector::GetRDetector(), evt::Event::GetREvent(), utl::Trace< T >::GetSize(), utl::Noise::GetSpectralFieldNoiseAtFrequency(), rdet::RDetector::GetStation(), revt::REvent::GetStation(), utl::FFTDataContainer< C, T, F >::GetTimeSeries(), evt::Event::HasREvent(), INFO, std::pow(), randomGenerator_h, randomGenerator_sigma, utl::TraceAlgorithm::RootMeanSquare(), 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().

Friends And Related Function Documentation

friend class utl::ShadowPtr< utl::Noise >

friend

Definition at line 74 of file RdChannelNoiseGenerator.h.

Member Data Documentation

int RdChannelNoiseGenerator::RdChannelNoiseGenerator::fInfoLevel

private

Definition at line 62 of file RdChannelNoiseGenerator.h.

Referenced by Init().

utl::ShadowPtr<utl::Noise> RdChannelNoiseGenerator::RdChannelNoiseGenerator::fNoise

private

Definition at line 72 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

utl::ShadowPtr<utl::NoiseSaS> RdChannelNoiseGenerator::RdChannelNoiseGenerator::fNoise_time_domain

private

Definition at line 73 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

double RdChannelNoiseGenerator::RdChannelNoiseGenerator::fNoiseRMS

private

Definition at line 65 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

std::string RdChannelNoiseGenerator::RdChannelNoiseGenerator::fNoiseType

private

Definition at line 52 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

double RdChannelNoiseGenerator::RdChannelNoiseGenerator::fSaSAlphaOverride

private

Definition at line 64 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

double RdChannelNoiseGenerator::RdChannelNoiseGenerator::fSaSSigmaOverride

private

Definition at line 63 of file RdChannelNoiseGenerator.h.

Referenced by Init(), and Run().

boost::uniform_real<double> RdChannelNoiseGenerator::RdChannelNoiseGenerator::interval_h

private

Definition at line 69 of file RdChannelNoiseGenerator.h.

boost::uniform_real<double> RdChannelNoiseGenerator::RdChannelNoiseGenerator::interval_noise

private

Definition at line 68 of file RdChannelNoiseGenerator.h.

boost::mt19937 RdChannelNoiseGenerator::RdChannelNoiseGenerator::randgen

private

Definition at line 67 of file RdChannelNoiseGenerator.h.

boost::variate_generator<boost::mt19937, boost::uniform_real<double> > RdChannelNoiseGenerator::RdChannelNoiseGenerator::randomGenerator_h

private

Definition at line 71 of file RdChannelNoiseGenerator.h.

Referenced by Run().

boost::variate_generator<boost::mt19937, boost::uniform_real<double> > RdChannelNoiseGenerator::RdChannelNoiseGenerator::randomGenerator_sigma

private

Definition at line 70 of file RdChannelNoiseGenerator.h.

Referenced by Run().

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

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation