genfit::AbsKalmanFitter Class Reference

Abstract base class for Kalman fitter and derived fitting algorithms. More...

#include <AbsKalmanFitter.h>

Inheritance diagram for genfit::AbsKalmanFitter:

Public Member Functions
	AbsKalmanFitter (unsigned int maxIterations=4, double deltaPval=1e-3, double blowUpFactor=1e3)
virtual	~AbsKalmanFitter ()
void	getChiSquNdf (const Track *tr, const AbsTrackRep *rep, double &bChi2, double &fChi2, double &bNdf, double &fNdf) const
double	getChiSqu (const Track *tr, const AbsTrackRep *rep, int direction=-1) const
double	getNdf (const Track *tr, const AbsTrackRep *rep, int direction=-1) const
double	getRedChiSqu (const Track *tr, const AbsTrackRep *rep, int direction=-1) const
double	getPVal (const Track *tr, const AbsTrackRep *rep, int direction=-1) const
unsigned int	getMinIterations () const
unsigned int	getMaxIterations () const
double	getDeltaPval () const
double	getRelChi2Change () const
double	getBlowUpFactor () const
bool	getResetOffDiagonals () const
double	getBlowUpMaxVal () const
eMultipleMeasurementHandling	getMultipleMeasurementHandling () const
int	getMaxFailedHits () const
virtual void	setMinIterations (unsigned int n)
	Set the minimum number of iterations. More...
virtual void	setMaxIterations (unsigned int n)
	Set the maximum number of iterations. More...
void	setDeltaPval (double deltaPval)
	Set Convergence criterion. More...
void	setRelChi2Change (double relChi2Change)
void	setBlowUpFactor (double blowUpFactor)
void	setResetOffDiagonals (bool resetOffDiagonals)
void	setBlowUpMaxVal (double blowUpMaxVal)
	Limit the cov entries to this maximum value when blowing up the cov. Set to negative value to disable. Default is 1.E6. More...
void	setMultipleMeasurementHandling (eMultipleMeasurementHandling mmh)
	How should multiple measurements be handled? More...
virtual void	setMaxFailedHits (int val)
bool	isTrackPrepared (const Track *tr, const AbsTrackRep *rep) const
bool	isTrackFitted (const Track *tr, const AbsTrackRep *rep) const
bool	canIgnoreWeights () const
	returns if the fitter can ignore the weights and handle the MeasurementOnPlanes as if they had weight 1. More...
Public Member Functions inherited from genfit::AbsFitter
	AbsFitter ()
virtual	~AbsFitter ()
virtual void	processTrackWithRep (Track *, const AbsTrackRep *, bool resortHits=false)=0
void	processTrack (Track *, bool resortHits=false)
virtual void	setDebugLvl (unsigned int lvl=1)

Protected Member Functions
const std::vector< MeasurementOnPlane * >	getMeasurements (const KalmanFitterInfo *fi, const TrackPoint *tp, int direction) const
	get the measurementsOnPlane taking the multipleMeasurementHandling_ into account More...

Protected Attributes
unsigned int	minIterations_
	Minimum number of iterations to attempt. Forward and backward are counted as one iteration. More...
unsigned int	maxIterations_
	Maximum number of iterations to attempt. Forward and backward are counted as one iteration. More...
double	deltaPval_
	Convergence criterion. More...
double	relChi2Change_
double	blowUpFactor_
	Blow up the covariance of the forward (backward) fit by this factor before seeding the backward (forward) fit. More...
bool	resetOffDiagonals_
	Reset the off-diagonals to 0 when blowing up the cov. More...
double	blowUpMaxVal_
	Limit the cov entries to this maxuimum value when blowing up the cov. More...
eMultipleMeasurementHandling	multipleMeasurementHandling_
	How to handle if there are multiple MeasurementsOnPlane. More...
int	maxFailedHits_
Protected Attributes inherited from genfit::AbsFitter
unsigned int	debugLvl_

Detailed Description

Abstract base class for Kalman fitter and derived fitting algorithms.

Definition at line 53 of file AbsKalmanFitter.h.

Constructor & Destructor Documentation

AbsKalmanFitter()

genfit::AbsKalmanFitter::AbsKalmanFitter ( unsigned int  maxIterations = 4, double  deltaPval = 1e-3, double  blowUpFactor = 1e3  )

