genfit::MaterialEffects Class Reference

Stepper and energy loss/noise matrix calculation. More...

#include <MaterialEffects.h>

Collaboration diagram for genfit::MaterialEffects:

Public Member Functions
void	init (AbsMaterialInterface *matIfc)
	set the material interface here. Material interface classes must be derived from AbsMaterialInterface.
bool	isInitialized ()
void	setNoEffects (bool opt=true)
void	setEnergyLossBetheBloch (bool opt=true)
void	setNoiseBetheBloch (bool opt=true)
void	setNoiseCoulomb (bool opt=true)
void	setEnergyLossBrems (bool opt=true)
void	setNoiseBrems (bool opt=true)
void	ignoreBoundariesBetweenEqualMaterials (bool opt=true)
void	setMagCharge (double magCharge)
void	setMscModel (const std::string &modelName)
	Select the multiple scattering model that will be used during track fit.
double	effects (const std::vector< RKStep > &steps, int materialsFXStart, int materialsFXStop, const double &mom, const int &pdg, M7x7 *noise=nullptr)
	Calculates energy loss in the traveled path, optional calculation of noise matrix.
void	stepper (const RKTrackRep *rep, M1x7 &state7, const double &mom, double &relMomLoss, const int &pdg, Material &currentMaterial, StepLimits &limits, bool varField=true)
	Returns maximum length so that a specified momentum loss will not be exceeded.
void	setDebugLvl (unsigned int lvl=1)
void	drawdEdx (int pdg=11)

Static Public Member Functions
static MaterialEffects *	getInstance ()
static void	destruct ()

Private Member Functions
	MaterialEffects ()
virtual	~MaterialEffects ()
void	getParticleParameters ()
	sets charge_, mass_
void	getMomGammaBeta (double Energy, double &mom, double &gammaSquare, double &gamma, double &betaSquare) const
double	momentumLoss (double stepSign, double mom, bool linear)
	Returns momentum loss.
double	dEdx (double Energy)
	Calculate dEdx for a given energy.
double	dEdxBetheBloch (double betaSquare, double gamma, double gammasquare) const
	Uses Bethe Bloch formula to calculate dEdx.
void	noiseBetheBloch (M7x7 &noise, double mom, double betaSquare, double gamma, double gammaSquare) const
	calculation of energy loss straggeling
void	noiseCoulomb (M7x7 &noise, const M1x3 &direction, double momSquare, double betaSquare) const
	calculation of multiple scattering
double	dEdxBrems (double mom) const
	Returns dEdx.
void	noiseBrems (M7x7 &noise, double momSquare, double betaSquare) const
	calculation of energy loss straggeling

Private Attributes
bool	noEffects_
bool	energyLossBetheBloch_
bool	noiseBetheBloch_
bool	noiseCoulomb_
bool	energyLossBrems_
bool	noiseBrems_
bool	ignoreBoundariesBetweenEqualMaterials_
const double	me_
double	stepSize_
double	dEdx_
double	E_
double	matDensity_
double	matZ_
double	matA_
double	radiationLength_
double	mEE_
int	pdg_
double	charge_
double	mag_charge_
double	mass_
int	mscModelCode_
AbsMaterialInterface *	materialInterface_
	depending on this number a specific msc model is chosen in the noiseCoulomb function.
unsigned int	debugLvl_

Static Private Attributes
static MaterialEffects *	instance_ = nullptr

Detailed Description

Stepper and energy loss/noise matrix calculation.

Author

Christian Höppner (Technische Universität München, original author)

Sebastian Neubert (Technische Universität München, original author)

Johannes Rauch (Technische Universität München, author)

It provides functionality to limit the stepsize of an extrapolation in order not to exceed a specified maximum momentum loss. After propagation, the energy loss for the given length and (optionally) the noise matrix can be calculated. You have to set which energy-loss and noise mechanisms you want to use. At the moment, per default all energy loss and noise options are ON.

Definition at line 50 of file MaterialEffects.h.

Constructor & Destructor Documentation

MaterialEffects()

genfit::MaterialEffects::MaterialEffects ( )

private

Definition at line 43 of file MaterialEffects.cc.

