NEEDS DOCUMENTATION. More...

#include <LArFastShowerTool.h>

Inheritance diagram for LArFastShowerTool:

Collaboration diagram for LArFastShowerTool:

Public Member Functions
	LArFastShowerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor. More...

virtual	~LArFastShowerTool ()=default

StatusCode	initialize () override final

StatusCode	initializeFastSim () override
	Construct and setup the fast simulation model. More...

virtual StatusCode	BeginOfAthenaEvent () override
	Begin of an athena event - do anything that needs to be done at the beginning of each athena event. More...

virtual StatusCode	EndOfAthenaEvent () override
	End of an athena event - do any tidying up required at the end of each athena event. More...

Protected Member Functions
virtual G4VFastSimulationModel *	makeFastSimModel () override final
	Method to make the actual fast simulation model itself, which will be owned by the tool. More...

G4VFastSimulationModel *	getFastSimModel ()
	Retrieve the current Fast Simulation Model. More...

G4Region *	getRegion () const

Protected Attributes
Gaudi::Property< std::string >	m_regionName {this, "RegionName", ""}
	The region to which this fast sim is assigned. More...

Gaudi::Property< bool >	m_noRegions {this, "NoRegions", false}
	This Fast Simulation has no regions associated with it. More...

Private Member Functions
void	setFastSimModel (G4VFastSimulationModel *)
	Set the current model. In hive, this gets assigned as the thread-local model. More...

void	deleteFastSimModel ()
	Delete the current model. More...

Private Attributes
Gaudi::Property< std::string >	m_fastSimDedicatedSD
	Shower library sensitive detector for this shower. More...

ServiceHandle< ILArG4ShowerLibSvc >	m_showerLibSvc
	Pointer to the shower library service. More...

Gaudi::Property< bool >	m_e_FlagShowerLib {this, "EFlagToShowerLib", true, "Switch for e+/- frozen showers"}

Gaudi::Property< double >	m_e_MinEneShowerLib {this, "EMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for e+/- frozen showers"}

Gaudi::Property< double >	m_e_MaxEneShowerLib {this, "EMaxEneShowerLib", 1.0*CLHEP::GeV, "Maximum energy for e+/- frozen showers"}

Gaudi::Property< bool >	m_g_FlagShowerLib {this, "GFlagToShowerLib", true, "Switch for photon frozen showers"}

Gaudi::Property< double >	m_g_MinEneShowerLib {this, "GMinEneShowerLib", 0.*CLHEP::GeV, "Minimum energy for photon frozen showers"}

Gaudi::Property< double >	m_g_MaxEneShowerLib {this, "GMaxEneShowerLib", 0.010*CLHEP::GeV, "Maximum energy for photon frozen showers"}

Gaudi::Property< bool >	m_Neut_FlagShowerLib {this, "NeutFlagToShowerLib", true, "Switch for neutron frozen showers"}

Gaudi::Property< double >	m_Neut_MinEneShowerLib {this, "NeutMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers"}

Gaudi::Property< double >	m_Neut_MaxEneShowerLib {this, "NeutMaxEneShowerLib", 0.1*CLHEP::GeV, "Maximum energy for neutron frozen showers"}

Gaudi::Property< bool >	m_Pion_FlagShowerLib {this, "PionFlagToShowerLib", true, "Switch for neutron frozen showers"}

Gaudi::Property< double >	m_Pion_MinEneShowerLib {this, "PionMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers"}

Gaudi::Property< double >	m_Pion_MaxEneShowerLib {this, "PionMaxEneShowerLib", 2.0*CLHEP::GeV, "Maximum energy for neutron frozen showers"}

Gaudi::Property< bool >	m_containLow {this, "ContainLow", true, "Switch for containment at low eta"}

Gaudi::Property< double >	m_absLowEta {this, "AbsLowEta", 3.8, ""}

Gaudi::Property< bool >	m_containHigh {this, "ContainHigh", true, "Switch for containment at high eta"}

Gaudi::Property< double >	m_absHighEta {this, "AbsHighEta", 4.4, ""}

Gaudi::Property< bool >	m_containCrack {this, "ContainCrack", true, "Switch for containment in the crack region"}

Gaudi::Property< double >	m_absCrackEta1 {this, "AbsCrackEta1", 0.5, ""}

Gaudi::Property< double >	m_absCrackEta2 {this, "AbsCrackEta2", 1.1, ""}

Gaudi::Property< std::string >	m_generated_starting_points_file