inline

Definition at line 56 of file AbsKalmanFitter.h.

References maxIterations_, and minIterations_.

    : AbsFitter(), minIterations_(2), maxIterations_(maxIterations), deltaPval_(deltaPval), relChi2Change_(0.2), blowUpFactor_(blowUpFactor), resetOffDiagonals_(true),
      blowUpMaxVal_(1.E6), multipleMeasurementHandling_(unweightedClosestToPredictionWire), maxFailedHits_(-1)
  {
    if (minIterations_ > maxIterations_)
      minIterations_ = maxIterations_;
  }

~AbsKalmanFitter()

virtual genfit::AbsKalmanFitter::~AbsKalmanFitter ( )

inlinevirtual

Definition at line 64 of file AbsKalmanFitter.h.

References getChiSqu(), getChiSquNdf(), getNdf(), getPVal(), and getRedChiSqu().

{ ; }

Member Function Documentation

canIgnoreWeights()

bool genfit::AbsKalmanFitter::canIgnoreWeights

(

)

const

returns if the fitter can ignore the weights and handle the MeasurementOnPlanes as if they had weight 1.

Referenced by setMaxFailedHits().

getBlowUpFactor()

double genfit::AbsKalmanFitter::getBlowUpFactor ( ) const

inline

Definition at line 78 of file AbsKalmanFitter.h.

References blowUpFactor_.

{ return blowUpFactor_; }

getBlowUpMaxVal()

double genfit::AbsKalmanFitter::getBlowUpMaxVal ( ) const

inline

Definition at line 80 of file AbsKalmanFitter.h.

References blowUpMaxVal_.

{ return blowUpMaxVal_; }

getChiSqu()

double genfit::AbsKalmanFitter::getChiSqu	(	const Track *	tr,
		const AbsTrackRep *	rep,
		int	direction = -1
	)		const

Referenced by ~AbsKalmanFitter().

getChiSquNdf()

void genfit::AbsKalmanFitter::getChiSquNdf	(	const Track *	tr,
		const AbsTrackRep *	rep,
		double &	bChi2,
		double &	fChi2,
		double &	bNdf,
		double &	fNdf
	)		const

Referenced by ~AbsKalmanFitter().

getDeltaPval()

double genfit::AbsKalmanFitter::getDeltaPval ( ) const

inline

Definition at line 76 of file AbsKalmanFitter.h.

References deltaPval_.

{ return deltaPval_; }

getMaxFailedHits()

int genfit::AbsKalmanFitter::getMaxFailedHits ( ) const

inline

Definition at line 82 of file AbsKalmanFitter.h.

References maxFailedHits_.

{ return maxFailedHits_; }

getMaxIterations()

unsigned int genfit::AbsKalmanFitter::getMaxIterations ( ) const

inline

Definition at line 75 of file AbsKalmanFitter.h.

References maxIterations_.

{ return maxIterations_; }

getMeasurements()

const std::vector<MeasurementOnPlane *> genfit::AbsKalmanFitter::getMeasurements ( const KalmanFitterInfo *  fi, const TrackPoint *  tp, int  direction  ) const

protected

get the measurementsOnPlane taking the multipleMeasurementHandling_ into account

Referenced by setMaxFailedHits().

getMinIterations()

unsigned int genfit::AbsKalmanFitter::getMinIterations ( ) const

inline

Definition at line 74 of file AbsKalmanFitter.h.

References minIterations_.

{ return minIterations_; }

getMultipleMeasurementHandling()

eMultipleMeasurementHandling genfit::AbsKalmanFitter::getMultipleMeasurementHandling ( ) const

inline

Definition at line 81 of file AbsKalmanFitter.h.

References multipleMeasurementHandling_.

{ return multipleMeasurementHandling_; }

getNdf()

double genfit::AbsKalmanFitter::getNdf	(	const Track *	tr,
		const AbsTrackRep *	rep,
		int	direction = -1
	)		const

Referenced by ~AbsKalmanFitter().

getPVal()

double genfit::AbsKalmanFitter::getPVal	(	const Track *	tr,
		const AbsTrackRep *	rep,
		int	direction = -1
	)		const

Referenced by ~AbsKalmanFitter().

getRedChiSqu()