References charge_, debugLvl_, dEdx_, E_, energyLossBetheBloch_, energyLossBrems_, ignoreBoundariesBetweenEqualMaterials_, mag_charge_, mass_, matA_, matDensity_, materialInterface_, matZ_, me_, mEE_, mscModelCode_, noEffects_, noiseBetheBloch_, noiseBrems_, noiseCoulomb_, pdg_, radiationLength_, and stepSize_.

Referenced by getInstance().

~MaterialEffects()

genfit::MaterialEffects::~MaterialEffects ( )

privatevirtual

Definition at line 68 of file MaterialEffects.cc.

References materialInterface_.

Member Function Documentation

dEdx()

double genfit::MaterialEffects::dEdx ( double Energy )

private

Calculate dEdx for a given energy.

Definition at line 453 of file MaterialEffects.cc.

References genfit::c_monopolePDGCode, charge_, dEdxBetheBloch(), dEdxBrems(), energyLossBetheBloch_, energyLossBrems_, getMomGammaBeta(), mag_charge_, and pdg_.

Referenced by drawdEdx(), and momentumLoss().

dEdxBetheBloch()

double genfit::MaterialEffects::dEdxBetheBloch ( double betaSquare, double gamma, double gammasquare ) const

private

Uses Bethe Bloch formula to calculate dEdx.

Definition at line 473 of file MaterialEffects.cc.

References charge_, mass_, matA_, matDensity_, matZ_, me_, mEE_, and genfit::Exception::setFatal().

Referenced by dEdx().

dEdxBrems()

double genfit::MaterialEffects::dEdxBrems ( double mom ) const

private

Returns dEdx.

Can be called with any pdg, but only calculates dEdx for electrons and positrons (otherwise returns 0). Uses a gaussian approximation (Bethe-Heitler formula with Migdal corrections). For positrons, dEdx is weighed with a correction factor.

Definition at line 628 of file MaterialEffects.cc.

References matA_, matDensity_, matZ_, me_, and pdg_.

Referenced by dEdx().

destruct()

void genfit::MaterialEffects::destruct ( )

static

Definition at line 79 of file MaterialEffects.cc.

References instance_.

drawdEdx()

void genfit::MaterialEffects::drawdEdx

(

int

pdg = 11

)

Definition at line 830 of file MaterialEffects.cc.

References genfit::c_monopolePDGCode, charge_, dEdx(), energyLossBetheBloch_, energyLossBrems_, getParticleParameters(), mag_charge_, mass_, matA_, matDensity_, materialInterface_, matZ_, mEE_, pdg_, radiationLength_, and stepSize_.

effects()

double genfit::MaterialEffects::effects	(	const std::vector< RKStep > &	steps,
		int	materialsFXStart,
		int	materialsFXStop,
		const double &	mom,
		const int &	pdg,
		M7x7 *	noise = nullptr )

Calculates energy loss in the traveled path, optional calculation of noise matrix.

Definition at line 114 of file MaterialEffects.cc.

References genfit::Material::A, genfit::c_monopolePDGCode, charge_, debugLvl_, genfit::debugOut, genfit::Material::density, E_, energyLossBetheBloch_, energyLossBrems_, getMomGammaBeta(), getParticleParameters(), mag_charge_, mass_, matA_, matDensity_, materialInterface_, matZ_, genfit::Material::mEE, mEE_, momentumLoss(), noEffects_, noiseBetheBloch(), noiseBetheBloch_, noiseBrems(), noiseBrems_, noiseCoulomb(), noiseCoulomb_, pdg_, genfit::Material::radiationLength, radiationLength_, genfit::Exception::setFatal(), stepSize_, and genfit::Material::Z.

Referenced by genfit::RKTrackRep::Extrap().

getInstance()

MaterialEffects * genfit::MaterialEffects::getInstance ( )

static

Definition at line 73 of file MaterialEffects.cc.

References instance_, and MaterialEffects().

Referenced by genfit::RKTrackRep::estimateStep(), and genfit::RKTrackRep::Extrap().

getMomGammaBeta()

void genfit::MaterialEffects::getMomGammaBeta ( double Energy, double & mom, double & gammaSquare, double & gamma, double & betaSquare ) const

private

Definition at line 374 of file MaterialEffects.cc.

References mass_, and genfit::Exception::setFatal().

