genfit::FitStatus Class Reference

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

#include <FitStatus.h>

Inheritance diagram for genfit::FitStatus:

Public Member Functions
	FitStatus ()
virtual	~FitStatus ()
virtual FitStatus *	clone () const
bool	isFitted () const
	Has the track been fitted? More...
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? More...
bool	isTrackPruned () const
	Has the track been pruned after the fit? More...
double	getCharge () const
	Get the fitted charge. More...
double	getChi2 () const
	Get chi^2 of the fit. More...
double	getNdf () const
	Get the degrees of freedom of the fit. More...
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? More...
bool	isFitConvergedFully_
	did the fit converge with all TrackPoints? More...
bool	isFitConvergedPartially_
	did the fit converge with a subset of all TrackPoints? More...
int	nFailedPoints_
	Number of failed TrackPoints. More...
bool	trackHasChanged_
	has anything in the Track been changed since the fit? -> fit isn't valid anymore More...
PruneFlags	pruneFlags_
	Prune flags. More...
double	charge_
	fitted charge More...
double	chi2_
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.

Constructor & Destructor Documentation

genfit::FitStatus::FitStatus ( )

inline

Definition at line 84 of file FitStatus.h.

Referenced by clone().

              :
    isFitted_(false), isFitConvergedFully_(false), isFitConvergedPartially_(false), nFailedPoints_(0),
    trackHasChanged_(false), pruneFlags_(), charge_(0), chi2_(-1e99), ndf_(-1e99)
  {;}

virtual genfit::FitStatus::~FitStatus ( )

inlinevirtual

Definition at line 89 of file FitStatus.h.

{};

Member Function Documentation

genfit::FitStatus::ClassDef ( FitStatus  , 3    )

protected

virtual FitStatus* genfit::FitStatus::clone ( ) const

inlinevirtual

Reimplemented in genfit::KalmanFitStatus.

Definition at line 91 of file FitStatus.h.

References FitStatus().

{return new FitStatus(*this);}

double genfit::FitStatus::getCharge ( ) const

inline

Get the fitted charge.

Definition at line 116 of file FitStatus.h.

References charge_.

{return charge_;}

double genfit::FitStatus::getChi2 ( ) const

inline

Get chi^2 of the fit.

Definition at line 118 of file FitStatus.h.

References chi2_.

Referenced by Genfit2Track2PndTrack(), and genfit::KalmanFitStatus::getBackwardChi2().

{return chi2_;}

double genfit::FitStatus::getNdf ( ) const

inline

Get the degrees of freedom of the fit.

Definition at line 120 of file FitStatus.h.

References ndf_.

Referenced by Genfit2Track2PndTrack(), and genfit::KalmanFitStatus::getBackwardNdf().

{return ndf_;}

int genfit::FitStatus::getNFailedPoints ( ) const

inline

Definition at line 110 of file FitStatus.h.

References nFailedPoints_.

{return nFailedPoints_;}

PruneFlags& genfit::FitStatus::getPruneFlags ( )

inline

Definition at line 135 of file FitStatus.h.

References pruneFlags_.

{return pruneFlags_;}

virtual double genfit::FitStatus::getPVal ( ) const

inlinevirtual

Get the p value of the fit.

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

Definition at line 126 of file FitStatus.h.

References chi2_, max(), and ndf_.

Referenced by genfit::KalmanFitStatus::getBackwardPVal().

{return std::max(0.,ROOT::Math::chisquared_cdf_c(chi2_, ndf_));}

bool genfit::FitStatus::hasTrackChanged ( ) const

inline

Has anything in the Track been changed since the fit?

Definition at line 112 of file FitStatus.h.

References trackHasChanged_.

{return trackHasChanged_;}

bool genfit::FitStatus::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.

References isFitConvergedFully_, and isFitConvergedPartially_.

Referenced by Genfit2Track2PndTrack().

                                                     {
    if (inAllPoints) return isFitConvergedFully_; return isFitConvergedPartially_;
  }

bool genfit::FitStatus::isFitConvergedFully ( ) const

inline

Definition at line 108 of file FitStatus.h.

References isFitConvergedFully_.

{return isFitConvergedFully_;}

bool genfit::FitStatus::isFitConvergedPartially ( ) const

inline

Definition at line 109 of file FitStatus.h.

