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 82 of file FitStatus.h.

Constructor & Destructor Documentation

◆ FitStatus()

genfit::FitStatus::FitStatus ( )

inline

Definition at line 85 of file FitStatus.h.

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

◆ ~FitStatus()

virtual genfit::FitStatus::~FitStatus ( )

inlinevirtual

Definition at line 92 of file FitStatus.h.

92 {};

Member Function Documentation

◆ ClassDef()

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

protected

◆ clone()

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

inlinevirtual

Reimplemented in genfit::KalmanFitStatus.

Definition at line 94 of file FitStatus.h.

94 { return new FitStatus(*this); }

genfit::FitStatus::FitStatus

FitStatus()

Definition: FitStatus.h:85

◆ getCharge()

double genfit::FitStatus::getCharge ( ) const

inline

Get the fitted charge.

Definition at line 122 of file FitStatus.h.

122 { return charge_; }

genfit::FitStatus::charge_

double charge_

fitted charge

Definition: FitStatus.h:162

◆ getChi2()

double genfit::FitStatus::getChi2 ( ) const

inline

Get chi^2 of the fit.

Definition at line 124 of file FitStatus.h.

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

124 { return chi2_; }

genfit::FitStatus::chi2_

double chi2_

Definition: FitStatus.h:166

◆ getNdf()

double genfit::FitStatus::getNdf ( ) const

inline

Get the degrees of freedom of the fit.

Definition at line 126 of file FitStatus.h.

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

126 { return ndf_; }

genfit::FitStatus::ndf_

double ndf_

Definition: FitStatus.h:167

◆ getNFailedPoints()

int genfit::FitStatus::getNFailedPoints ( ) const

inline

Definition at line 116 of file FitStatus.h.

116 { return nFailedPoints_; }

genfit::FitStatus::nFailedPoints_

int nFailedPoints_

Number of failed TrackPoints.

Definition: FitStatus.h:156

◆ getPruneFlags()

PruneFlags& genfit::FitStatus::getPruneFlags ( )

inline

Definition at line 141 of file FitStatus.h.

141 { return pruneFlags_; }

genfit::FitStatus::pruneFlags_

PruneFlags pruneFlags_

Prune flags.

Definition: FitStatus.h:160

◆ getPVal()

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 132 of file FitStatus.h.

References max().

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

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

max

friend F32vec4 max(const F32vec4 &a, const F32vec4 &b)

Definition: P4_F32vec4.h:37

genfit::FitStatus::ndf_

double ndf_

Definition: FitStatus.h:167

genfit::FitStatus::chi2_

double chi2_

Definition: FitStatus.h:166

◆ hasTrackChanged()

bool genfit::FitStatus::hasTrackChanged ( ) const

inline

Has anything in the Track been changed since the fit?

Definition at line 118 of file FitStatus.h.

118 { return trackHasChanged_; }

genfit::FitStatus::trackHasChanged_

bool trackHasChanged_

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

Definition: FitStatus.h:158

◆ isFitConverged()

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 108 of file FitStatus.h.

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

◆ isFitConvergedFully()

bool genfit::FitStatus::isFitConvergedFully ( ) const

inline

Definition at line 114 of file FitStatus.h.

114 { return isFitConvergedFully_; }

genfit::FitStatus::isFitConvergedFully_

bool isFitConvergedFully_

did the fit converge with all TrackPoints?

Definition: FitStatus.h:152

◆ isFitConvergedPartially()

bool genfit::FitStatus::isFitConvergedPartially ( ) const

inline

Definition at line 115 of file FitStatus.h.

115 { return isFitConvergedPartially_; }

genfit::FitStatus::isFitConvergedPartially_

bool isFitConvergedPartially_

did the fit converge with a subset of all TrackPoints?

Definition: FitStatus.h:154

◆ isFitted()

bool genfit::FitStatus::isFitted ( ) const

inline

Has the track been fitted?

Definition at line 97 of file FitStatus.h.

97 { return isFitted_; }

genfit::FitStatus::isFitted_

bool isFitted_

has the track been fitted?

Definition: FitStatus.h:150

◆ isTrackPruned()

bool genfit::FitStatus::isTrackPruned ( ) const

inline

Has the track been pruned after the fit?

Definition at line 120 of file FitStatus.h.

120 { return pruneFlags_.isPruned(); }

genfit::PruneFlags::isPruned

bool isPruned() const

check if any of the flags is set

genfit::FitStatus::pruneFlags_

PruneFlags pruneFlags_

Prune flags.

Definition: FitStatus.h:160

◆ Print()

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

