Class for fast simulation option service. More...

#include <LArG4FastSimSvc.h>

Inheritance diagram for LArG4FastSimSvc:

Collaboration diagram for LArG4FastSimSvc:

Public Member Functions
StatusCode	queryInterface (const InterfaceID &riid, void **ppvIF)
	Query interface. More...

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

virtual bool	flagToShowerLib (const G4ParticleDefinition &particleType) const
	get switch for frozen showers More...

virtual double	maxEneToShowerLib (const G4ParticleDefinition &particleType) const
	get lower energy limit for frozen showers More...

virtual double	minEneToShowerLib (const G4ParticleDefinition &particleType) const
	get upper energy limit for frozen showers More...

virtual bool	ContainLow () const
	Apply check containment at low eta. More...

virtual bool	ContainHigh () const
	Apply check containment at high eta. More...

virtual bool	ContainCrack () const
	Apply check containment in crack region. More...

virtual bool	generateFSStartingPoints () const

virtual bool	generateFSStartingPoint (const HepMC::GenEvent *ge)

virtual float	generateFSStartingPointsRatio () const

virtual int	DetectorTag () const

	LArG4FastSimSvc (const std::string &name, ISvcLocator *sl)
	Standard Constructor. More...

virtual	~LArG4FastSimSvc ()
	Standard Destructor. More...

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID. More...

Private Member Functions
void	print () const
	dump object content More...

Private Attributes
bool	m_e_FlagShowerLib
	switch for electron frozen showers More...

double	m_e_MinEneShowerLib
	lower energy limit for electron frozen showers More...

double	m_e_MaxEneShowerLib
	upper energy limit for electron frozen showers More...

bool	m_g_FlagShowerLib
	switch for photon frozen showers More...

double	m_g_MaxEneShowerLib
	lower energy limit for photon frozen showers More...

double	m_g_MinEneShowerLib
	upper energy limit for photon frozen showers More...

bool	m_Neut_FlagShowerLib
	switch for neutron frozen showers More...

double	m_Neut_MinEneShowerLib
	lower energy limit for neutron frozen showers More...

double	m_Neut_MaxEneShowerLib
	upper energy limit for neutron frozen showers More...

bool	m_Pion_FlagShowerLib
	switch for pion frozen showers More...

double	m_Pion_MinEneShowerLib
	lower energy limit for pion frozen showers More...

double	m_Pion_MaxEneShowerLib
	upper energy limit for pion frozen showers More...

bool	m_containLow
	switch for containment check at low eta More...

bool	m_containHigh
	switch for containment check at high eta More...

bool	m_containCrack
	switch for containment check in crack region More...

StringProperty	m_generated_starting_points_file
	switch for shower starting point record More...

float	m_generated_starting_points_ratio
	switch for shower starting point record More...

bool	m_generate_starting_points

HepMC::IO_GenEvent *	m_starting_points_file

int	m_detector_tag
	name for the detector tag for the ShowerLibSvc More...

std::string	m_detector_tag_str

std::map< std::string, int >	m_detmap

Friends
class	SvcFactory< LArG4FastSimSvc >

Detailed Description

Class for fast simulation option service.

Author: Wolfgang Ehrenfeld, University of Hamburg, Germany; Zachary Marshal

Definition at line 42 of file LArG4FastSimSvc.h.

Constructor & Destructor Documentation

◆ LArG4FastSimSvc()

LArG4FastSimSvc::LArG4FastSimSvc	(	const std::string &	name,
		ISvcLocator *	sl
	)

Standard Constructor.

