iFatras::McEnergyLossUpdator Class Reference

#include <McEnergyLossUpdator.h>

Inheritance diagram for iFatras::McEnergyLossUpdator:

Collaboration diagram for iFatras::McEnergyLossUpdator:

Public Member Functions
	McEnergyLossUpdator (const std::string &, const std::string &, const IInterface *)
	Constructor with AlgTool parameters. More...
virtual	~McEnergyLossUpdator ()=default
	Destructor. More...
virtual StatusCode	initialize () override
	AlgTool initialise method. More...
virtual double	dEdX (const Trk::MaterialProperties &materialProperties, double momentum, Trk::ParticleHypothesis particleHypothesis=Trk::pion) const override
	IEnergyLossUpdator public method to compute dEdX. More...
virtual Trk::EnergyLoss	energyLoss (const Trk::MaterialProperties &materialProperties, double momentum, double pathCorrection, Trk::PropDirection direction=Trk::alongMomentum, Trk::ParticleHypothesis particleHypothesis=Trk::pion, bool usePDGformula=false) const override
	IEnergyLossUpdator public method to compute the mean and variance of the energy loss. More...
virtual Trk::EnergyLoss	updateEnergyLoss (Trk::EnergyLoss &, double, double, double, double, int &) const override
	Dummy methodes imposed by public interface - cleanup. More...
virtual void	getX0ElossScales (int, double, double, double &, double &) const override
	Routine to calculate X0 and Eloss scale factors for the Calorimeter and Muon System. More...

Private Attributes
PublicToolHandle< IEnergyLossUpdator >	m_energyLossUpdator {this, "EnergyLossUpdator", "Trk::EnergyLossUpdator/AtlasEnergyLossUpdator"}
	Dummy methods end here. More...
IntegerProperty	m_energyLossDistribution {this, "EnergyLossDistribution", 3}
	include energy loss straggling or not ( 0 == none, 1 == gauss, 2 == landau) More...
ServiceHandle< IAtRndmGenSvc >	m_rndGenSvc {this, "RandomNumberService", "AtDSFMTGenSvc"}
	Random Generator service - not thread-safe. More...
CLHEP::HepRandomEngine *	m_randomEngine {}
	Random engine More...
StringProperty	m_randomEngineName {this, "RandomStreamName", "FatrasRnd"}
	Name of the random number stream. More...
BooleanProperty	m_usePDGformula {this, "UsePDG_EnergyLossFormula", false}

Detailed Description

Updator for a eloss of a track on a Trk::Layer, it extends the IEnergyLossUpdtor interface

Author

Tom.A.nosp@m.tkin.nosp@m.son@c.nosp@m.ern..nosp@m.ch, Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 35 of file McEnergyLossUpdator.h.

Constructor & Destructor Documentation

McEnergyLossUpdator()

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

Constructor with AlgTool parameters.

Definition at line 18 of file McEnergyLossUpdator.cxx.

  :
  base_class( type, name, parent )
{
}

~McEnergyLossUpdator()

virtual iFatras::McEnergyLossUpdator::~McEnergyLossUpdator ( )

virtualdefault

Destructor.

Member Function Documentation

dEdX()

double iFatras::McEnergyLossUpdator::dEdX ( const Trk::MaterialProperties &  materialProperties, double  momentum, Trk::ParticleHypothesis  particleHypothesis = Trk::pion  ) const

overridevirtual

IEnergyLossUpdator public method to compute dEdX.

Definition at line 46 of file McEnergyLossUpdator.cxx.

{
  // simply forward the dEdX from the standard energy loss updator
  return m_energyLossUpdator->dEdX( materialProperties, momentum, particleHypothesis );
}

energyLoss()

Trk::EnergyLoss iFatras::McEnergyLossUpdator::energyLoss ( const Trk::MaterialProperties &  materialProperties, double  momentum, double  pathCorrection, Trk::PropDirection  direction = Trk::alongMomentum, Trk::ParticleHypothesis  particleHypothesis = Trk::pion, bool  usePDGformula = false  ) const

overridevirtual

IEnergyLossUpdator public method to compute the mean and variance of the energy loss.

Definition at line 55 of file McEnergyLossUpdator.cxx.