Gaudi::Property< float >	m_generated_starting_points_ratio

Gaudi::Property< int >	m_detector_tag {this, "DetectorTag", 0, "Which detector is this?"}

Gaudi::Property< bool >	m_applyRRWeights

FastShowerConfigStruct	m_configuration

G4VFastSimulationModel *	m_FastSimModel {}
	The Fast Simulation Model to which this thing corresponds. More...

Detailed Description

NEEDS DOCUMENTATION.

Definition at line 20 of file LArFastShowerTool.h.

Constructor & Destructor Documentation

◆ LArFastShowerTool()

LArFastShowerTool::LArFastShowerTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Default constructor.

Definition at line 12 of file LArFastShowerTool.cxx.

   : FastSimulationBase(type, name, parent)
 {
 }

◆ ~LArFastShowerTool()

virtual LArFastShowerTool::~LArFastShowerTool ( )

virtualdefault

Member Function Documentation

◆ BeginOfAthenaEvent()

virtual StatusCode FastSimulationBase::BeginOfAthenaEvent ( )

inlineoverridevirtualinherited

Begin of an athena event - do anything that needs to be done at the beginning of each athena event.

Reimplemented in FastCaloSimTool.

Definition at line 42 of file FastSimulationBase.h.

42 { return StatusCode::SUCCESS; }

◆ deleteFastSimModel()

void FastSimulationBase::deleteFastSimModel ( )

privateinherited

Delete the current model.

Definition at line 78 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   for(auto& threadMapPair : m_fastsimmodelThreadMap)
     {
       auto fastSimModel = threadMapPair.second;
       if (fastSimModel)
     delete fastSimModel;      
     }
   m_fastsimmodelThreadMap.clear();
 #else
   if(m_FastSimModel)
     {
       delete m_FastSimModel;
       m_FastSimModel = 0;
     }
 #endif
 }

◆ EndOfAthenaEvent()

virtual StatusCode FastSimulationBase::EndOfAthenaEvent ( )

inlineoverridevirtualinherited

End of an athena event - do any tidying up required at the end of each athena event.

Reimplemented in FastCaloSimTool.

Definition at line 45 of file FastSimulationBase.h.

45 { return StatusCode::SUCCESS; }

◆ getFastSimModel()

G4VFastSimulationModel * FastSimulationBase::getFastSimModel ( )

protectedinherited

Retrieve the current Fast Simulation Model.

In MT, this means the thread-local Fast Simulation Model. Otherwise, it is simply the single Fast Simulation Model.

Definition at line 52 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   // Get current thread-ID
   const auto tid = std::this_thread::get_id();
   // Retrieve it from the FastSimModel map
   auto fastsimmodelPair = m_fastsimmodelThreadMap.find(tid);
   if(fastsimmodelPair == m_fastsimmodelThreadMap.end()) return nullptr;
   return fastsimmodelPair->second;
 #else
   return m_FastSimModel;
 #endif
 }

◆ getRegion()

G4Region * FastSimulationBase::getRegion ( ) const

protectedinherited

Definition at line 22 of file FastSimulationBase.cxx.

 {
   if (m_regionName.value().empty()) {
     return nullptr;
   }
   return G4RegionStore::GetInstance()->GetRegion(m_regionName.value());
 }

◆ initialize()

StatusCode LArFastShowerTool::initialize ( )

finaloverride