double genfit::AbsKalmanFitter::getRedChiSqu	(	const Track *	tr,
		const AbsTrackRep *	rep,
		int	direction = -1
	)		const

Referenced by ~AbsKalmanFitter().

getRelChi2Change()

double genfit::AbsKalmanFitter::getRelChi2Change ( ) const

inline

Definition at line 77 of file AbsKalmanFitter.h.

References relChi2Change_.

{ return relChi2Change_; }

getResetOffDiagonals()

bool genfit::AbsKalmanFitter::getResetOffDiagonals ( ) const

inline

Definition at line 79 of file AbsKalmanFitter.h.

References resetOffDiagonals_.

{ return resetOffDiagonals_; }

isTrackFitted()

bool genfit::AbsKalmanFitter::isTrackFitted	(	const Track *	tr,
		const AbsTrackRep *	rep
	)		const

Referenced by setMaxFailedHits().

isTrackPrepared()

bool genfit::AbsKalmanFitter::isTrackPrepared	(	const Track *	tr,
		const AbsTrackRep *	rep
	)		const

Referenced by setMaxFailedHits().

setBlowUpFactor()

void genfit::AbsKalmanFitter::setBlowUpFactor ( double  blowUpFactor )

inline

Definition at line 118 of file AbsKalmanFitter.h.

References blowUpFactor_.

{ blowUpFactor_ = blowUpFactor; }

setBlowUpMaxVal()

void genfit::AbsKalmanFitter::setBlowUpMaxVal ( double  blowUpMaxVal )

inline

Limit the cov entries to this maximum value when blowing up the cov. Set to negative value to disable. Default is 1.E6.

This is especially useful for fits where the measurements do not constrain one direction, e.g. parallel wire measurements. The fit will not be constrained along the wire direction. This also means that the covariance along the wire direction will not get smaller during the fit. However, it will be blown up before the next iteration, leading to an exponential growth of the covariance element(s) corresponding to the wire direction. This can then lead to numerical problems. To prevent this, the maximum value of the covariance elements after blowing up can be limited.

Definition at line 129 of file AbsKalmanFitter.h.

References blowUpMaxVal_.

{ blowUpMaxVal_ = blowUpMaxVal; }

setDeltaPval()

void genfit::AbsKalmanFitter::setDeltaPval ( double  deltaPval )

inline

Set Convergence criterion.

if track total P-value changes less than this between consecutive iterations, consider the track converged. chi² from the backwards fit is used.

Definition at line 105 of file AbsKalmanFitter.h.

References deltaPval_.

{ deltaPval_ = deltaPval; }

setMaxFailedHits()

virtual void genfit::AbsKalmanFitter::setMaxFailedHits ( int  val )

inlinevirtual

Reimplemented in genfit::DAF.

Definition at line 134 of file AbsKalmanFitter.h.

References canIgnoreWeights(), getMeasurements(), isTrackFitted(), isTrackPrepared(), and maxFailedHits_.

Referenced by genfit::DAF::setMaxFailedHits().

{ maxFailedHits_ = val; }

setMaxIterations()

virtual void genfit::AbsKalmanFitter::setMaxIterations ( unsigned int  n )

inlinevirtual

Set the maximum number of iterations.

Reimplemented in genfit::DAF.

Definition at line 92 of file AbsKalmanFitter.h.

References maxIterations_, and minIterations_.

  {
    maxIterations_ = n;
    if (minIterations_ > maxIterations_)
      minIterations_ = maxIterations_;
  }

setMinIterations()

virtual void genfit::AbsKalmanFitter::setMinIterations ( unsigned int  n )

inlinevirtual

Set the minimum number of iterations.

Definition at line 85 of file AbsKalmanFitter.h.

References max(), maxIterations_, and minIterations_.

  {
    minIterations_ = std::max((unsigned int)1, n);
    if (maxIterations_ < minIterations_)
      maxIterations_ = minIterations_;
  }

setMultipleMeasurementHandling()

void genfit::AbsKalmanFitter::setMultipleMeasurementHandling ( eMultipleMeasurementHandling  mmh )

inline

How should multiple measurements be handled?

Definition at line 132 of file AbsKalmanFitter.h.

References multipleMeasurementHandling_.

{ multipleMeasurementHandling_ = mmh; }

setRelChi2Change()

