Simulates filter and FADC sampling for SD. More...

#include "Modules/SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.h"

Inheritance diagram for SdFilterFADCSimulatorMTU::SdFilterFADCSimulator:

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

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

ResultFlag	RunWithTiming (evt::Event &event)

	SdFilterFADCSimulator ()=default

virtual	~SdFilterFADCSimulator ()=default

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	FillConvolResult (utl::TimeDistributionD &convRes, const utl::TimeDistributionD &trace)

template<typename T >
void	FillFADCTraces (utl::TimeDistribution< T > &trace, const unsigned int traceLength, const double binSize, const double current2VoltageMultiplier, const double voltage2FADCMultiplier, const utl::TimeDistributionD &convRes, const double gain, const double tickTime, const double delay, const std::vector< double > &tau, const std::vector< double > &ampl)

void	FillImpulseResponse (const utl::TabulatedFunction &rawResponse, const double timeBinning)

	REGISTER_MODULE ("SdFilterFADCSimulatorMTU", SdFilterFADCSimulator)

void	SimulateUndershoot (utl::TimeDistributionD &trace, const double current2VoltageMultiplier, const double timeconst, const double ampl=1, const int postfix=0)

Private Attributes
double	fAmplSaturation = 0

std::vector< double >	fHighGainAmplifications

double	fHighGainMultiplier = 0

std::vector< double >	fHighGainRC

utl::TraceD	fImpulseResponse

std::vector< double >	fLowGainAmplifications

double	fLowGainMultiplier = 0

std::vector< double >	fLowGainRC

bool	fStoreBaseSignals = true

bool	fStoreFilterSignals = true

Detailed Description

Simulates filter and FADC sampling for SD.

Author: Majid A Mohammed, Alexei Dorofeev, Jim Chye; Tom Paul, Darko Veberic

Date: April 2004; Sep 2005 DV cleanup convolution

Definition at line 34 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.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

SdFilterFADCSimulatorMTU::SdFilterFADCSimulator::SdFilterFADCSimulator ( )

default

virtual SdFilterFADCSimulatorMTU::SdFilterFADCSimulator::~SdFilterFADCSimulator ( )

virtualdefault

Member Function Documentation

void SdFilterFADCSimulator::FillConvolResult	(	utl::TimeDistributionD &	convRes,
		const utl::TimeDistributionD &	trace
	)

private

Definition at line 319 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.cc.

References utl::TimeDistribution< T >::AddTime(), utl::TimeDistribution< T >::At(), utl::TimeDistribution< T >::Clear(), Delete(), utl::TimeDistribution< T >::GetStart(), and utl::TimeDistribution< T >::GetStop().

template<typename T >

void SdFilterFADCSimulator::FillFADCTraces	(	utl::TimeDistribution< T > &	trace,
		const unsigned int	traceLength,
		const double	binSize,
		const double	current2VoltageMultiplier,
		const double	voltage2FADCMultiplier,
		const utl::TimeDistributionD &	convRes,
		const double	gain,
		const double	tickTime,
		const double	delay,
		const std::vector< double > &	tau,
		const std::vector< double > &	ampl
	)

private

Definition at line 115 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.cc.

References utl::TimeDistribution< T >::At(), utl::TimeDistribution< T >::Clear(), utl::TimeDistribution< T >::GetBinning(), utl::TimeDistribution< T >::GetStart(), utl::TimeDistribution< T >::GetStop(), and utl::TimeDistribution< T >::SetTime().

void SdFilterFADCSimulator::FillImpulseResponse	(	const utl::TabulatedFunction &	rawResponse,
		const double	timeBinning
	)

private

Definition at line 352 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.cc.

References utl::TabulatedFunction::InterpolateY(), and utl::TabulatedFunction::IsInValidRange().

fwk::VModule::ResultFlag SdFilterFADCSimulatorMTU::SdFilterFADCSimulator::Finish ( )

inlineoverridevirtual

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 42 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.h.

References fwk::VModule::eSuccess.

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 SdFilterFADCSimulator::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 62 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.cc.

References ERROR, io::eSuccess, INFO, utl::ms, utl::StringEquivalent(), and galactic::volt.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

SdFilterFADCSimulatorMTU::SdFilterFADCSimulator::REGISTER_MODULE	(	"SdFilterFADCSimulatorMTU"	,
		SdFilterFADCSimulator
	)

private

VModule::ResultFlag SdFilterFADCSimulator::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 155 of file SdFilterFADCSimulatorMTU/SdFilterFADCSimulator.cc.

References sdet::PMTConstants::eAnyType, sdet::PMTConstants::eHighGain, sdet::PMTConstants::eLowGain, io::eSuccess, sevt::StationConstants::eTotal, sevt::StationConstants::eTotalNoSaturation, evt::Event::HasSEvent(), INFO, max, and utl::nanosecond.

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 SdFilterFADCSimulator::SimulateUndershoot	(	utl::TimeDistributionD &	trace,
		const double	current2VoltageMultiplier,
		const double	timeconst,
		const double	ampl = `1`,
		const int	postfix = `0`
	)