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

#include <CachedShowerRegenerator.h>

Inheritance diagram for CachedShowerRegeneratorASCII::CachedShowerRegenerator:
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

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

void InitNewShower (evt::Event &event)
 
bool IsParticleEnergyLow (const int, const double) const
 
void OutputStats (evt::Event &event)
 
boost::tuple< unsigned int,
double > 
ParticleNumberAndWeight (const double &, const int &)
 (Optional) special handling for particles with very large weights. More...
 
 REGISTER_MODULE ("CachedShowerRegeneratorASCII", CachedShowerRegenerator)
 

Private Attributes

double fAccumulatedWeightLimit
 
double fCylinderHeight
 
double fDeltaPhi
 
double fDeltaROverR
 
double fElectronEnergyCut
 
utl::TabulatedFunctionfEToVem
 
double fHadronEnergyCut
 
double fHorizontalParticleCut
 
double fInjectionStop
 
double fInnerRadiusCut
 
double fLogGaussSmearingWidth
 
unsigned int fMaxParticles
 
double fMesonEnergyCut
 
double fMuonEnergyCut
 
double fMuonWeightScale
 
utl::TabulatedFunctionfMuToVem
 
unsigned int fNOutOfRangeWeight
 
double fOuterRadiusCut
 
double fPhiGranularity
 
double fPhotonEnergyCut
 
utl::RandomEngine::RandomEngineTypefRandomEngine
 
double fRGranularity
 
utl::ShadowPtr< ShowerDatafShowerData
 
double fTimeSlotSize
 
bool fUseInjectionStop
 
bool fUseStationPositionMatrix
 
bool fUseWeightLimiting
 
double fWeightLimit
 
double fWeightThreshold
 
int largeWeightCtr
 
int unityWeightCtr
 

Detailed Description

Definition at line 67 of file Deprecated/UpgradeASCIITests/CachedShowerRegeneratorASCII/CachedShowerRegenerator.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.

Constructor & Destructor Documentation

CachedShowerRegenerator::CachedShowerRegenerator ( )

Member Function Documentation

VModule::ResultFlag CachedShowerRegenerator::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 762 of file Deprecated/UpgradeASCIITests/CachedShowerRegeneratorASCII/CachedShowerRegenerator.cc.

References fwk::VModule::eSuccess, fNOutOfRangeWeight, fWeightLimit, and WARNING.

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 CachedShowerRegenerator::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 154 of file Deprecated/UpgradeASCIITests/CachedShowerRegeneratorASCII/CachedShowerRegenerator.cc.

References fwk::VModule::eSuccess, fAccumulatedWeightLimit, fCylinderHeight, fDeltaPhi, fDeltaROverR, fElectronEnergyCut, fHadronEnergyCut, fHorizontalParticleCut, fInnerRadiusCut, fLogGaussSmearingWidth, fMaxParticles, fMesonEnergyCut, fMuonEnergyCut, fMuonWeightScale, fOuterRadiusCut, fPhiGranularity, fPhotonEnergyCut, fRandomEngine, fRGranularity, fUseStationPositionMatrix, fUseWeightLimiting, fWeightThreshold, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), largeWeightCtr, unityWeightCtr, and WARNING.

void CachedShowerRegenerator::InitNewShower ( evt::Event event)
private
void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

bool CachedShowerRegenerator::IsParticleEnergyLow ( const int  pType,
const double  pEnergy 
) const
private
void CachedShowerRegenerator::OutputStats ( evt::Event event)
private
boost::tuple< unsigned int, double > CachedShowerRegenerator::ParticleNumberAndWeight ( const double &  avgN,
const int &  sId 
)
private

(Optional) special handling for particles with very large weights.

EXPLAIN HOW THIS WORKS need for arguments..

Definition at line 784 of file Deprecated/UpgradeASCIITests/CachedShowerRegeneratorASCII/CachedShowerRegenerator.cc.

References fAccumulatedWeightLimit, fRandomEngine, fShowerData, and fWeightThreshold.

Referenced by Run().

CachedShowerRegeneratorASCII::CachedShowerRegenerator::REGISTER_MODULE ( "CachedShowerRegeneratorASCII"  ,
CachedShowerRegenerator   
)
private
VModule::ResultFlag CachedShowerRegenerator::Run ( evt::Event event)
virtual

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 352 of file Deprecated/UpgradeASCIITests/CachedShowerRegeneratorASCII/CachedShowerRegenerator.cc.