void genfit::AbsKalmanFitter::setRelChi2Change ( double  relChi2Change )

inline

@ brief Set Non-convergence criterion

if the relative chi^2 between two iterations is larger than relChi2Change_, the fit is NOT converged and further iterations will be done, even if the deltaPval_ convergence criterium is met. This is especially useful for fits which have a p-value of almost 0 (possibly due to bad start values), where the p-value from one iteration to the next might not change much. However, a significant change in chi^2 tells us, that the fit might not yet be converged.

Definition at line 116 of file AbsKalmanFitter.h.

References relChi2Change_.

{ relChi2Change_ = relChi2Change; }

setResetOffDiagonals()

void genfit::AbsKalmanFitter::setResetOffDiagonals ( bool  resetOffDiagonals )

inline

Definition at line 119 of file AbsKalmanFitter.h.

References resetOffDiagonals_.

{ resetOffDiagonals_ = resetOffDiagonals; }

Member Data Documentation

blowUpFactor_

double genfit::AbsKalmanFitter::blowUpFactor_

protected

Blow up the covariance of the forward (backward) fit by this factor before seeding the backward (forward) fit.

Definition at line 170 of file AbsKalmanFitter.h.

Referenced by getBlowUpFactor(), and setBlowUpFactor().

blowUpMaxVal_

double genfit::AbsKalmanFitter::blowUpMaxVal_

protected

Limit the cov entries to this maxuimum value when blowing up the cov.

Definition at line 174 of file AbsKalmanFitter.h.

Referenced by getBlowUpMaxVal(), and setBlowUpMaxVal().

deltaPval_

double genfit::AbsKalmanFitter::deltaPval_

protected

Convergence criterion.

if track total P-value changes less than this between consecutive iterations, consider the track converged. chi² from the backwards fit is used.

Definition at line 157 of file AbsKalmanFitter.h.

Referenced by getDeltaPval(), and setDeltaPval().

maxFailedHits_

int genfit::AbsKalmanFitter::maxFailedHits_

protected

after how many failed hits (exception during construction of plane, extrapolation etc.) should the fit be cancelled. -1 means don't cancel

Definition at line 181 of file AbsKalmanFitter.h.

Referenced by getMaxFailedHits(), and setMaxFailedHits().

maxIterations_

unsigned int genfit::AbsKalmanFitter::maxIterations_

protected

Maximum number of iterations to attempt. Forward and backward are counted as one iteration.

Definition at line 150 of file AbsKalmanFitter.h.

Referenced by AbsKalmanFitter(), getMaxIterations(), setMaxIterations(), genfit::DAF::setMaxIterations(), and setMinIterations().

minIterations_

unsigned int genfit::AbsKalmanFitter::minIterations_

protected

Minimum number of iterations to attempt. Forward and backward are counted as one iteration.

Definition at line 147 of file AbsKalmanFitter.h.

Referenced by AbsKalmanFitter(), getMinIterations(), setMaxIterations(), and setMinIterations().

multipleMeasurementHandling_

eMultipleMeasurementHandling genfit::AbsKalmanFitter::multipleMeasurementHandling_

protected

How to handle if there are multiple MeasurementsOnPlane.

Definition at line 177 of file AbsKalmanFitter.h.

Referenced by getMultipleMeasurementHandling(), and setMultipleMeasurementHandling().

relChi2Change_

double genfit::AbsKalmanFitter::relChi2Change_

protected

@ brief Non-convergence criterion

if the relative chi^2 between two iterations is larger than relChi2Change_, the fit is NOT converged and further iterations will be done, even if the deltaPval_ convergence criterium is met. This is especially useful for fits which have a p-value of almost 0 (possibly due to bad start values), where the p-value from one iteration to the next might not change much. However, a significant change in chi^2 tells us, that the fit might not yet be converged.

Definition at line 167 of file AbsKalmanFitter.h.

Referenced by getRelChi2Change(), and setRelChi2Change().

resetOffDiagonals_

bool genfit::AbsKalmanFitter::resetOffDiagonals_

protected

Reset the off-diagonals to 0 when blowing up the cov.

Definition at line 172 of file AbsKalmanFitter.h.

Referenced by getResetOffDiagonals(), and setResetOffDiagonals().

---

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

• AbsKalmanFitter.h