Definition at line 19 of file LArFastShowerTool.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::initialize()" );
   CHECK( m_showerLibSvc.retrieve() );
  
   m_configuration.m_showerLibSvcName = m_showerLibSvc.name();
   
   m_configuration.m_e_FlagShowerLib = m_e_FlagShowerLib;
   m_configuration.m_e_MinEneShowerLib = m_e_MinEneShowerLib;
   m_configuration.m_e_MaxEneShowerLib = m_e_MaxEneShowerLib;
  
   m_configuration.m_g_FlagShowerLib = m_g_FlagShowerLib;
   m_configuration.m_g_MinEneShowerLib = m_g_MinEneShowerLib;
   m_configuration.m_g_MaxEneShowerLib = m_g_MaxEneShowerLib;
  
   m_configuration.m_Neut_FlagShowerLib = m_Neut_FlagShowerLib;
   m_configuration.m_Neut_MinEneShowerLib = m_Neut_MinEneShowerLib;
   m_configuration.m_Neut_MaxEneShowerLib = m_Neut_MaxEneShowerLib;
  
   m_configuration.m_Pion_FlagShowerLib = m_Pion_FlagShowerLib;
   m_configuration.m_Pion_MinEneShowerLib = m_Pion_MinEneShowerLib;
   m_configuration.m_Pion_MaxEneShowerLib = m_Pion_MaxEneShowerLib;
  
   m_configuration.m_containLow = m_containLow;
   m_configuration.m_absLowEta = m_absLowEta;
   m_configuration.m_containHigh = m_containHigh;
   m_configuration.m_absHighEta = m_absHighEta;
   m_configuration.m_containCrack = m_containCrack;
   m_configuration.m_absCrackEta1 = m_absCrackEta1;
   m_configuration.m_absCrackEta2 = m_absCrackEta2;
  
   m_configuration.m_generated_starting_points_file = m_generated_starting_points_file;
   m_configuration.m_generated_starting_points_ratio = m_generated_starting_points_ratio;
   m_configuration.m_detector_tag = m_detector_tag;
   m_configuration.m_applyRRWeights = m_applyRRWeights;
  
   return FastSimulationBase::initialize();
 }

◆ initializeFastSim()

StatusCode FastSimulationBase::initializeFastSim ( )

overrideinherited

Construct and setup the fast simulation model.

This method invokes the makeFastSimModel of the derived concrete tool type and assigns the configured regions. Errors are reported if regions are missing. In multi-threading jobs, this method is called once per worker thread.

Definition at line 32 of file FastSimulationBase.cxx.

                                                 {
   ATH_MSG_VERBOSE( name() << "::initializeFastSim()" );
  
   // Make sure Fast Simulation Model isn't already registered
   if(getFastSimModel()){
     ATH_MSG_ERROR("Trying to create a Fast Simulation Model which already exists!");
     return StatusCode::FAILURE;
   }
  
   // Make the FastSimModel stored by this tool
   auto* fastsimmodel = makeFastSimModel();
   setFastSimModel(fastsimmodel);
  
   // Set the verbosity information on this thing - this will have to go into the makeFastSimModel methods...
   //if(msgLvl(MSG::VERBOSE)) m_FastSimModel->SetVerboseLevel(10);
   //else if(msgLvl(MSG::DEBUG)) m_FastSimModel->SetVerboseLevel(5);
  
   return StatusCode::SUCCESS;
 }

◆ makeFastSimModel()

G4VFastSimulationModel * LArFastShowerTool::makeFastSimModel ( )

finaloverrideprotectedvirtual

Method to make the actual fast simulation model itself, which will be owned by the tool.

Must be implemented in all concrete base classes.

Definition at line 58 of file LArFastShowerTool.cxx.

 {
   ATH_MSG_DEBUG( "Initializing Fast Sim Model" );
   IFastSimDedicatedSD* fastSD = dynamic_cast<IFastSimDedicatedSD*>(G4SDManager::GetSDMpointer()->FindSensitiveDetector(m_fastSimDedicatedSD.value(), false));
   if (fastSD) {
     ATH_MSG_DEBUG( "SD " << m_fastSimDedicatedSD << " already created." );
   } else if ("BarrelFastSimDedicatedSD" == m_fastSimDedicatedSD){
     fastSD = new BarrelFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
   } else if ("EndcapFastSimDedicatedSD" == m_fastSimDedicatedSD){
     fastSD = new EndcapFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
   } else if ("FCALFastSimDedicatedSD" == m_fastSimDedicatedSD){
     fastSD = new FCALFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
   } else {
     ATH_MSG_FATAL( "Fast sim SD type " << m_fastSimDedicatedSD << " not found!" );
     throw std::runtime_error("Bad SD name");
   }
   G4SDManager::GetSDMpointer()->AddNewDetector(fastSD);
  
   // Create a fresh Fast Sim Model
   return new LArFastShower(name(), getRegion(), m_configuration, fastSD);
 }

◆ setFastSimModel()

void FastSimulationBase::setFastSimModel ( G4VFastSimulationModel * fastsimmodel )

privateinherited

Set the current model. In hive, this gets assigned as the thread-local model.

Definition at line 66 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   // Make sure one isn't already assigned
   const auto tid = std::this_thread::get_id();
   ATH_MSG_DEBUG("Creating and registering FastSimModel " << fastsimmodel << " in thread " << tid);
   m_fastsimmodelThreadMap.insert( std::make_pair(tid, fastsimmodel) );
 #else
   m_FastSimModel = fastsimmodel;
 #endif
 }

