List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | Private Attributes
SpotPhotonGeneratorOG::SpotPhotonGenerator Class Reference

Simulates drum photons entering the FD telescope. More...

#include <SpotPhotonGenerator.h>

Inheritance diagram for SpotPhotonGeneratorOG::SpotPhotonGenerator:
Inheritance graph
[legend]

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::StopwatchGetStopwatch ()
 
const utl::StopwatchGetStopwatch () 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 ()
 
fwk::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

bool DoSpot (evt::Event &event)
 
void FinishSpot ()
 
void FinishTelescope ()
 
 REGISTER_MODULE ("SpotPhotonGeneratorOG", SpotPhotonGenerator)
 

Private Attributes

unsigned int fCurrentEyeId
 
unsigned int fCurrentPixId
 
unsigned int fCurrentTelId
 
std::map< int, double > fEfficiencies
 
std::map< int, double > fEfficienciesErr
 
unsigned int fMaxBin
 
unsigned int fMinBin
 
int fNSpotPhotons
 
utl::RandomEnginefRandomEngine
 
double fRDiaMin
 
TelescopeSimulatorKG::TelescopeSimulator::PhotonList fSpotPhotonList
 

Detailed Description

Simulates drum photons entering the FD telescope.

Author
Ralf Ulrich
Date
Fri Dec 15 11:50:43 CET 2006

Definition at line 56 of file SpotPhotonGenerator.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.

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

bool SpotPhotonGenerator::DoSpot ( evt::Event event)
private
VModule::ResultFlag SpotPhotonGenerator::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 398 of file SpotPhotonGenerator.cc.

References io::eSuccess.

void SpotPhotonGenerator::FinishSpot ( )
private
void SpotPhotonGenerator::FinishTelescope ( )
private

Definition at line 357 of file SpotPhotonGenerator.cc.

References file, filename, and INFO.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
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
VModule::ResultFlag SpotPhotonGenerator::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 90 of file SpotPhotonGenerator.cc.

References ERROR, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, and utl::m.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

SpotPhotonGeneratorOG::SpotPhotonGenerator::REGISTER_MODULE ( "SpotPhotonGeneratorOG"  ,
SpotPhotonGenerator   
)
private
VModule::ResultFlag SpotPhotonGenerator::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

unsigned int SpotPhotonGeneratorOG::SpotPhotonGenerator::fCurrentEyeId
private

Definition at line 74 of file SpotPhotonGenerator.h.

unsigned int SpotPhotonGeneratorOG::SpotPhotonGenerator::fCurrentPixId
private

Definition at line 76 of file SpotPhotonGenerator.h.

unsigned int SpotPhotonGeneratorOG::SpotPhotonGenerator::fCurrentTelId
private

Definition at line 75 of file SpotPhotonGenerator.h.

std::map<int, double> SpotPhotonGeneratorOG::SpotPhotonGenerator::fEfficiencies
private

Definition at line 78 of file SpotPhotonGenerator.h.

std::map<int, double> SpotPhotonGeneratorOG::SpotPhotonGenerator::fEfficienciesErr
private

Definition at line 79 of file SpotPhotonGenerator.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
unsigned int SpotPhotonGeneratorOG::SpotPhotonGenerator::fMaxBin
private

Definition at line 71 of file SpotPhotonGenerator.h.

unsigned int SpotPhotonGeneratorOG::SpotPhotonGenerator::fMinBin
private

Definition at line 70 of file SpotPhotonGenerator.h.

int SpotPhotonGeneratorOG::SpotPhotonGenerator::fNSpotPhotons
private

Definition at line 69 of file SpotPhotonGenerator.h.

utl::RandomEngine* SpotPhotonGeneratorOG::SpotPhotonGenerator::fRandomEngine
private

Definition at line 81 of file SpotPhotonGenerator.h.

double SpotPhotonGeneratorOG::SpotPhotonGenerator::fRDiaMin
private

Definition at line 72 of file SpotPhotonGenerator.h.

TelescopeSimulatorKG::TelescopeSimulator::PhotonList SpotPhotonGeneratorOG::SpotPhotonGenerator::fSpotPhotonList
private

Definition at line 77 of file SpotPhotonGenerator.h.


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

, generated on Tue Sep 26 2023.