References isFitConvergedPartially_.

{return isFitConvergedPartially_;}

bool genfit::FitStatus::isFitted ( ) const

inline

Has the track been fitted?

Definition at line 94 of file FitStatus.h.

References isFitted_.

{return isFitted_;}

bool genfit::FitStatus::isTrackPruned ( ) const

inline

Has the track been pruned after the fit?

Definition at line 114 of file FitStatus.h.

References genfit::PruneFlags::isPruned(), and pruneFlags_.

{return pruneFlags_.isPruned();}

virtual void genfit::FitStatus::Print ( const Option_t *  = "" ) const

virtual

Reimplemented in genfit::KalmanFitStatus.

Referenced by PndRecoKalmanFit2::Fit().

void genfit::FitStatus::setCharge ( double  charge )

inline

Definition at line 133 of file FitStatus.h.

References charge_.

{charge_ = charge;}

void genfit::FitStatus::setChi2 ( const double &  chi2 )

inline

Definition at line 137 of file FitStatus.h.

References chi2_.

Referenced by genfit::KalmanFitStatus::setBackwardChi2().

{chi2_ = chi2;}

void genfit::FitStatus::setHasTrackChanged ( bool  trackChanged = true )

inline

Definition at line 132 of file FitStatus.h.

References trackHasChanged_.

{trackHasChanged_ = trackChanged;}

void genfit::FitStatus::setIsFitConvergedFully ( bool  fitConverged = true )

inline

Definition at line 129 of file FitStatus.h.

References isFitConvergedFully_.

{isFitConvergedFully_ = fitConverged;}

void genfit::FitStatus::setIsFitConvergedPartially ( bool  fitConverged = true )

inline

Definition at line 130 of file FitStatus.h.

References isFitConvergedPartially_.

{isFitConvergedPartially_ = fitConverged;}

void genfit::FitStatus::setIsFitted ( bool  fitted = true )

inline

Definition at line 128 of file FitStatus.h.

References isFitted_.

{isFitted_ = fitted;}

void genfit::FitStatus::setNdf ( const double &  ndf )

inline

Definition at line 138 of file FitStatus.h.

References ndf_.

Referenced by genfit::KalmanFitStatus::setBackwardNdf().

{ndf_ = ndf;}

void genfit::FitStatus::setNFailedPoints ( int  nFailedPoints )

inline

Definition at line 131 of file FitStatus.h.

References nFailedPoints_.

{nFailedPoints_ = nFailedPoints;}

Member Data Documentation

double genfit::FitStatus::charge_

protected

fitted charge

Definition at line 157 of file FitStatus.h.

Referenced by getCharge(), and setCharge().

double genfit::FitStatus::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 161 of file FitStatus.h.

Referenced by getChi2(), getPVal(), and setChi2().

bool genfit::FitStatus::isFitConvergedFully_

protected

did the fit converge with all TrackPoints?

Definition at line 147 of file FitStatus.h.

Referenced by isFitConverged(), isFitConvergedFully(), and setIsFitConvergedFully().

bool genfit::FitStatus::isFitConvergedPartially_

protected

did the fit converge with a subset of all TrackPoints?

Definition at line 149 of file FitStatus.h.

Referenced by isFitConverged(), isFitConvergedPartially(), and setIsFitConvergedPartially().

bool genfit::FitStatus::isFitted_

protected

has the track been fitted?

Definition at line 145 of file FitStatus.h.

Referenced by isFitted(), and setIsFitted().

double genfit::FitStatus::ndf_

protected

Definition at line 162 of file FitStatus.h.

Referenced by getNdf(), getPVal(), and setNdf().

int genfit::FitStatus::nFailedPoints_

protected

Number of failed TrackPoints.

Definition at line 151 of file FitStatus.h.

Referenced by getNFailedPoints(), and setNFailedPoints().

PruneFlags genfit::FitStatus::pruneFlags_

protected

Prune flags.

Definition at line 155 of file FitStatus.h.

Referenced by getPruneFlags(), and isTrackPruned().

bool genfit::FitStatus::trackHasChanged_

protected

has anything in the Track been changed since the fit? -> fit isn't valid anymore

Definition at line 153 of file FitStatus.h.

Referenced by hasTrackChanged(), and setHasTrackChanged().

---

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

• FitStatus.h