genfit::AbsKalmanFitter Class Reference

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

#include <AbsKalmanFitter.h>

Inheritance diagram for genfit::AbsKalmanFitter:

Collaboration 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
eMultipleMeasurementHandling	getMultipleMeasurementHandling () const
virtual void	setMinIterations (unsigned int n)
	Set the minimum number of iterations.
virtual void	setMaxIterations (unsigned int n)
	Set the maximum number of iterations.
void	setDeltaPval (double deltaPval)
	Set Convergence criterion.
void	setRelChi2Change (double relChi2Change)
void	setMultipleMeasurementHandling (eMultipleMeasurementHandling mmh)
	How should multiple measurements be handled?
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.
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=true)
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

Protected Attributes
unsigned int	minIterations_
	Minimum number of iterations to attempt. Forward and backward are counted as one iteration.
unsigned int	maxIterations_
	Maximum number of iterations to attempt. Forward and backward are counted as one iteration.
double	deltaPval_
	Convergence criterion.
double	relChi2Change_
double	blowUpFactor_
	Blow up the covariance of the forward (backward) fit by this factor before seeding the backward (forward) fit.
eMultipleMeasurementHandling	multipleMeasurementHandling_
	How to handle if there are multiple MeasurementsOnPlane.
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 51 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 55 of file AbsKalmanFitter.h.

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

~AbsKalmanFitter()

virtual genfit::AbsKalmanFitter::~AbsKalmanFitter ( )

inlinevirtual

Definition at line 63 of file AbsKalmanFitter.h.

{;}

Member Function Documentation

canIgnoreWeights()

bool AbsKalmanFitter::canIgnoreWeights

(

)

const

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

Definition at line 256 of file AbsKalmanFitter.cc.

                                             {
  switch (multipleMeasurementHandling_) {
    case unweightedAverage :
    case unweightedClosestToReference :
    case unweightedClosestToPrediction :
    case unweightedClosestToReferenceWire :
    case unweightedClosestToPredictionWire :
      return true;
 
    case weightedAverage :
    case weightedClosestToReference :
    case weightedClosestToPrediction :
    case weightedClosestToReferenceWire :
    case weightedClosestToPredictionWire :
      return false;
 
    default:
    {
      Exception e("AbsKalmanFitter::canIgnoreWeights: choice not valid.", __LINE__,__FILE__);
      e.setFatal();
      throw e;
    }
  }
}

getChiSqu()

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

Definition at line 84 of file AbsKalmanFitter.cc.

                                                                                              {
  double bChi2(0), fChi2(0), bNdf(0), fNdf(0);
 
  getChiSquNdf(tr, rep, bChi2, fChi2, bNdf, fNdf);
 
  if (direction < 0)
    return bChi2;
  return fChi2;
}

getChiSquNdf()

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

Definition at line 40 of file AbsKalmanFitter.cc.

                                       {
 
  bChi2 = 0;
  fChi2 = 0;
  bNdf = -1. * rep->getDim();
  fNdf = -1. * rep->getDim();
 
  const std::vector<TrackPoint*>& pointsWM = tr->getPointsWithMeasurement();
  for (std::vector<TrackPoint*>::const_iterator tpIter = pointsWM.begin(), endIter = pointsWM.end(); tpIter != endIter; ++tpIter) {
    if (! (*tpIter)->hasFitterInfo(rep))
      continue;
 
    AbsFitterInfo* afi = (*tpIter)->getFitterInfo(rep);
    KalmanFitterInfo* fi = dynamic_cast<KalmanFitterInfo*>(afi);
    if (!fi) {
      Exception exc("AbsKalmanFitter::getChiSqu(): fitterInfo is not a KalmanFitterInfo", __LINE__,__FILE__);
      throw exc;
    }
 
    KalmanFittedStateOnPlane* fup = fi->getForwardUpdate();
    KalmanFittedStateOnPlane* bup = fi->getBackwardUpdate();
 
    if (fup == NULL || bup == NULL) {
      Exception exc("AbsKalmanFitter::getChiSqu(): fup == NULL || bup == NULL", __LINE__,__FILE__);
      throw exc;
    }
 
    bChi2 += bup->getChiSquareIncrement();
    fChi2 += fup->getChiSquareIncrement();
 
    bNdf += bup->getNdf();
    fNdf += fup->getNdf();
  }
 
  if (bNdf < 0)
    bNdf = 0;
 
  if (fNdf < 0)
    fNdf = 0;
}