References utl::abs(), sevt::StationSimData::AddParticle(), utl::Particle::eAntiMuon, fwk::VModule::eBreakLoop, fwk::VModule::eFailure, utl::Particle::eMuon, ERROR, utl::Particle::eShowerFromMuonDecay, fwk::VModule::eSuccess, fCylinderHeight, fHorizontalParticleCut, fMaxParticles, fMuonWeightScale, fRandomEngine, fShowerData, fUseWeightLimiting, CachedShowerRegeneratorASCII::StationInfo::GetDetStation(), utl::Particle::GetDirection(), CachedShowerRegeneratorASCII::StationInfo::GetEvtStation(), sdet::Station::GetId(), utl::TimeInterval::GetInterval(), utl::Particle::GetKineticEnergy(), evt::ShowerSimData::GetLocalCoordinateSystem(), sdet::Station::GetLocalCoordinateSystem(), utl::BasicVector< HepVector >::GetPhi(), utl::Particle::GetPosition(), evt::ShowerSimData::GetPosition(), sdet::Station::GetRadius(), CachedShowerRegeneratorASCII::StationInfo::GetResamplingArea(), utl::BasicVector< HepVector >::GetRho(), utl::BasicVector< HepVector >::GetRho2(), evt::ShowerSimData::GetShowerCoordinateSystem(), sevt::Station::GetSimData(), utl::Particle::GetSource(), sevt::SEvent::GetStation(), sdet::Station::GetThickness(), utl::Particle::GetTime(), utl::Particle::GetType(), utl::Particle::GetWeight(), utl::BasicVector< HepVector >::GetZ(), evt::Event::HasSimShower(), INFO, InitNewShower(), CachedShowerRegeneratorASCII::InsertValue(), CachedShowerRegeneratorASCII::StationInfo::IsIn(), IsParticleEnergyLow(), utl::BasicVector< HepVector >::kCylindrical, utl::kPi, utl::kPiOnTwo, utl::kTwoPi, largeWeightCtr, ns, OutputStats(), ParticleNumberAndWeight(), CachedShowerRegeneratorASCII::PlaneFrontTime(), utl::Particle::SetPosition(), utl::Particle::SetTime(), utl::Particle::SetWeight(), utl::Sqr(), sqrt(), sdet::SDetector::StationsBegin(), sdet::SDetector::StationsEnd(), and unityWeightCtr.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fAccumulatedWeightLimit
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fCylinderHeight
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fDeltaPhi
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fDeltaROverR
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fElectronEnergyCut
private
utl::TabulatedFunction* CachedShowerRegeneratorASCII::CachedShowerRegenerator::fEToVem
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fHadronEnergyCut
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fHorizontalParticleCut
private
int fwk::VModule::fInfoLevel = 0
protectedinherited
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fInjectionStop
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fInnerRadiusCut
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fLogGaussSmearingWidth
private
unsigned int CachedShowerRegeneratorASCII::CachedShowerRegenerator::fMaxParticles
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fMesonEnergyCut
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fMuonEnergyCut
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fMuonWeightScale
private
utl::TabulatedFunction* CachedShowerRegeneratorASCII::CachedShowerRegenerator::fMuToVem
private
unsigned int CachedShowerRegeneratorASCII::CachedShowerRegenerator::fNOutOfRangeWeight
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fOuterRadiusCut
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fPhiGranularity
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fPhotonEnergyCut
private
utl::RandomEngine::RandomEngineType* CachedShowerRegeneratorASCII::CachedShowerRegenerator::fRandomEngine
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fRGranularity
private
utl::ShadowPtr<ShowerData> CachedShowerRegeneratorASCII::CachedShowerRegenerator::fShowerData
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fTimeSlotSize
private
bool CachedShowerRegeneratorASCII::CachedShowerRegenerator::fUseInjectionStop
private
bool CachedShowerRegeneratorASCII::CachedShowerRegenerator::fUseStationPositionMatrix
private
bool CachedShowerRegeneratorASCII::CachedShowerRegenerator::fUseWeightLimiting
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fWeightLimit
private
double CachedShowerRegeneratorASCII::CachedShowerRegenerator::fWeightThreshold
private
int CachedShowerRegeneratorASCII::CachedShowerRegenerator::largeWeightCtr
private
int CachedShowerRegeneratorASCII::CachedShowerRegenerator::unityWeightCtr
private

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

, generated on Tue Sep 26 2023.