Definition at line 19 of file LArG4FastSimSvc.cxx.

   : AthService(name,sl),
     m_generated_starting_points_file(),
     m_generate_starting_points(false),
     m_starting_points_file(),
     m_detector_tag(0)
 {
   declareProperty("EFlagToShowerLib", m_e_FlagShowerLib = true, "Switch for e+/- frozen showers");
   declareProperty("EMinEneShowerLib", m_e_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for e+/- frozen showers");
   declareProperty("EMaxEneShowerLib", m_e_MaxEneShowerLib = 1.0*CLHEP::GeV, "Maximum energy for e+/- frozen showers");
  
   declareProperty("GFlagToShowerLib", m_g_FlagShowerLib = true, "Switch for photon frozen showers");
   declareProperty("GMinEneShowerLib", m_g_MinEneShowerLib = 0.*CLHEP::GeV, "Minimum energy for photon frozen showers");
   declareProperty("GMaxEneShowerLib", m_g_MaxEneShowerLib = 0.010*CLHEP::GeV, "Maximum energy for photon frozen showers");
  
   declareProperty("NeutFlagToShowerLib", m_Neut_FlagShowerLib = true, "Switch for neutron frozen showers");
   declareProperty("NeutMinEneShowerLib", m_Neut_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers");
   declareProperty("NeutMaxEneShowerLib", m_Neut_MaxEneShowerLib = 0.1*CLHEP::GeV, "Maximum energy for neutron frozen showers");
  
   declareProperty("PionFlagToShowerLib", m_Pion_FlagShowerLib = true, "Switch for neutron frozen showers");
   declareProperty("PionMinEneShowerLib", m_Pion_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers");
   declareProperty("PionMaxEneShowerLib", m_Pion_MaxEneShowerLib = 2.0*CLHEP::GeV, "Maximum energy for neutron frozen showers");
  
   declareProperty("ContainLow", m_containLow = true, "Switch for containment at low eta");
   declareProperty("ContainHigh", m_containHigh = true, "Switch for containment at high eta");
   declareProperty("ContainCrack", m_containCrack = true, "Switch for containment in the crack region");
  
   declareProperty("GeneratedStartingPointsFile", m_generated_starting_points_file = "", "Name of file for generated SPs. Do not touch until you want to produce a new library");
   declareProperty("GeneratedStartingPointsRatio", m_generated_starting_points_ratio = 0.02, "Ratio of SPs that goes to output");
  
   /* BE SURE THIS ONE IS THE SAME AS IN LArG4ShowerLibSvc!!! */
   enum DETECTOR {EMB=100000,EMEC=200000,FCAL1=300000,FCAL2=400000,FCAL3=500000,HECLOC=600000,HEC=700000};
  
   m_detmap["EMB"]=EMB;
   m_detmap["EMEC"]=EMEC;
   m_detmap["FCAL1"]=FCAL1;
   m_detmap["FCAL2"]=FCAL2;
   m_detmap["FCAL3"]=FCAL3;
   m_detmap["HECLOC"]=HECLOC;
   m_detmap["HEC"]=HEC;
  
 }

◆ ~LArG4FastSimSvc()

LArG4FastSimSvc::~LArG4FastSimSvc ( )

virtual

Standard Destructor.

Definition at line 64 of file LArG4FastSimSvc.cxx.

65 {

66 }

Member Function Documentation

◆ ContainCrack()

bool LArG4FastSimSvc::ContainCrack ( ) const

inlinevirtual

Apply check containment in crack region.

Implements ILArG4FastSimSvc.

Definition at line 160 of file LArG4FastSimSvc.h.

◆ ContainHigh()

bool LArG4FastSimSvc::ContainHigh ( ) const

inlinevirtual

Apply check containment at high eta.

Implements ILArG4FastSimSvc.

Definition at line 159 of file LArG4FastSimSvc.h.

◆ ContainLow()

bool LArG4FastSimSvc::ContainLow ( ) const

inlinevirtual

Apply check containment at low eta.

Implements ILArG4FastSimSvc.

Definition at line 158 of file LArG4FastSimSvc.h.

◆ DetectorTag()

int LArG4FastSimSvc::DetectorTag ( ) const

inlinevirtual

Implements ILArG4FastSimSvc.

Definition at line 164 of file LArG4FastSimSvc.h.

164 { return m_detector_tag; }

◆ finalize()

StatusCode LArG4FastSimSvc::finalize ( )

virtual

Definition at line 104 of file LArG4FastSimSvc.cxx.

 {
   msg(MSG::INFO) << "Finalizing fast simulation service. " << endmsg;
  
   if (m_generate_starting_points) {
       delete m_starting_points_file;
   }
   return StatusCode::SUCCESS;
 }

◆ flagToShowerLib()

bool LArG4FastSimSvc::flagToShowerLib ( const G4ParticleDefinition & particleType ) const

inlinevirtual

get switch for frozen showers

Implements ILArG4FastSimSvc.

Definition at line 114 of file LArG4FastSimSvc.h.

 {
   if ( &particleType == G4Electron::ElectronDefinition() ||
        &particleType == G4Positron::PositronDefinition() ) {
          return m_e_FlagShowerLib;
   } else if ( &particleType == G4Gamma::GammaDefinition() ) {
          return m_g_FlagShowerLib;
   } else if ( &particleType == G4Neutron::NeutronDefinition() ) {
          return m_Neut_FlagShowerLib;
   } else if ( &particleType == G4PionPlus::PionPlusDefinition() ||
               &particleType == G4PionMinus::PionMinusDefinition() ) {
          return m_Pion_FlagShowerLib;
   } else return false;
 }

◆ generateFSStartingPoint()

bool LArG4FastSimSvc::generateFSStartingPoint ( const HepMC::GenEvent * ge )

virtual

Implements ILArG4FastSimSvc.

Definition at line 165 of file LArG4FastSimSvc.cxx.

 {
     if (!m_generate_starting_points)
             return false;
     m_starting_points_file->write_event(ge);
     return true;
 }

◆ generateFSStartingPoints()

bool LArG4FastSimSvc::generateFSStartingPoints ( ) const

inlinevirtual

Implements ILArG4FastSimSvc.

Definition at line 162 of file LArG4FastSimSvc.h.

162 { return m_generate_starting_points; }

◆ generateFSStartingPointsRatio()

float LArG4FastSimSvc::generateFSStartingPointsRatio ( ) const

inlinevirtual

Implements ILArG4FastSimSvc.

Definition at line 163 of file LArG4FastSimSvc.h.

163 { return m_generated_starting_points_ratio; }

◆ initialize()

StatusCode LArG4FastSimSvc::initialize ( )

virtual

Definition at line 69 of file LArG4FastSimSvc.cxx.

 {
   msg(MSG::INFO) << "Initializing" << endmsg;
  
   if (name().find("EMB") != std::string::npos) {
       m_detector_tag_str = "EMB";
   } else if (name().find("EMEC") != std::string::npos) {
       m_detector_tag_str = "EMEC";
   } else if (name().find("FCAL2") != std::string::npos) {
       m_detector_tag_str = "FCAL2";
   } else if (name().find("FCAL") != std::string::npos) {
       m_detector_tag_str = "FCAL1";
   } else if (name().find("HEC") != std::string::npos) {
       m_detector_tag_str = "HEC";
   } else if (name().find("DeadMaterial") != std::string::npos) {
       m_detector_tag_str = "DM";
   } else {
       m_detector_tag_str = "UNKNOWN";
   }
   m_detector_tag = 0;
   if (m_detmap.find(m_detector_tag_str) != m_detmap.end()){
       m_detector_tag = m_detmap.find(m_detector_tag_str)->second;
   }
   m_generate_starting_points = (!m_generated_starting_points_file.value().empty());
  
   if (m_generate_starting_points) {
       m_starting_points_file = new HepMC::IO_GenEvent(m_generated_starting_points_file.value().c_str(),std::ios::out);
   }
   // list all properties
   this->print();
   
   return StatusCode::SUCCESS;
 }

◆ interfaceID()

static const InterfaceID& LArG4FastSimSvc::interfaceID ( )

inlinestatic

Retrieve interface ID.

Definition at line 47 of file LArG4FastSimSvc.h.

47 { return IID_ILArG4FastSimSvc; }

◆ maxEneToShowerLib()

double LArG4FastSimSvc::maxEneToShowerLib ( const G4ParticleDefinition & particleType ) const

inlinevirtual

get lower energy limit for frozen showers

Implements ILArG4FastSimSvc.

Definition at line 143 of file LArG4FastSimSvc.h.

 {
   if ( &particleType == G4Electron::ElectronDefinition() ||
        &particleType == G4Positron::PositronDefinition() ) {
          return m_e_MaxEneShowerLib;
   } else if ( &particleType == G4Gamma::GammaDefinition() ) {
          return m_g_MaxEneShowerLib;
   } else if ( &particleType == G4Neutron::NeutronDefinition() ) {
          return m_Neut_MaxEneShowerLib;
   } else if ( &particleType == G4PionPlus::PionPlusDefinition() ||
               &particleType == G4PionMinus::PionMinusDefinition() ) {
          return m_Pion_MaxEneShowerLib;
   } else return 0.0;
 }

◆ minEneToShowerLib()

double LArG4FastSimSvc::minEneToShowerLib ( const G4ParticleDefinition & particleType ) const

inlinevirtual

get upper energy limit for frozen showers

Implements ILArG4FastSimSvc.

Definition at line 128 of file LArG4FastSimSvc.h.

 {
   if ( &particleType == G4Electron::ElectronDefinition() ||
        &particleType == G4Positron::PositronDefinition() ) {
          return m_e_MinEneShowerLib;
   } else if ( &particleType == G4Gamma::GammaDefinition() ) {
          return m_g_MinEneShowerLib;
   } else if ( &particleType == G4Neutron::NeutronDefinition() ) {
          return m_Neut_MinEneShowerLib;
   } else if ( &particleType == G4PionPlus::PionPlusDefinition() ||
               &particleType == G4PionMinus::PionMinusDefinition() ) {
          return m_Pion_MinEneShowerLib;
   } else return 0.0;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Service >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Service >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Service >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ print()

void LArG4FastSimSvc::print ( ) const

private

dump object content

Definition at line 130 of file LArG4FastSimSvc.cxx.

 {
   msg(MSG::INFO) << "List of Frozen Shower options:" << endmsg;
   msg(MSG::INFO) << "Detector tag is " << m_detector_tag_str << endmsg;
   if (m_generate_starting_points) {\
       msg(MSG::INFO) << "Starting points will be saved to " << m_generated_starting_points_file.value() << endmsg;
   }
  
   if (this->m_e_FlagShowerLib) {
     msg(MSG::INFO) << "Electrons energy range [MeV] for Frozen Showers ["
       << this->m_e_MinEneShowerLib << " -- " << this->m_e_MaxEneShowerLib << "]" << endmsg;
   } else {
       msg(MSG::INFO) << "Electrons wont be parameterized" << endmsg;
   }
  
   if (this->m_g_FlagShowerLib) {
     msg(MSG::INFO) << "Photons   energy range [MeV] for Frozen Showers ["
       << this->m_g_MinEneShowerLib << " -- " << this->m_g_MaxEneShowerLib << "]" << endmsg;
   } else {
       msg(MSG::INFO) << "Photons   wont be parameterized" << endmsg;
   }
  
   if (this->m_Neut_FlagShowerLib) {
     msg(MSG::INFO) << "Neutrons  energy range [MeV] for Frozen Showers ["
       << this->m_Neut_MinEneShowerLib << " -- " << this->m_Neut_MaxEneShowerLib << "]" << endmsg;
   } else {
       msg(MSG::INFO) << "Neutrons  wont be parameterized" << endmsg;
   }
  
   // the containment checks
   msg(MSG::INFO) << "Containment check at low eta:   " << (this->m_containLow   ? "YES" : "NO") << endmsg;
   msg(MSG::INFO) << "Containment check at crack eta: " << (this->m_containCrack ? "YES" : "NO") << endmsg;
   msg(MSG::INFO) << "Containment check at high eta:  " << (this->m_containHigh  ? "YES" : "NO") << endmsg;
 }

◆ queryInterface()

StatusCode LArG4FastSimSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvIF
	)

Query interface.

Definition at line 116 of file LArG4FastSimSvc.cxx.

 {
   if ( IID_ILArG4FastSimSvc == riid )    {
     *ppvInterface = (ILArG4FastSimSvc*)this;
   }
   else  {
     // Interface is not directly available: try out a base class
     return AthService::queryInterface(riid, ppvInterface);
   }
   addRef();
   return StatusCode::SUCCESS;
 }

Friends And Related Function Documentation

◆ SvcFactory< LArG4FastSimSvc >

friend class SvcFactory< LArG4FastSimSvc >

friend

Definition at line 67 of file LArG4FastSimSvc.h.

Member Data Documentation

◆ m_containCrack

bool LArG4FastSimSvc::m_containCrack

private

switch for containment check in crack region

Definition at line 100 of file LArG4FastSimSvc.h.

◆ m_containHigh

bool LArG4FastSimSvc::m_containHigh

private

switch for containment check at high eta

Definition at line 99 of file LArG4FastSimSvc.h.

◆ m_containLow

bool LArG4FastSimSvc::m_containLow

private

switch for containment check at low eta

Definition at line 98 of file LArG4FastSimSvc.h.

◆ m_detector_tag

int LArG4FastSimSvc::m_detector_tag

private

name for the detector tag for the ShowerLibSvc

Definition at line 106 of file LArG4FastSimSvc.h.

◆ m_detector_tag_str

std::string LArG4FastSimSvc::m_detector_tag_str

private

Definition at line 107 of file LArG4FastSimSvc.h.

◆ m_detmap

std::map<std::string,int> LArG4FastSimSvc::m_detmap

private

Definition at line 108 of file LArG4FastSimSvc.h.

◆ m_e_FlagShowerLib

bool LArG4FastSimSvc::m_e_FlagShowerLib

private

switch for electron frozen showers

Definition at line 82 of file LArG4FastSimSvc.h.

◆ m_e_MaxEneShowerLib

double LArG4FastSimSvc::m_e_MaxEneShowerLib

private

upper energy limit for electron frozen showers

Definition at line 84 of file LArG4FastSimSvc.h.

◆ m_e_MinEneShowerLib

double LArG4FastSimSvc::m_e_MinEneShowerLib

private

lower energy limit for electron frozen showers

Definition at line 83 of file LArG4FastSimSvc.h.

◆ m_g_FlagShowerLib

bool LArG4FastSimSvc::m_g_FlagShowerLib

private

switch for photon frozen showers

Definition at line 86 of file LArG4FastSimSvc.h.

◆ m_g_MaxEneShowerLib

double LArG4FastSimSvc::m_g_MaxEneShowerLib

private

lower energy limit for photon frozen showers

Definition at line 87 of file LArG4FastSimSvc.h.

◆ m_g_MinEneShowerLib

double LArG4FastSimSvc::m_g_MinEneShowerLib

private

upper energy limit for photon frozen showers

Definition at line 88 of file LArG4FastSimSvc.h.

◆ m_generate_starting_points

bool LArG4FastSimSvc::m_generate_starting_points

private

Definition at line 104 of file LArG4FastSimSvc.h.

◆ m_generated_starting_points_file

StringProperty LArG4FastSimSvc::m_generated_starting_points_file

private

switch for shower starting point record

Definition at line 102 of file LArG4FastSimSvc.h.

◆ m_generated_starting_points_ratio

float LArG4FastSimSvc::m_generated_starting_points_ratio

private

switch for shower starting point record

Definition at line 103 of file LArG4FastSimSvc.h.

◆ m_Neut_FlagShowerLib

bool LArG4FastSimSvc::m_Neut_FlagShowerLib

private

switch for neutron frozen showers

Definition at line 90 of file LArG4FastSimSvc.h.

◆ m_Neut_MaxEneShowerLib

double LArG4FastSimSvc::m_Neut_MaxEneShowerLib

private

upper energy limit for neutron frozen showers

Definition at line 92 of file LArG4FastSimSvc.h.

◆ m_Neut_MinEneShowerLib

double LArG4FastSimSvc::m_Neut_MinEneShowerLib

private

lower energy limit for neutron frozen showers

Definition at line 91 of file LArG4FastSimSvc.h.

◆ m_Pion_FlagShowerLib

bool LArG4FastSimSvc::m_Pion_FlagShowerLib

private

switch for pion frozen showers

Definition at line 94 of file LArG4FastSimSvc.h.

◆ m_Pion_MaxEneShowerLib

double LArG4FastSimSvc::m_Pion_MaxEneShowerLib

private

upper energy limit for pion frozen showers

Definition at line 96 of file LArG4FastSimSvc.h.

◆ m_Pion_MinEneShowerLib

double LArG4FastSimSvc::m_Pion_MinEneShowerLib

private

lower energy limit for pion frozen showers

Definition at line 95 of file LArG4FastSimSvc.h.

◆ m_starting_points_file

HepMC::IO_GenEvent* LArG4FastSimSvc::m_starting_points_file

private

Definition at line 105 of file LArG4FastSimSvc.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LArG4FastSimSvc()

◆ ~LArG4FastSimSvc()

Member Function Documentation

◆ ContainCrack()

◆ ContainHigh()

◆ ContainLow()

◆ DetectorTag()

◆ finalize()

◆ flagToShowerLib()

◆ generateFSStartingPoint()

◆ generateFSStartingPoints()

◆ generateFSStartingPointsRatio()

◆ initialize()

◆ interfaceID()

◆ maxEneToShowerLib()

◆ minEneToShowerLib()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ print()

◆ queryInterface()

Friends And Related Function Documentation

◆ SvcFactory< LArG4FastSimSvc >

Member Data Documentation

◆ m_containCrack

◆ m_containHigh

◆ m_containLow

◆ m_detector_tag

◆ m_detector_tag_str

◆ m_detmap

◆ m_e_FlagShowerLib

◆ m_e_MaxEneShowerLib

◆ m_e_MinEneShowerLib

◆ m_g_FlagShowerLib

◆ m_g_MaxEneShowerLib

◆ m_g_MinEneShowerLib

◆ m_generate_starting_points

◆ m_generated_starting_points_file

◆ m_generated_starting_points_ratio

◆ m_Neut_FlagShowerLib

◆ m_Neut_MaxEneShowerLib

◆ m_Neut_MinEneShowerLib

◆ m_Pion_FlagShowerLib

◆ m_Pion_MaxEneShowerLib

◆ m_Pion_MinEneShowerLib

◆ m_starting_points_file