getMeasurements()

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

protected

get the measurementsOnPlane taking the multipleMeasurementHandling_ into account

Definition at line 177 of file AbsKalmanFitter.cc.

                                                                                                                                            {
 
  switch (multipleMeasurementHandling_) {
    case weightedAverage :
    case unweightedAverage :
      return fi->getMeasurementsOnPlane();
 
    case weightedClosestToReference :
    case unweightedClosestToReference :
    {
      if (!fi->hasReferenceState()) {
        Exception e("AbsKalmanFitter::getMeasurement: no ReferenceState.", __LINE__,__FILE__);
        e.setFatal();
        throw e;
      }
      std::vector<MeasurementOnPlane *> retVal;
      retVal.push_back(fi->getClosestMeasurementOnPlane(fi->getReferenceState()));
      return retVal;
    }
 
    case weightedClosestToPrediction :
    case unweightedClosestToPrediction :
    {
      if (!fi->hasPrediction(direction)) {
        Exception e("AbsKalmanFitter::getMeasurement: no prediction.", __LINE__,__FILE__);
        e.setFatal();
        throw e;
      }
      std::vector<MeasurementOnPlane *> retVal;
      retVal.push_back(fi->getClosestMeasurementOnPlane(fi->getPrediction(direction)));
      return retVal;
    }
 
 
    case weightedClosestToReferenceWire :
    case unweightedClosestToReferenceWire :
    {
      if (tp->getNumRawMeasurements() == 1 && dynamic_cast<WireMeasurement*>(tp->getRawMeasurement()) != NULL) {
        if (!fi->hasReferenceState()) {
          Exception e("AbsKalmanFitter::getMeasurement: no ReferenceState.", __LINE__,__FILE__);
          e.setFatal();
          throw e;
        }
        std::vector<MeasurementOnPlane *> retVal;
        retVal.push_back(fi->getClosestMeasurementOnPlane(fi->getReferenceState()));
        return retVal;
      }
      else
        return fi->getMeasurementsOnPlane();
    }
 
    case weightedClosestToPredictionWire :
    case unweightedClosestToPredictionWire :
    {
      if (tp->getNumRawMeasurements() == 1 && dynamic_cast<WireMeasurement*>(tp->getRawMeasurement()) != NULL) {
        if (!fi->hasPrediction(direction)) {
          Exception e("AbsKalmanFitter::getMeasurement: no prediction.", __LINE__,__FILE__);
          e.setFatal();
          throw e;
        }
        std::vector<MeasurementOnPlane *> retVal;
        retVal.push_back(fi->getClosestMeasurementOnPlane(fi->getPrediction(direction)));
        return retVal;
      }
      else
        return fi->getMeasurementsOnPlane();
    }
 
 
    default:
    {
      Exception e("AbsKalmanFitter::getMeasurement: choice not valid.", __LINE__,__FILE__);
      e.setFatal();
      throw e;
    }
  }
}

getMultipleMeasurementHandling()

eMultipleMeasurementHandling genfit::AbsKalmanFitter::getMultipleMeasurementHandling ( ) const

inline

Definition at line 72 of file AbsKalmanFitter.h.

{return multipleMeasurementHandling_;}

getNdf()

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

Definition at line 94 of file AbsKalmanFitter.cc.

                                                                                           {
  double bChi2(0), fChi2(0), bNdf(0), fNdf(0);
 
  getChiSquNdf(tr, rep, bChi2, fChi2, bNdf, fNdf);
 
  if (direction < 0)
    return bNdf;
  return fNdf;
}