{
 
 
  // get the number of the material effects distribution
  Trk::EnergyLoss sampledEloss =
    m_energyLossUpdator->energyLoss(materialProperties,
                                    momentum,
                                    pathCorrection,
                                    direction,
                                    particleHypothesis,
                                    m_usePDGformula);
 
 
  // smear according to preselected distribution
  switch (m_energyLossDistribution) {
    // no straggling
  case 0 : { } break;
    // gaussian smearing
  case 1 : {
    float deIoni = sampledEloss.sigmaIoni() * CLHEP::RandGaussZiggurat::shoot(m_randomEngine);
    float deRad  = sampledEloss.sigmaRad() * CLHEP::RandGaussZiggurat::shoot(m_randomEngine);
    sampledEloss.update(deIoni,0.,deRad,0.,false);
  } break;
  case 2 : {
    float deIoni = -sampledEloss.sigmaIoni() * CLHEP::RandLandau::shoot(m_randomEngine);  // TODO :check sign
    sampledEloss.update(deIoni,0.,0.,0.,false);
  } break;
    // landau smearing
    default : {
      float deIoni = -sampledEloss.sigmaIoni() * CLHEP::RandLandau::shoot(m_randomEngine);  // TODO :check sign
      float deRad  = -sampledEloss.sigmaRad() * CLHEP::RandLandau::shoot(m_randomEngine);   // TODO :check sign
      sampledEloss.update(deIoni,0.,deRad,0.,false);
    } break;
  }
 
  // protection due to straggling - maximum energy loss is E-m
  double m     = Trk::ParticleMasses::mass[particleHypothesis];
  double E     = sqrt(momentum*momentum+m*m);
 
  if (sampledEloss.deltaE()+E<m ) {    // particle stopping - rest energy
      float dRad_rest = m-E-sampledEloss.deltaE();
      sampledEloss.update(0.,0.,dRad_rest,0.,false);
  }
 
  return sampledEloss;
}

getX0ElossScales()

virtual void iFatras::McEnergyLossUpdator::getX0ElossScales ( int  , double  , double  , double &  , double &    ) const

inlineoverridevirtual

Routine to calculate X0 and Eloss scale factors for the Calorimeter and Muon System.

Definition at line 71 of file McEnergyLossUpdator.h.

{}

initialize()

StatusCode iFatras::McEnergyLossUpdator::initialize ( )

overridevirtual

AlgTool initialise method.

Definition at line 25 of file McEnergyLossUpdator.cxx.

{
  ATH_MSG_VERBOSE( "initialize()" );
 
  // Retrieve the energy loss updator tool
  ATH_CHECK ( m_energyLossUpdator.retrieve() );
 
  // get the random generator serice
  ATH_CHECK ( m_rndGenSvc.retrieve() );
 
  //Get own engine with own seeds:
  m_randomEngine = m_rndGenSvc->GetEngine(m_randomEngineName);
  if (!m_randomEngine) {
      ATH_MSG_FATAL( "Could not get random engine '" << m_randomEngineName << "'" );
      return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

updateEnergyLoss()

virtual Trk::EnergyLoss iFatras::McEnergyLossUpdator::updateEnergyLoss ( Trk::EnergyLoss &  , double  , double  , double  , double  , int &    ) const

inlineoverridevirtual

Dummy methodes imposed by public interface - cleanup.

Method to recalculate Eloss values for the fit setting an elossFlag using as an input the detailed Eloss information Calorimeter energy, error momentum and momentum error

Definition at line 67 of file McEnergyLossUpdator.h.

{ return {}; }

Member Data Documentation

m_energyLossDistribution

IntegerProperty iFatras::McEnergyLossUpdator::m_energyLossDistribution {this, "EnergyLossDistribution", 3}

private

include energy loss straggling or not ( 0 == none, 1 == gauss, 2 == landau)

Definition at line 77 of file McEnergyLossUpdator.h.

m_energyLossUpdator

PublicToolHandle<IEnergyLossUpdator> iFatras::McEnergyLossUpdator::m_energyLossUpdator {this, "EnergyLossUpdator", "Trk::EnergyLossUpdator/AtlasEnergyLossUpdator"}

private

Dummy methods end here.

ToolHandle to the energy loss updator

Definition at line 76 of file McEnergyLossUpdator.h.

m_randomEngine

CLHEP::HepRandomEngine* iFatras::McEnergyLossUpdator::m_randomEngine {}

private

Random engine

Definition at line 82 of file McEnergyLossUpdator.h.

m_randomEngineName

StringProperty iFatras::McEnergyLossUpdator::m_randomEngineName {this, "RandomStreamName", "FatrasRnd"}

private

Name of the random number stream.

Definition at line 83 of file McEnergyLossUpdator.h.

m_rndGenSvc

ServiceHandle<IAtRndmGenSvc> iFatras::McEnergyLossUpdator::m_rndGenSvc {this, "RandomNumberService", "AtDSFMTGenSvc"}

private

Random Generator service - not thread-safe.

Definition at line 80 of file McEnergyLossUpdator.h.

m_usePDGformula

BooleanProperty iFatras::McEnergyLossUpdator::m_usePDGformula {this, "UsePDG_EnergyLossFormula", false}

private

Definition at line 84 of file McEnergyLossUpdator.h.

---

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

• McEnergyLossUpdator.h
• McEnergyLossUpdator.cxx