Member Data Documentation

◆ m_absCrackEta1

Gaudi::Property<double> LArFastShowerTool::m_absCrackEta1 {this, "AbsCrackEta1", 0.5, ""}

private

Definition at line 63 of file LArFastShowerTool.h.

◆ m_absCrackEta2

Gaudi::Property<double> LArFastShowerTool::m_absCrackEta2 {this, "AbsCrackEta2", 1.1, ""}

private

Definition at line 64 of file LArFastShowerTool.h.

◆ m_absHighEta

Gaudi::Property<double> LArFastShowerTool::m_absHighEta {this, "AbsHighEta", 4.4, ""}

private

Definition at line 61 of file LArFastShowerTool.h.

◆ m_absLowEta

Gaudi::Property<double> LArFastShowerTool::m_absLowEta {this, "AbsLowEta", 3.8, ""}

private

Definition at line 59 of file LArFastShowerTool.h.

◆ m_applyRRWeights

Gaudi::Property<bool> LArFastShowerTool::m_applyRRWeights

private

Initial value:

{this, "ApplyRRWeights", false

, "Should the weights set by NRR/PRR be applied to Frozen Shower Energy deposits?"}

Definition at line 72 of file LArFastShowerTool.h.

◆ m_configuration

FastShowerConfigStruct LArFastShowerTool::m_configuration

private

Definition at line 75 of file LArFastShowerTool.h.

◆ m_containCrack

Gaudi::Property<bool> LArFastShowerTool::m_containCrack {this, "ContainCrack", true, "Switch for containment in the crack region"}

private

Definition at line 62 of file LArFastShowerTool.h.

◆ m_containHigh

Gaudi::Property<bool> LArFastShowerTool::m_containHigh {this, "ContainHigh", true, "Switch for containment at high eta"}

private

Definition at line 60 of file LArFastShowerTool.h.

◆ m_containLow

Gaudi::Property<bool> LArFastShowerTool::m_containLow {this, "ContainLow", true, "Switch for containment at low eta"}

private

Definition at line 58 of file LArFastShowerTool.h.

◆ m_detector_tag

Gaudi::Property<int> LArFastShowerTool::m_detector_tag {this, "DetectorTag", 0, "Which detector is this?"}

private

Definition at line 70 of file LArFastShowerTool.h.

◆ m_e_FlagShowerLib

Gaudi::Property<bool> LArFastShowerTool::m_e_FlagShowerLib {this, "EFlagToShowerLib", true, "Switch for e+/- frozen showers"}

private

Definition at line 42 of file LArFastShowerTool.h.

◆ m_e_MaxEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_e_MaxEneShowerLib {this, "EMaxEneShowerLib", 1.0*CLHEP::GeV, "Maximum energy for e+/- frozen showers"}

private

Definition at line 44 of file LArFastShowerTool.h.

◆ m_e_MinEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_e_MinEneShowerLib {this, "EMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for e+/- frozen showers"}

private

Definition at line 43 of file LArFastShowerTool.h.

◆ m_fastSimDedicatedSD

Gaudi::Property<std::string> LArFastShowerTool::m_fastSimDedicatedSD

private

Initial value:

{this, "SensitiveDetector", ""

, "Fast sim dedicated SD for this setup"}

Shower library sensitive detector for this shower.

Definition at line 37 of file LArFastShowerTool.h.

◆ m_FastSimModel

G4VFastSimulationModel* FastSimulationBase::m_FastSimModel {}

privateinherited

The Fast Simulation Model to which this thing corresponds.

Definition at line 78 of file FastSimulationBase.h.

◆ m_g_FlagShowerLib

Gaudi::Property<bool> LArFastShowerTool::m_g_FlagShowerLib {this, "GFlagToShowerLib", true, "Switch for photon frozen showers"}

private

Definition at line 46 of file LArFastShowerTool.h.

◆ m_g_MaxEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_g_MaxEneShowerLib {this, "GMaxEneShowerLib", 0.010*CLHEP::GeV, "Maximum energy for photon frozen showers"}

private

Definition at line 48 of file LArFastShowerTool.h.

◆ m_g_MinEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_g_MinEneShowerLib {this, "GMinEneShowerLib", 0.*CLHEP::GeV, "Minimum energy for photon frozen showers"}

private

Definition at line 47 of file LArFastShowerTool.h.

◆ m_generated_starting_points_file

