Fast parametrization-based tank simulation. More...

#include <FastTankSimulator.h>

Inheritance diagram for FastTankSimulatorOG::FastTankSimulator:

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

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

VModule::ResultFlag	Init ()
	Initialize: invoked at beginning of run (NOT beginning of event) More...

void	InitTiming ()

VModule::ResultFlag	Run (evt::Event &event)
	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
double	CalculateDistanceInTank (const utl::Particle &p)

double	CalculateIntegratedCerenkovRate (const utl::Particle &p, const double)

void	CalculatePhotoElectrons (const utl::Particle &p, const double)

	REGISTER_MODULE ("FastTankSimulatorOG", FastTankSimulator)

void	SimulateComptonScattering (const utl::Particle &p)

void	SimulateElectrons (const utl::Particle &p)

void	SimulateMuons (const utl::Particle &p)

void	SimulatePairProduction (const utl::Particle &p)

void	SimulatePhotons (const utl::Particle &p)

Private Attributes
double	fCerenkovMinElectron = 0

double	fCerenkovMinMuon = 0

const sdet::Station *	fCurrentDetectorStation = nullptr

sevt::Station *	fCurrentEventStation = nullptr

double	fdEdXElectron = 0

double	fdEdXMuon = 0

double	fEMinPhoton = 0

utl::Particle	fInitialParticle

utl::TabulatedFunction	fPairProductionProbability

std::vector< double >	fPECumulativeProbability

double	fPhotoElectronRate = 0

utl::TabulatedFunction	fPhotonInteractionLength

utl::RandomEngine *	fRandomEngine = nullptr

double	fTankHeight = 0

double	fTankRadiusSquared = 0

double	fWaterRIndex = 0

Detailed Description

Fast parametrization-based tank simulation.

Author: Troy Porter

Date: 09 Sep 2003

Definition at line 38 of file FastTankSimulator.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

FastTankSimulator::FastTankSimulator ( )

Definition at line 54 of file FastTankSimulator.cc.

Member Function Documentation

double FastTankSimulator::CalculateDistanceInTank ( const utl::Particle & p )

private

Definition at line 179 of file FastTankSimulator.cc.

References RdGeoCeLDFFitter::a, RdGeoCeLDFFitter::b, RdGeoCeLDFFitter::c, fCurrentDetectorStation, fTankHeight, fTankRadiusSquared, utl::Particle::GetDirection(), sdet::Station::GetLocalCoordinateSystem(), utl::Particle::GetPosition(), utl::BasicVector< HepVector >::GetRho(), utl::BasicVector< HepVector >::GetRho2(), utl::Sqr(), and sqrt().

Referenced by SimulateElectrons(), SimulateMuons(), and SimulatePhotons().

double FastTankSimulator::CalculateIntegratedCerenkovRate	(	const utl::Particle &	p,
		const double	energyLoss
	)

private

Definition at line 209 of file FastTankSimulator.cc.

References utl::Particle::eAntiMuon, utl::Particle::eElectron, utl::Particle::eMuon, utl::Particle::ePositron, fdEdXElectron, fdEdXMuon, fPhotoElectronRate, fWaterRIndex, utl::Particle::GetKineticEnergy(), utl::Particle::GetType(), utl::kElectronMass, utl::kMuonMass, and utl::Sqr().

Referenced by SimulateElectrons(), and SimulateMuons().

void FastTankSimulator::CalculatePhotoElectrons	(	const utl::Particle &	p,
		const double	cerenkovRate
	)

private

VModule::ResultFlag FastTankSimulator::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 172 of file FastTankSimulator.cc.

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 FastTankSimulator::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 67 of file FastTankSimulator.cc.

References fwk::VModule::eSuccess, fCerenkovMinElectron, fCerenkovMinMuon, fdEdXElectron, fdEdXMuon, fEMinPhoton, fPairProductionProbability, fPECumulativeProbability, fPhotoElectronRate, fPhotonInteractionLength, fRandomEngine, fWaterRIndex, utl::Branch::GetChild(), utl::Branch::GetData(), and utl::Branch::GetTopBranch().