Referenced by dEdx(), and effects().

getParticleParameters()

void genfit::MaterialEffects::getParticleParameters ( )

private

sets charge_, mass_

Definition at line 366 of file MaterialEffects.cc.

References charge_, mass_, and pdg_.

Referenced by drawdEdx(), effects(), and stepper().

ignoreBoundariesBetweenEqualMaterials()

void genfit::MaterialEffects::ignoreBoundariesBetweenEqualMaterials ( bool opt = true )

inline

Definition at line 76 of file MaterialEffects.h.

References ignoreBoundariesBetweenEqualMaterials_.

init()

void genfit::MaterialEffects::init

(

AbsMaterialInterface *

matIfc

)

set the material interface here. Material interface classes must be derived from AbsMaterialInterface.

Definition at line 87 of file MaterialEffects.cc.

References materialInterface_.

isInitialized()

bool genfit::MaterialEffects::isInitialized ( )

inline

Definition at line 67 of file MaterialEffects.h.

References materialInterface_.

momentumLoss()

double genfit::MaterialEffects::momentumLoss ( double stepSign, double mom, bool linear )

private

Returns momentum loss.

Also sets dEdx_ and E_.

Definition at line 392 of file MaterialEffects.cc.

References debugLvl_, genfit::debugOut, dEdx(), dEdx_, E_, mass_, and stepSize_.

Referenced by effects(), and stepper().

noiseBetheBloch()

void genfit::MaterialEffects::noiseBetheBloch ( M7x7 & noise, double mom, double betaSquare, double gamma, double gammaSquare ) const

private

calculation of energy loss straggeling

For the energy loss straggeling, different formulas are used for different regions:

• Vavilov-Gaussian regime
• Urban/Landau approximation
• truncated Landau distribution
• Urban model

Needs dEdx_, which is calculated in momentumLoss, so it has to be called afterwards!

Definition at line 497 of file MaterialEffects.cc.

References charge_, dEdx_, mass_, matA_, matDensity_, matZ_, me_, and stepSize_.

Referenced by effects().

noiseBrems()

void genfit::MaterialEffects::noiseBrems ( M7x7 & noise, double momSquare, double betaSquare ) const

private

calculation of energy loss straggeling

Can be called with any pdg, but only calculates straggeling for electrons and positrons.

Definition at line 805 of file MaterialEffects.cc.

References charge_, pdg_, radiationLength_, and stepSize_.

Referenced by effects().

noiseCoulomb()

void genfit::MaterialEffects::noiseCoulomb ( M7x7 & noise, const M1x3 & direction, double momSquare, double betaSquare ) const

private

calculation of multiple scattering

This function first calcuates a MSC variance based on the current material and step length 2 different formulas for the MSC variance are implemeted. One can select the formula via "setMscModel". With the MSC variance and the current direction of the track a full 7D noise matrix is calculated. This noise matrix is the additional noise at the end of fStep in the 7D globa cooridnate system taking even the (co)variances of the position coordinates into account.

Definition at line 557 of file MaterialEffects.cc.

References genfit::RKMatrix< nRows, nCols >::begin(), charge_, genfit::RKMatrix< nRows, nCols >::end(), matZ_, mscModelCode_, radiationLength_, and stepSize_.

Referenced by effects().

setDebugLvl()

void genfit::MaterialEffects::setDebugLvl

(

unsigned int

lvl = 1

)

Definition at line 823 of file MaterialEffects.cc.

References debugLvl_, and materialInterface_.

setEnergyLossBetheBloch()

void genfit::MaterialEffects::setEnergyLossBetheBloch ( bool opt = true )

inline

Definition at line 71 of file MaterialEffects.h.

References energyLossBetheBloch_, and noEffects_.

setEnergyLossBrems()

void genfit::MaterialEffects::setEnergyLossBrems ( bool opt = true )

inline

Definition at line 74 of file MaterialEffects.h.

References energyLossBrems_, and noEffects_.

setMagCharge()

void genfit::MaterialEffects::setMagCharge ( double magCharge )

inline

Definition at line 77 of file MaterialEffects.h.

References mag_charge_.

setMscModel()

void genfit::MaterialEffects::setMscModel

(

const std::string &

modelName

)

Select the multiple scattering model that will be used during track fit.

