genfit::MaterialEffects Class Reference

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

#include <MaterialEffects.h>

Inheritance diagram for genfit::MaterialEffects:

Public Member Functions
void	init (AbsMaterialInterface *matIfc)
	set the material interface here. Material interface classes must be derived from AbsMaterialInterface. More...
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	setMscModel (const std::string &modelName)
	Select the multiple scattering model that will be used during track fit. More...
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. More...
void	stepper (const RKTrackRep *rep, M1x7 &state7, const double &mom, double &relMomLoss, const int &pdg, MaterialProperties &currentMaterial, StepLimits &limits, bool varField=true)
	Returns maximum length so that a specified momentum loss will not be exceeded. More...
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_ More...
void	getMomGammaBeta (double Energy, double &mom, double &gammaSquare, double &gamma, double &betaSquare) const
double	momentumLoss (double stepSign, double mom, bool linear)
	Returns momentum loss. More...
double	dEdx (double Energy) const
	Calculate dEdx for a given energy. More...
double	dEdxBetheBloch (double betaSquare, double gamma, double gammasquare) const
	Uses Bethe Bloch formula to calculate dEdx. More...
void	noiseBetheBloch (M7x7 &noise, double mom, double betaSquare, double gamma, double gammaSquare) const
	calculation of energy loss straggeling More...
void	noiseCoulomb (M7x7 &noise, const M1x3 &direction, double momSquare, double betaSquare) const
	calculation of multiple scattering More...
double	dEdxBrems (double mom) const
	Returns dEdx. More...
void	noiseBrems (M7x7 &noise, double momSquare, double betaSquare) const
	calculation of energy loss straggeling More...

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_
int	charge_
double	mass_
int	mscModelCode_
AbsMaterialInterface *	materialInterface_
	depending on this number a specific msc model is chosen in the noiseCoulomb function. More...
unsigned int	debugLvl_

Static Private Attributes
static MaterialEffects *	instance_

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 51 of file MaterialEffects.h.

Constructor & Destructor Documentation

genfit::MaterialEffects::MaterialEffects ( )

private

virtual genfit::MaterialEffects::~MaterialEffects ( )

privatevirtual

Member Function Documentation

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

private

Calculate dEdx for a given energy.

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

private

Uses Bethe Bloch formula to calculate dEdx.

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.

static void genfit::MaterialEffects::destruct ( )

static

void genfit::MaterialEffects::drawdEdx

(

int

pdg = 11

)

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.

static MaterialEffects* genfit::MaterialEffects::getInstance ( )

static

Referenced by PndRecoDafFit2::Init(), and PndRecoKalmanFit2::Init().

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

private

void genfit::MaterialEffects::getParticleParameters ( )

private

sets charge_, mass_

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

inline

Definition at line 77 of file MaterialEffects.h.

References ignoreBoundariesBetweenEqualMaterials_.

{ignoreBoundariesBetweenEqualMaterials_ = opt;}

void genfit::MaterialEffects::init

(

AbsMaterialInterface *

matIfc

)

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

Referenced by PndRecoDafFit2::Init(), and PndRecoKalmanFit2::Init().

bool genfit::MaterialEffects::isInitialized ( )

inline

Definition at line 68 of file MaterialEffects.h.

References materialInterface_.

{ return materialInterface_ != nullptr; }

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

private

Returns momentum loss.

Also sets dEdx_ and E_.

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!

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.

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.

void genfit::MaterialEffects::setDebugLvl

(

unsigned int

lvl = 1

)

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

inline

Definition at line 72 of file MaterialEffects.h.

References energyLossBetheBloch_, and noEffects_.

{energyLossBetheBloch_ = opt; noEffects_ = false;}

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

inline

Definition at line 75 of file MaterialEffects.h.

References energyLossBrems_, and noEffects_.

{energyLossBrems_ = opt; noEffects_ = false;}

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.

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

inline

Definition at line 70 of file MaterialEffects.h.

References noEffects_.

{noEffects_ = opt;}

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

inline

Definition at line 73 of file MaterialEffects.h.

References noEffects_, and noiseBetheBloch_.

{noiseBetheBloch_ = opt; noEffects_ = false;}

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

inline

Definition at line 76 of file MaterialEffects.h.

References noEffects_, and noiseBrems_.

{noiseBrems_ = opt; noEffects_ = false;}

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

inline

Definition at line 74 of file MaterialEffects.h.

References noEffects_, and noiseCoulomb_.

{noiseCoulomb_ = opt; noEffects_ = false;}

void genfit::MaterialEffects::stepper	(	const RKTrackRep *	rep,
		M1x7 &	state7,
		const double &	mom,
		double &	relMomLoss,
		const int &	pdg,
		MaterialProperties &	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.

Member Data Documentation

int genfit::MaterialEffects::charge_

private

Definition at line 195 of file MaterialEffects.h.

unsigned int genfit::MaterialEffects::debugLvl_

private

Definition at line 202 of file MaterialEffects.h.

double genfit::MaterialEffects::dEdx_

private

Definition at line 186 of file MaterialEffects.h.

double genfit::MaterialEffects::E_

private

Definition at line 187 of file MaterialEffects.h.

bool genfit::MaterialEffects::energyLossBetheBloch_

private

Definition at line 173 of file MaterialEffects.h.

Referenced by setEnergyLossBetheBloch().

bool genfit::MaterialEffects::energyLossBrems_

private

Definition at line 176 of file MaterialEffects.h.

Referenced by setEnergyLossBrems().

bool genfit::MaterialEffects::ignoreBoundariesBetweenEqualMaterials_

private

Definition at line 179 of file MaterialEffects.h.

Referenced by ignoreBoundariesBetweenEqualMaterials().

MaterialEffects* genfit::MaterialEffects::instance_

staticprivate

Definition at line 58 of file MaterialEffects.h.

double genfit::MaterialEffects::mass_

private

Definition at line 196 of file MaterialEffects.h.

double genfit::MaterialEffects::matA_

private

Definition at line 190 of file MaterialEffects.h.

double genfit::MaterialEffects::matDensity_

private

Definition at line 188 of file MaterialEffects.h.

AbsMaterialInterface* genfit::MaterialEffects::materialInterface_

private

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

Definition at line 200 of file MaterialEffects.h.

Referenced by isInitialized().

double genfit::MaterialEffects::matZ_

private

Definition at line 189 of file MaterialEffects.h.

const double genfit::MaterialEffects::me_

private

Definition at line 181 of file MaterialEffects.h.

double genfit::MaterialEffects::mEE_

private

Definition at line 192 of file MaterialEffects.h.

int genfit::MaterialEffects::mscModelCode_

private

Definition at line 198 of file MaterialEffects.h.

bool genfit::MaterialEffects::noEffects_

private

Definition at line 171 of file MaterialEffects.h.

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

bool genfit::MaterialEffects::noiseBetheBloch_

private

Definition at line 174 of file MaterialEffects.h.

Referenced by setNoiseBetheBloch().

bool genfit::MaterialEffects::noiseBrems_

private

Definition at line 177 of file MaterialEffects.h.

Referenced by setNoiseBrems().

bool genfit::MaterialEffects::noiseCoulomb_

private

Definition at line 175 of file MaterialEffects.h.

Referenced by setNoiseCoulomb().

int genfit::MaterialEffects::pdg_

private

Definition at line 194 of file MaterialEffects.h.

double genfit::MaterialEffects::radiationLength_

private

Definition at line 191 of file MaterialEffects.h.

double genfit::MaterialEffects::stepSize_

private

Definition at line 183 of file MaterialEffects.h.

---

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

• MaterialEffects.h