virtual

Reimplemented in genfit::KalmanFitStatus.

◆ setCharge()

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

inline

Definition at line 139 of file FitStatus.h.

139 { charge_ = charge; }

genfit::FitStatus::charge_

double charge_

fitted charge

Definition: FitStatus.h:162

◆ setChi2()

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

inline

Definition at line 143 of file FitStatus.h.

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

143 { chi2_ = chi2; }

genfit::FitStatus::chi2_

double chi2_

Definition: FitStatus.h:166

◆ setHasTrackChanged()

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

inline

Definition at line 138 of file FitStatus.h.

138 { trackHasChanged_ = trackChanged; }

genfit::FitStatus::trackHasChanged_

bool trackHasChanged_

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

Definition: FitStatus.h:158

◆ setIsFitConvergedFully()

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

inline

Definition at line 135 of file FitStatus.h.

135 { isFitConvergedFully_ = fitConverged; }

genfit::FitStatus::isFitConvergedFully_

bool isFitConvergedFully_

did the fit converge with all TrackPoints?

Definition: FitStatus.h:152

◆ setIsFitConvergedPartially()

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

inline

Definition at line 136 of file FitStatus.h.

136 { isFitConvergedPartially_ = fitConverged; }

genfit::FitStatus::isFitConvergedPartially_

bool isFitConvergedPartially_

did the fit converge with a subset of all TrackPoints?

Definition: FitStatus.h:154

◆ setIsFitted()

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

inline

Definition at line 134 of file FitStatus.h.

134 { isFitted_ = fitted; }

genfit::FitStatus::isFitted_

bool isFitted_

has the track been fitted?

Definition: FitStatus.h:150

◆ setNdf()

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

inline

Definition at line 144 of file FitStatus.h.

References genfit::PruneFlags::Print().

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

144 { ndf_ = ndf; }

genfit::FitStatus::ndf_

double ndf_

Definition: FitStatus.h:167

◆ setNFailedPoints()

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

inline

Definition at line 137 of file FitStatus.h.

137 { nFailedPoints_ = nFailedPoints; }

genfit::FitStatus::nFailedPoints_

int nFailedPoints_

Number of failed TrackPoints.

Definition: FitStatus.h:156

Member Data Documentation

◆ charge_

double genfit::FitStatus::charge_

protected

fitted charge

Definition at line 162 of file FitStatus.h.

◆ chi2_

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 166 of file FitStatus.h.

◆ isFitConvergedFully_

bool genfit::FitStatus::isFitConvergedFully_

protected

did the fit converge with all TrackPoints?

Definition at line 152 of file FitStatus.h.

◆ isFitConvergedPartially_

bool genfit::FitStatus::isFitConvergedPartially_

protected

did the fit converge with a subset of all TrackPoints?

Definition at line 154 of file FitStatus.h.

◆ isFitted_

bool genfit::FitStatus::isFitted_

protected

has the track been fitted?

Definition at line 150 of file FitStatus.h.

◆ ndf_

double genfit::FitStatus::ndf_

protected

Definition at line 167 of file FitStatus.h.

◆ nFailedPoints_

int genfit::FitStatus::nFailedPoints_

protected

Number of failed TrackPoints.

Definition at line 156 of file FitStatus.h.

◆ pruneFlags_

PruneFlags genfit::FitStatus::pruneFlags_

protected

Prune flags.

Definition at line 160 of file FitStatus.h.

◆ trackHasChanged_

bool genfit::FitStatus::trackHasChanged_

protected

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

Definition at line 158 of file FitStatus.h.

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

FitStatus.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FitStatus()

◆ ~FitStatus()

Member Function Documentation

◆ ClassDef()

◆ clone()

◆ getCharge()

◆ getChi2()

◆ getNdf()

◆ getNFailedPoints()

◆ getPruneFlags()

◆ getPVal()

◆ hasTrackChanged()

◆ isFitConverged()

◆ isFitConvergedFully()

◆ isFitConvergedPartially()

◆ isFitted()

◆ isTrackPruned()

◆ Print()

◆ setCharge()

◆ setChi2()

◆ setHasTrackChanged()

◆ setIsFitConvergedFully()

◆ setIsFitConvergedPartially()

◆ setIsFitted()

◆ setNdf()

◆ setNFailedPoints()

Member Data Documentation

◆ charge_

◆ chi2_

◆ isFitConvergedFully_

◆ isFitConvergedPartially_

◆ isFitted_

◆ ndf_

◆ nFailedPoints_

◆ pruneFlags_

◆ trackHasChanged_