At the moment two model are available GEANE and Highland. GEANE is the model was was present in Genfit first. Note that using this function has no effect if setNoiseCoulomb(false) is set.

Definition at line 98 of file MaterialEffects.cc.

References genfit::errorOut, mscModelCode_, genfit::Exception::setFatal(), and genfit::Exception::what().

setNoEffects()

void genfit::MaterialEffects::setNoEffects ( bool opt = true )

inline

Definition at line 69 of file MaterialEffects.h.

References noEffects_.

setNoiseBetheBloch()

void genfit::MaterialEffects::setNoiseBetheBloch ( bool opt = true )

inline

Definition at line 72 of file MaterialEffects.h.

References noEffects_, and noiseBetheBloch_.

setNoiseBrems()

void genfit::MaterialEffects::setNoiseBrems ( bool opt = true )

inline

Definition at line 75 of file MaterialEffects.h.

References noEffects_, and noiseBrems_.

setNoiseCoulomb()

void genfit::MaterialEffects::setNoiseCoulomb ( bool opt = true )

inline

Definition at line 73 of file MaterialEffects.h.

References noEffects_, and noiseCoulomb_.

stepper()

void genfit::MaterialEffects::stepper	(	const RKTrackRep *	rep,
		M1x7 &	state7,
		const double &	mom,
		double &	relMomLoss,
		const int &	pdg,
		Material &	currentMaterial,
		StepLimits &	limits,
		bool	varField = true )

Returns maximum length so that a specified momentum loss will not be exceeded.

The stepper returns the maximum length that the particle may travel, so that a specified relative momentum loss will not be exceeded, or the next material boundary is reached. The material crossed are stored together with their stepsizes.

Definition at line 219 of file MaterialEffects.cc.

References genfit::Material::A, debugLvl_, genfit::debugOut, genfit::Material::density, genfit::StepLimits::getLowestLimitSignedVal(), genfit::StepLimits::getLowestLimitVal(), getParticleParameters(), genfit::StepLimits::getStepSign(), ignoreBoundariesBetweenEqualMaterials_, matA_, matDensity_, materialInterface_, matZ_, genfit::Material::mEE, mEE_, momentumLoss(), noEffects_, pdg_, genfit::Material::Print(), genfit::Material::radiationLength, radiationLength_, genfit::RKTrackRep::RKPropagate(), genfit::Exception::setFatal(), genfit::StepLimits::setLimit(), stepSize_, genfit::stp_boundary, genfit::stp_momLoss, and genfit::Material::Z.

Referenced by genfit::RKTrackRep::estimateStep().

Member Data Documentation

charge_

double genfit::MaterialEffects::charge_

private

Definition at line 195 of file MaterialEffects.h.

Referenced by dEdx(), dEdxBetheBloch(), drawdEdx(), effects(), getParticleParameters(), MaterialEffects(), noiseBetheBloch(), noiseBrems(), and noiseCoulomb().

debugLvl_

unsigned int genfit::MaterialEffects::debugLvl_

private

Definition at line 203 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), momentumLoss(), setDebugLvl(), and stepper().

dEdx_

double genfit::MaterialEffects::dEdx_

private

Definition at line 186 of file MaterialEffects.h.

Referenced by MaterialEffects(), momentumLoss(), and noiseBetheBloch().

E_

double genfit::MaterialEffects::E_

private

Definition at line 187 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), and momentumLoss().

energyLossBetheBloch_

bool genfit::MaterialEffects::energyLossBetheBloch_

private

Definition at line 173 of file MaterialEffects.h.

Referenced by dEdx(), drawdEdx(), effects(), MaterialEffects(), and setEnergyLossBetheBloch().

energyLossBrems_

bool genfit::MaterialEffects::energyLossBrems_

private

Definition at line 176 of file MaterialEffects.h.

Referenced by dEdx(), drawdEdx(), effects(), MaterialEffects(), and setEnergyLossBrems().

ignoreBoundariesBetweenEqualMaterials_

bool genfit::MaterialEffects::ignoreBoundariesBetweenEqualMaterials_

private

Definition at line 179 of file MaterialEffects.h.

Referenced by ignoreBoundariesBetweenEqualMaterials(), MaterialEffects(), and stepper().

