#include <RdChannelResponseIncorporator.h>

Inheritance diagram for RdChannelResponseIncorporator::RdChannelResponseIncorporator:

Public Types
typedef boost::tuple < utl::ResponseMap, utl::TabulatedFunctionComplexLgAmpPhase, long >	CacheRecord

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

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

ResultFlag	RunWithTiming (evt::Event &event)

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
void	ApplyResponse (revt::Channel &channel, const utl::TabulatedFunctionComplexLgAmpPhase &response, bool inverse, double lowerfreq, double upperfreq) const

utl::TabulatedFunctionComplexLgAmpPhase	CalculateOverallResponse (const utl::ResponseMap &responsemap) const

const utl::TabulatedFunctionComplexLgAmpPhase &	GetCachedOverallResponse (const utl::ResponseMap &responsemap) const

	REGISTER_MODULE ("RdChannelResponseIncorporator", RdChannelResponseIncorporator)

Private Attributes
long	fCacheAsks = 0

long	fCacheHits = 0

std::vector< CacheRecord >	fCacheRegistry

bool	fForwardBandLimitsOverride = false

double	fForwardLowerFrequency = 0

bool	fForwardResponseOnFirstCall = false

double	fForwardUpperFrequency = 0

bool	fInverseBandLimitsOverride = false

double	fInverseLowerFrequency = 0

double	fInverseUpperFrequency = 0

unsigned int	fNumResponsesToCache = 5

utl::RandomEngine *	fRandomEngine = nullptr

double	fRelativeGaussianUcertainty = 0.0

bool	fSmearChannelTraceToMimicInaccurateHardwareDescription = false

Detailed Description

Definition at line 32 of file RdChannelResponseIncorporator.h.

Member Typedef Documentation

typedef boost::tuple<utl::ResponseMap, utl::TabulatedFunctionComplexLgAmpPhase, long> RdChannelResponseIncorporator::RdChannelResponseIncorporator::CacheRecord

Definition at line 39 of file RdChannelResponseIncorporator.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.

Member Function Documentation

void RdChannelResponseIncorporator::RdChannelResponseIncorporator::ApplyResponse	(	revt::Channel &	channel,
		const utl::TabulatedFunctionComplexLgAmpPhase &	response,
		bool	inverse,
		double	lowerfreq,
		double	upperfreq
	)		const

private

Definition at line 234 of file RdChannelResponseIncorporator.cc.

References freq, revt::Channel::GetChannelFrequencySpectrum(), utl::ComplexLgAmpPhase::GetComplex(), revt::Channel::GetFrequencyOfBin(), utl::Trace< T >::GetSize(), and utl::TabulatedFunctionComplexLgAmpPhase::Y().

TabulatedFunctionComplexLgAmpPhase RdChannelResponseIncorporator::RdChannelResponseIncorporator::CalculateOverallResponse ( const utl::ResponseMap & responsemap ) const

private

Definition at line 209 of file RdChannelResponseIncorporator.cc.

References utl::ResponseMap::Begin(), utl::ResponseMap::End(), rdet::RDetector::GetHardwareResponseProfile(), and utl::TabulatedFunctionComplexLgAmpPhase::Pow().

VModule::ResultFlag RdChannelResponseIncorporator::RdChannelResponseIncorporator::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 171 of file RdChannelResponseIncorporator.cc.

References io::eSuccess, and INFO.

const TabulatedFunctionComplexLgAmpPhase & RdChannelResponseIncorporator::RdChannelResponseIncorporator::GetCachedOverallResponse ( const utl::ResponseMap & responsemap ) const

private

Definition at line 185 of file RdChannelResponseIncorporator.cc.

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 RdChannelResponseIncorporator::RdChannelResponseIncorporator::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 38 of file RdChannelResponseIncorporator.cc.

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

RdChannelResponseIncorporator::RdChannelResponseIncorporator::REGISTER_MODULE	(	"RdChannelResponseIncorporator"	,
		RdChannelResponseIncorporator
	)

private

VModule::ResultFlag RdChannelResponseIncorporator::RdChannelResponseIncorporator::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 74 of file RdChannelResponseIncorporator.cc.

References io::eSuccess, revt::REvent::GetChannelResponseApplied(), rdet::Channel::GetDesignLowerFreq(), rdet::Channel::GetDesignUpperFreq(), det::Detector::GetRDetector(), rdet::Channel::GetResponseMap(), rdet::RDetector::GetStation(), evt::Event::HasREvent(), INFO, INFODebug, INFOIntermediate, revt::REvent::SetChannelResponseApplied(), 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().

Member Data Documentation

long RdChannelResponseIncorporator::RdChannelResponseIncorporator::fCacheAsks = 0

mutableprivate

Definition at line 44 of file RdChannelResponseIncorporator.h.

long RdChannelResponseIncorporator::RdChannelResponseIncorporator::fCacheHits = 0

mutableprivate

Definition at line 45 of file RdChannelResponseIncorporator.h.

std::vector<CacheRecord> RdChannelResponseIncorporator::RdChannelResponseIncorporator::fCacheRegistry

mutableprivate

Definition at line 46 of file RdChannelResponseIncorporator.h.

bool RdChannelResponseIncorporator::RdChannelResponseIncorporator::fForwardBandLimitsOverride = false

private

Definition at line 50 of file RdChannelResponseIncorporator.h.

double RdChannelResponseIncorporator::RdChannelResponseIncorporator::fForwardLowerFrequency = 0

private

Definition at line 51 of file RdChannelResponseIncorporator.h.

bool RdChannelResponseIncorporator::RdChannelResponseIncorporator::fForwardResponseOnFirstCall = false

private

Definition at line 43 of file RdChannelResponseIncorporator.h.

double RdChannelResponseIncorporator::RdChannelResponseIncorporator::fForwardUpperFrequency = 0

private

Definition at line 52 of file RdChannelResponseIncorporator.h.

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

bool RdChannelResponseIncorporator::RdChannelResponseIncorporator::fInverseBandLimitsOverride = false

private

Definition at line 47 of file RdChannelResponseIncorporator.h.

double RdChannelResponseIncorporator::RdChannelResponseIncorporator::fInverseLowerFrequency = 0

private

Definition at line 48 of file RdChannelResponseIncorporator.h.

double RdChannelResponseIncorporator::RdChannelResponseIncorporator::fInverseUpperFrequency = 0

private

Definition at line 49 of file RdChannelResponseIncorporator.h.

unsigned int RdChannelResponseIncorporator::RdChannelResponseIncorporator::fNumResponsesToCache = 5

private

Definition at line 42 of file RdChannelResponseIncorporator.h.

utl::RandomEngine* RdChannelResponseIncorporator::RdChannelResponseIncorporator::fRandomEngine = nullptr

private

Definition at line 57 of file RdChannelResponseIncorporator.h.

double RdChannelResponseIncorporator::RdChannelResponseIncorporator::fRelativeGaussianUcertainty = 0.0

private

Definition at line 55 of file RdChannelResponseIncorporator.h.

bool RdChannelResponseIncorporator::RdChannelResponseIncorporator::fSmearChannelTraceToMimicInaccurateHardwareDescription = false

private

Definition at line 54 of file RdChannelResponseIncorporator.h.

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 Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation