Belle II Software  release-08-01-10
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FitStatus Class Reference

Class where important numbers and properties of a fit can be stored. More...

#include <FitStatus.h>

Inheritance diagram for FitStatus:
Inheritance graph
[legend]
Collaboration diagram for FitStatus:
Collaboration graph
[legend]

Public Member Functions

virtual FitStatus * clone () const
 
bool isFitted () const
 Has the track been fitted?
 
bool isFitConverged (bool inAllPoints=true) const
 Did the fit converge (in all Points or only partially)? More...
 
bool isFitConvergedFully () const
 
bool isFitConvergedPartially () const
 
int getNFailedPoints () const
 
bool hasTrackChanged () const
 Has anything in the Track been changed since the fit?
 
bool isTrackPruned () const
 Has the track been pruned after the fit?
 
double getCharge () const
 Get the fitted charge.
 
double getChi2 () const
 Get chi^2 of the fit.
 
double getNdf () const
 Get the degrees of freedom of the fit.
 
virtual double getPVal () const
 Get the p value of the fit. More...
 
void setIsFitted (bool fitted=true)
 
void setIsFitConvergedFully (bool fitConverged=true)
 
void setIsFitConvergedPartially (bool fitConverged=true)
 
void setNFailedPoints (int nFailedPoints)
 
void setHasTrackChanged (bool trackChanged=true)
 
void setCharge (double charge)
 
PruneFlags & getPruneFlags ()
 
void setChi2 (const double &chi2)
 
void setNdf (const double &ndf)
 
virtual void Print (const Option_t *="") const
 

Protected Member Functions

 ClassDef (FitStatus, 3)
 

Protected Attributes

bool isFitted_
 has the track been fitted?
 
bool isFitConvergedFully_
 did the fit converge with all TrackPoints?
 
bool isFitConvergedPartially_
 did the fit converge with a subset of all TrackPoints?
 
int nFailedPoints_
 Number of failed TrackPoints.
 
bool trackHasChanged_
 has anything in the Track been changed since the fit? -> fit isn't valid anymore
 
PruneFlags pruneFlags_
 Prune flags.
 
double charge_
 fitted charge
 
double chi2_
 These are provided for the sake of the fitter, and their interpretation may vary. More...
 
double ndf_
 

Detailed Description

Class where important numbers and properties of a fit can be stored.

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

Definition at line 80 of file FitStatus.h.

Member Function Documentation

◆ getPVal()

virtual double getPVal ( ) const
inlinevirtual

Get the p value of the fit.

Virtual, because the fitter may use a different probability distribution.

Definition at line 128 of file FitStatus.h.

128 {return std::max(0.,ROOT::Math::chisquared_cdf_c(chi2_, ndf_));}
genfit::FitStatus::chi2_
double chi2_
These are provided for the sake of the fitter, and their interpretation may vary.
Definition: FitStatus.h:163

◆ isFitConverged()

bool isFitConverged ( bool  inAllPoints = true) const
inline

Did the fit converge (in all Points or only partially)?

Per default, this function will only be true, if all TrackPoints (with measurements) have been used in the fit, and the fit has converged.

If one or more TrackPoints have been skipped (e.g. plane could not be constructed or extrapolation to plane failed), but the fit otherwise met the convergence criteria, isFitConverged(false) will return true.

Definition at line 105 of file FitStatus.h.

Member Data Documentation

◆ chi2_

double chi2_
protected

These are provided for the sake of the fitter, and their interpretation may vary.

For the Kalman-derived fitters in particular, this corresponds to the backwards fit.

Definition at line 163 of file FitStatus.h.

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