instance_

MaterialEffects * genfit::MaterialEffects::instance_ = nullptr

staticprivate

Definition at line 57 of file MaterialEffects.h.

Referenced by destruct(), and getInstance().

mag_charge_

double genfit::MaterialEffects::mag_charge_

private

Definition at line 196 of file MaterialEffects.h.

Referenced by dEdx(), drawdEdx(), effects(), MaterialEffects(), and setMagCharge().

mass_

double genfit::MaterialEffects::mass_

private

Definition at line 197 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), drawdEdx(), effects(), getMomGammaBeta(), getParticleParameters(), MaterialEffects(), momentumLoss(), and noiseBetheBloch().

matA_

double genfit::MaterialEffects::matA_

private

Definition at line 190 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), dEdxBrems(), drawdEdx(), effects(), MaterialEffects(), noiseBetheBloch(), and stepper().

matDensity_

double genfit::MaterialEffects::matDensity_

private

Definition at line 188 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), dEdxBrems(), drawdEdx(), effects(), MaterialEffects(), noiseBetheBloch(), and stepper().

materialInterface_

AbsMaterialInterface* genfit::MaterialEffects::materialInterface_

private

depending on this number a specific msc model is chosen in the noiseCoulomb function.

Definition at line 201 of file MaterialEffects.h.

Referenced by drawdEdx(), effects(), init(), isInitialized(), MaterialEffects(), setDebugLvl(), stepper(), and ~MaterialEffects().

matZ_

double genfit::MaterialEffects::matZ_

private

Definition at line 189 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), dEdxBrems(), drawdEdx(), effects(), MaterialEffects(), noiseBetheBloch(), noiseCoulomb(), and stepper().

me_

const double genfit::MaterialEffects::me_

private

Definition at line 181 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), dEdxBrems(), MaterialEffects(), and noiseBetheBloch().

mEE_

double genfit::MaterialEffects::mEE_

private

Definition at line 192 of file MaterialEffects.h.

Referenced by dEdxBetheBloch(), drawdEdx(), effects(), MaterialEffects(), and stepper().

mscModelCode_

int genfit::MaterialEffects::mscModelCode_

private

Definition at line 199 of file MaterialEffects.h.

Referenced by MaterialEffects(), noiseCoulomb(), and setMscModel().

noEffects_

bool genfit::MaterialEffects::noEffects_

private

Definition at line 171 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), setEnergyLossBetheBloch(), setEnergyLossBrems(), setNoEffects(), setNoiseBetheBloch(), setNoiseBrems(), setNoiseCoulomb(), and stepper().

noiseBetheBloch_

bool genfit::MaterialEffects::noiseBetheBloch_

private

Definition at line 174 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), and setNoiseBetheBloch().

noiseBrems_

bool genfit::MaterialEffects::noiseBrems_

private

Definition at line 177 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), and setNoiseBrems().

noiseCoulomb_

bool genfit::MaterialEffects::noiseCoulomb_

private

Definition at line 175 of file MaterialEffects.h.

Referenced by effects(), MaterialEffects(), and setNoiseCoulomb().

pdg_

int genfit::MaterialEffects::pdg_

private

Definition at line 194 of file MaterialEffects.h.

Referenced by dEdx(), dEdxBrems(), drawdEdx(), effects(), getParticleParameters(), MaterialEffects(), noiseBrems(), and stepper().

radiationLength_

double genfit::MaterialEffects::radiationLength_

private

Definition at line 191 of file MaterialEffects.h.

Referenced by drawdEdx(), effects(), MaterialEffects(), noiseBrems(), noiseCoulomb(), and stepper().

stepSize_

double genfit::MaterialEffects::stepSize_

private

Definition at line 183 of file MaterialEffects.h.

Referenced by drawdEdx(), effects(), MaterialEffects(), momentumLoss(), noiseBetheBloch(), noiseBrems(), noiseCoulomb(), and stepper().

---

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

• /home/abuild/rpmbuild/BUILD/genfit-2.0.5-build/GenFit-02-00-05/trackReps/include/MaterialEffects.h
• /home/abuild/rpmbuild/BUILD/genfit-2.0.5-build/GenFit-02-00-05/trackReps/src/MaterialEffects.cc