getPVal()

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

Definition at line 114 of file AbsKalmanFitter.cc.

                                                                                            {
  double bChi2(0), fChi2(0), bNdf(0), fNdf(0);
 
  getChiSquNdf(tr, rep, bChi2, fChi2, bNdf, fNdf);
 
  if (direction < 0)
    return ROOT::Math::chisquared_cdf_c(bChi2, bNdf);
  return ROOT::Math::chisquared_cdf_c(fChi2, fNdf);
}

getRedChiSqu()

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

Definition at line 104 of file AbsKalmanFitter.cc.

                                                                                                 {
  double bChi2(0), fChi2(0), bNdf(0), fNdf(0);
 
  getChiSquNdf(tr, rep, bChi2, fChi2, bNdf, fNdf);
 
  if (direction < 0)
    return bChi2/bNdf;
  return fChi2/fNdf;
}

isTrackFitted()

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

Definition at line 147 of file AbsKalmanFitter.cc.

                                                                                 {
  if (! tr->getFitStatus(rep)->isFitted())
    return false;
 
  // in depth check
 
  const std::vector< TrackPoint* >& points = tr->getPointsWithMeasurement();
 
  if (points.size() == 0)
    return true;
 
  for (std::vector<TrackPoint*>::const_iterator pIt = points.begin(), pEnd = points.end(); pIt != pEnd; ++pIt) {
    KalmanFitterInfo* fi = dynamic_cast<KalmanFitterInfo*>((*pIt)->getFitterInfo(rep));
    if (!fi)
      return false;
 
    if (!(fi->checkConsistency()))
      return false;
 
    if (!(fi->hasForwardUpdate()))
      return false;
 
    if (!(fi->hasBackwardUpdate()))
      return false;
  }
 
  return true;
}

isTrackPrepared()

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

Definition at line 125 of file AbsKalmanFitter.cc.

                                                                                   {
  const std::vector<TrackPoint*>& points = tr->getPointsWithMeasurement();
 
  if (points.size() == 0)
    return true;
 
  for (std::vector<TrackPoint*>::const_iterator pIt = points.begin(), pEnd = points.end(); pIt != pEnd; ++pIt) {
    KalmanFitterInfo* fi = dynamic_cast<KalmanFitterInfo*>((*pIt)->getFitterInfo(rep));
 
    if (!fi)
      continue;
 
    if (!(fi->checkConsistency()))
      return false;
 
    if (!(fi->hasReferenceState()))
      return false;
  }
 
  return true;
}

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 85 of file AbsKalmanFitter.h.

{deltaPval_ = deltaPval;}

setMaxFailedHits()

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

inlinevirtual

Reimplemented in genfit::DAF.

Definition at line 101 of file AbsKalmanFitter.h.

{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 77 of file AbsKalmanFitter.h.

{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 75 of file AbsKalmanFitter.h.

{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 99 of file AbsKalmanFitter.h.

{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 96 of file AbsKalmanFitter.h.

{relChi2Change_ = relChi2Change;}

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 137 of file AbsKalmanFitter.h.

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 125 of file AbsKalmanFitter.h.

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 144 of file AbsKalmanFitter.h.

maxIterations_

unsigned int genfit::AbsKalmanFitter::maxIterations_

protected

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

Definition at line 118 of file AbsKalmanFitter.h.

minIterations_

unsigned int genfit::AbsKalmanFitter::minIterations_

protected

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

Definition at line 115 of file AbsKalmanFitter.h.

multipleMeasurementHandling_

eMultipleMeasurementHandling genfit::AbsKalmanFitter::multipleMeasurementHandling_

protected

How to handle if there are multiple MeasurementsOnPlane.

Definition at line 140 of file AbsKalmanFitter.h.

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 135 of file AbsKalmanFitter.h.

---

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

• genfit/fitters/include/AbsKalmanFitter.h
• genfit/fitters/src/AbsKalmanFitter.cc