Gaudi::Property<std::string> LArFastShowerTool::m_generated_starting_points_file

private

Initial value:

{this, "GeneratedStartingPointsFile", "",

"Name of file for generated SPs. Do not touch until you want to produce a new library"}

Definition at line 66 of file LArFastShowerTool.h.

◆ m_generated_starting_points_ratio

Gaudi::Property<float> LArFastShowerTool::m_generated_starting_points_ratio

private

Initial value:

{this, "GeneratedStartingPointsRatio", 0.02f

, "Ratio of SPs that goes to output"}

Definition at line 68 of file LArFastShowerTool.h.

◆ m_Neut_FlagShowerLib

Gaudi::Property<bool> LArFastShowerTool::m_Neut_FlagShowerLib {this, "NeutFlagToShowerLib", true, "Switch for neutron frozen showers"}

private

Definition at line 50 of file LArFastShowerTool.h.

◆ m_Neut_MaxEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_Neut_MaxEneShowerLib {this, "NeutMaxEneShowerLib", 0.1*CLHEP::GeV, "Maximum energy for neutron frozen showers"}

private

Definition at line 52 of file LArFastShowerTool.h.

◆ m_Neut_MinEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_Neut_MinEneShowerLib {this, "NeutMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers"}

private

Definition at line 51 of file LArFastShowerTool.h.

◆ m_noRegions

Gaudi::Property<bool> FastSimulationBase::m_noRegions {this, "NoRegions", false}

protectedinherited

This Fast Simulation has no regions associated with it.

Definition at line 59 of file FastSimulationBase.h.

◆ m_Pion_FlagShowerLib

Gaudi::Property<bool> LArFastShowerTool::m_Pion_FlagShowerLib {this, "PionFlagToShowerLib", true, "Switch for neutron frozen showers"}

private

Definition at line 54 of file LArFastShowerTool.h.

◆ m_Pion_MaxEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_Pion_MaxEneShowerLib {this, "PionMaxEneShowerLib", 2.0*CLHEP::GeV, "Maximum energy for neutron frozen showers"}

private

Definition at line 56 of file LArFastShowerTool.h.

◆ m_Pion_MinEneShowerLib

Gaudi::Property<double> LArFastShowerTool::m_Pion_MinEneShowerLib {this, "PionMinEneShowerLib", 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers"}

private

Definition at line 55 of file LArFastShowerTool.h.

◆ m_regionName

Gaudi::Property<std::string> FastSimulationBase::m_regionName {this, "RegionName", ""}

protectedinherited

The region to which this fast sim is assigned.

Definition at line 57 of file FastSimulationBase.h.

◆ m_showerLibSvc

ServiceHandle<ILArG4ShowerLibSvc> LArFastShowerTool::m_showerLibSvc

private

Initial value:

{this, "ShowerLibSvc", "LArG4ShowerLibSvc"

, "Handle on the shower library service"}

Pointer to the shower library service.

Definition at line 39 of file LArFastShowerTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArFastShowerTool()

◆ ~LArFastShowerTool()

Member Function Documentation

◆ BeginOfAthenaEvent()

◆ deleteFastSimModel()

◆ EndOfAthenaEvent()

◆ getFastSimModel()

◆ getRegion()

◆ initialize()

◆ initializeFastSim()

◆ makeFastSimModel()

◆ setFastSimModel()

Member Data Documentation

◆ m_absCrackEta1

◆ m_absCrackEta2

◆ m_absHighEta

◆ m_absLowEta

◆ m_applyRRWeights

◆ m_configuration

◆ m_containCrack

◆ m_containHigh

◆ m_containLow

◆ m_detector_tag

◆ m_e_FlagShowerLib

◆ m_e_MaxEneShowerLib

◆ m_e_MinEneShowerLib

◆ m_fastSimDedicatedSD

◆ m_FastSimModel

◆ m_g_FlagShowerLib

◆ m_g_MaxEneShowerLib

◆ m_g_MinEneShowerLib

◆ m_generated_starting_points_file

◆ m_generated_starting_points_ratio

◆ m_Neut_FlagShowerLib

◆ m_Neut_MaxEneShowerLib

◆ m_Neut_MinEneShowerLib

◆ m_noRegions

◆ m_Pion_FlagShowerLib

◆ m_Pion_MaxEneShowerLib

◆ m_Pion_MinEneShowerLib

◆ m_regionName

◆ m_showerLibSvc