FairRoot/PandaRoot
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
genfit::KalmanFitStatus Class Reference

FitStatus for use with AbsKalmanFitter implementations. More...

#include <KalmanFitStatus.h>

Inheritance diagram for genfit::KalmanFitStatus:
genfit::FitStatus

Public Member Functions

 KalmanFitStatus ()
 
virtual ~KalmanFitStatus ()
 
virtual FitStatus * clone () const
 
unsigned int getNumIterations () const
 
bool isFittedWithDaf () const
 
bool isFittedWithReferenceTrack () const
 
double getTrackLen () const
 
double getForwardChi2 () const
 
double getBackwardChi2 () const
 
double getForwardNdf () const
 
double getBackwardNdf () const
 
double getForwardPVal () const
 
double getBackwardPVal () const
 
void setNumIterations (unsigned int numIterations)
 
void setIsFittedWithDaf (bool fittedWithDaf=true)
 
void setIsFittedWithReferenceTrack (bool fittedWithReferenceTrack=true)
 
void setTrackLen (double trackLen)
 
void setForwardChi2 (double fChi2)
 
void setBackwardChi2 (double bChi2)
 
void setForwardNdf (double fNdf)
 
void setBackwardNdf (double bNdf)
 
virtual void Print (const Option_t *="") 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)
 

Protected Member Functions

 ClassDef (FitStatus, 3)
 

Protected Attributes

unsigned int numIterations_
 
bool fittedWithDaf_
 
bool fittedWithReferenceTrack_
 
double trackLen_
 
double fChi2_
 
double fNdf_
 
double fPval_
 
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

FitStatus for use with AbsKalmanFitter implementations.

Definition at line 36 of file KalmanFitStatus.h.

Constructor & Destructor Documentation

genfit::KalmanFitStatus::KalmanFitStatus ( )
inline

Definition at line 40 of file KalmanFitStatus.h.

Referenced by clone().

40  :
41  FitStatus(), numIterations_(0), fittedWithDaf_(false), fittedWithReferenceTrack_(false),
42  trackLen_(0), fChi2_(-1e99), fNdf_(-1e99), fPval_(-1e99) {;}
virtual genfit::KalmanFitStatus::~KalmanFitStatus ( )
inlinevirtual

Definition at line 44 of file KalmanFitStatus.h.

44 {};

Member Function Documentation

genfit::FitStatus::ClassDef ( FitStatus  ,
3   
)
protectedinherited
virtual FitStatus* genfit::KalmanFitStatus::clone ( ) const
inlinevirtual

Reimplemented from genfit::FitStatus.

Definition at line 46 of file KalmanFitStatus.h.

References KalmanFitStatus().

46 {return new KalmanFitStatus(*this);}
double genfit::KalmanFitStatus::getBackwardChi2 ( ) const
inline

Definition at line 53 of file KalmanFitStatus.h.

References genfit::FitStatus::getChi2().

53 {return FitStatus::getChi2();}
genfit::FitStatus::getChi2
double getChi2() const
Get chi^2 of the fit.
Definition: FitStatus.h:118
double genfit::KalmanFitStatus::getBackwardNdf ( ) const
inline

Definition at line 55 of file KalmanFitStatus.h.

References genfit::FitStatus::getNdf().

55 {return FitStatus::getNdf();}
genfit::FitStatus::getNdf
double getNdf() const
Get the degrees of freedom of the fit.
Definition: FitStatus.h:120
double genfit::KalmanFitStatus::getBackwardPVal ( ) const
inline

Definition at line 58 of file KalmanFitStatus.h.

References genfit::FitStatus::getPVal().

58 {return FitStatus::getPVal(); }
genfit::FitStatus::getPVal
virtual double getPVal() const
Get the p value of the fit.
Definition: FitStatus.h:126
double genfit::FitStatus::getCharge ( ) const
inlineinherited

Get the fitted charge.

Definition at line 116 of file FitStatus.h.

References genfit::FitStatus::charge_.

116 {return charge_;}
genfit::FitStatus::charge_
double charge_
fitted charge
Definition: FitStatus.h:157
double genfit::FitStatus::getChi2 ( ) const
inlineinherited

Get chi^2 of the fit.

Definition at line 118 of file FitStatus.h.

References genfit::FitStatus::chi2_.

Referenced by Genfit2Track2PndTrack(), and getBackwardChi2().

118 {return chi2_;}
double genfit::KalmanFitStatus::getForwardChi2 ( ) const
inline

Definition at line 52 of file KalmanFitStatus.h.

References fChi2_.

52 {return fChi2_;}
double genfit::KalmanFitStatus::getForwardNdf ( ) const
inline

Definition at line 54 of file KalmanFitStatus.h.

References fNdf_.

54 {return fNdf_;}
double genfit::KalmanFitStatus::getForwardPVal ( ) const
inline

Definition at line 57 of file KalmanFitStatus.h.

References fChi2_, fNdf_, and max().

57 {return std::max(0.,ROOT::Math::chisquared_cdf_c(fChi2_, fNdf_));}
max
friend F32vec4 max(const F32vec4 &a, const F32vec4 &b)
Definition: P4_F32vec4.h:26
double genfit::FitStatus::getNdf ( ) const
inlineinherited

Get the degrees of freedom of the fit.

Definition at line 120 of file FitStatus.h.

References genfit::FitStatus::ndf_.

Referenced by Genfit2Track2PndTrack(), and getBackwardNdf().

120 {return ndf_;}
int genfit::FitStatus::getNFailedPoints ( ) const
inlineinherited

Definition at line 110 of file FitStatus.h.

References genfit::FitStatus::nFailedPoints_.

110 {return nFailedPoints_;}
genfit::FitStatus::nFailedPoints_
int nFailedPoints_
Number of failed TrackPoints.
Definition: FitStatus.h:151
unsigned int genfit::KalmanFitStatus::getNumIterations ( ) const
inline

Definition at line 48 of file KalmanFitStatus.h.

References numIterations_.

48 {return numIterations_;}
PruneFlags& genfit::FitStatus::getPruneFlags ( )
inlineinherited

Definition at line 135 of file FitStatus.h.

References genfit::FitStatus::pruneFlags_.

135 {return pruneFlags_;}
genfit::FitStatus::pruneFlags_
PruneFlags pruneFlags_
Prune flags.
Definition: FitStatus.h:155
virtual double genfit::FitStatus::getPVal ( ) const
inlinevirtualinherited

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 genfit::FitStatus::chi2_, max(), and genfit::FitStatus::ndf_.

Referenced by getBackwardPVal().

126 {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:26
double genfit::KalmanFitStatus::getTrackLen ( ) const
inline

Definition at line 51 of file KalmanFitStatus.h.

References trackLen_.

51 {return trackLen_;}
bool genfit::FitStatus::hasTrackChanged ( ) const
inlineinherited

Has anything in the Track been changed since the fit?

Definition at line 112 of file FitStatus.h.

References genfit::FitStatus::trackHasChanged_.

112 {return trackHasChanged_;}
genfit::FitStatus::trackHasChanged_
bool trackHasChanged_
has anything in the Track been changed since the fit? -&gt; fit isn&#39;t valid anymore
Definition: FitStatus.h:153
bool genfit::FitStatus::isFitConverged ( bool  inAllPoints = true) const
inlineinherited

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 genfit::FitStatus::isFitConvergedFully_, and genfit::FitStatus::isFitConvergedPartially_.

Referenced by Genfit2Track2PndTrack().

105  {
106  if (inAllPoints) return isFitConvergedFully_; return isFitConvergedPartially_;
107  }
genfit::FitStatus::isFitConvergedFully_
bool isFitConvergedFully_
did the fit converge with all TrackPoints?
Definition: FitStatus.h:147
genfit::FitStatus::isFitConvergedPartially_
bool isFitConvergedPartially_
did the fit converge with a subset of all TrackPoints?
Definition: FitStatus.h:149
bool genfit::FitStatus::isFitConvergedFully ( ) const
inlineinherited

Definition at line 108 of file FitStatus.h.

References genfit::FitStatus::isFitConvergedFully_.

108 {return isFitConvergedFully_;}
genfit::FitStatus::isFitConvergedFully_
bool isFitConvergedFully_
did the fit converge with all TrackPoints?
Definition: FitStatus.h:147
bool genfit::FitStatus::isFitConvergedPartially ( ) const
inlineinherited

Definition at line 109 of file FitStatus.h.

References genfit::FitStatus::isFitConvergedPartially_.

109 {return isFitConvergedPartially_;}
genfit::FitStatus::isFitConvergedPartially_
bool isFitConvergedPartially_
did the fit converge with a subset of all TrackPoints?
Definition: FitStatus.h:149
bool genfit::FitStatus::isFitted ( ) const
inlineinherited

Has the track been fitted?

Definition at line 94 of file FitStatus.h.

References genfit::FitStatus::isFitted_.

94 {return isFitted_;}
genfit::FitStatus::isFitted_
bool isFitted_
has the track been fitted?
Definition: FitStatus.h:145
bool genfit::KalmanFitStatus::isFittedWithDaf ( ) const
inline

Definition at line 49 of file KalmanFitStatus.h.

References fittedWithDaf_.

49 {return fittedWithDaf_;}
bool genfit::KalmanFitStatus::isFittedWithReferenceTrack ( ) const
inline

Definition at line 50 of file KalmanFitStatus.h.

References fittedWithReferenceTrack_.

50 {return fittedWithReferenceTrack_;}
bool genfit::FitStatus::isTrackPruned ( ) const
inlineinherited

Has the track been pruned after the fit?

Definition at line 114 of file FitStatus.h.

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

114 {return pruneFlags_.isPruned();}
genfit::FitStatus::pruneFlags_
PruneFlags pruneFlags_
Prune flags.
Definition: FitStatus.h:155
genfit::PruneFlags::isPruned
bool isPruned() const
check if any of the flags is set
virtual void genfit::KalmanFitStatus::Print ( const Option_t *  = "") const
virtual

Reimplemented from genfit::FitStatus.

void genfit::KalmanFitStatus::setBackwardChi2 ( double  bChi2)
inline

Definition at line 65 of file KalmanFitStatus.h.

References genfit::FitStatus::setChi2().

65 {FitStatus::setChi2(bChi2);}
genfit::FitStatus::setChi2
void setChi2(const double &chi2)
Definition: FitStatus.h:137
void genfit::KalmanFitStatus::setBackwardNdf ( double  bNdf)
inline

Definition at line 67 of file KalmanFitStatus.h.

References genfit::FitStatus::setNdf().

67 {FitStatus::setNdf(bNdf);}
genfit::FitStatus::setNdf
void setNdf(const double &ndf)
Definition: FitStatus.h:138
void genfit::FitStatus::setCharge ( double  charge)
inlineinherited

Definition at line 133 of file FitStatus.h.

References genfit::FitStatus::charge_.

133 {charge_ = charge;}
genfit::FitStatus::charge_
double charge_
fitted charge
Definition: FitStatus.h:157
void genfit::FitStatus::setChi2 ( const double &  chi2)
inlineinherited

Definition at line 137 of file FitStatus.h.

References genfit::FitStatus::chi2_.

Referenced by setBackwardChi2().

137 {chi2_ = chi2;}
void genfit::KalmanFitStatus::setForwardChi2 ( double  fChi2)
inline

Definition at line 64 of file KalmanFitStatus.h.

References fChi2_.

64 {fChi2_ = fChi2;}
void genfit::KalmanFitStatus::setForwardNdf ( double  fNdf)
inline

Definition at line 66 of file KalmanFitStatus.h.

References fNdf_.

66 {fNdf_ = fNdf;}
void genfit::FitStatus::setHasTrackChanged ( bool  trackChanged = true)
inlineinherited

Definition at line 132 of file FitStatus.h.

References genfit::FitStatus::trackHasChanged_.

132 {trackHasChanged_ = trackChanged;}
genfit::FitStatus::trackHasChanged_
bool trackHasChanged_
has anything in the Track been changed since the fit? -&gt; fit isn&#39;t valid anymore
Definition: FitStatus.h:153
void genfit::FitStatus::setIsFitConvergedFully ( bool  fitConverged = true)
inlineinherited

Definition at line 129 of file FitStatus.h.

References genfit::FitStatus::isFitConvergedFully_.

129 {isFitConvergedFully_ = fitConverged;}
genfit::FitStatus::isFitConvergedFully_
bool isFitConvergedFully_
did the fit converge with all TrackPoints?
Definition: FitStatus.h:147
void genfit::FitStatus::setIsFitConvergedPartially ( bool  fitConverged = true)
inlineinherited

Definition at line 130 of file FitStatus.h.

References genfit::FitStatus::isFitConvergedPartially_.

130 {isFitConvergedPartially_ = fitConverged;}
genfit::FitStatus::isFitConvergedPartially_
bool isFitConvergedPartially_
did the fit converge with a subset of all TrackPoints?
Definition: FitStatus.h:149
void genfit::FitStatus::setIsFitted ( bool  fitted = true)
inlineinherited

Definition at line 128 of file FitStatus.h.

References genfit::FitStatus::isFitted_.

128 {isFitted_ = fitted;}
genfit::FitStatus::isFitted_
bool isFitted_
has the track been fitted?
Definition: FitStatus.h:145
void genfit::KalmanFitStatus::setIsFittedWithDaf ( bool  fittedWithDaf = true)
inline

Definition at line 61 of file KalmanFitStatus.h.

References fittedWithDaf_.

61 {fittedWithDaf_ = fittedWithDaf;}
void genfit::KalmanFitStatus::setIsFittedWithReferenceTrack ( bool  fittedWithReferenceTrack = true)
inline

Definition at line 62 of file KalmanFitStatus.h.

References fittedWithReferenceTrack_.

62 {fittedWithReferenceTrack_ = fittedWithReferenceTrack;}
void genfit::FitStatus::setNdf ( const double &  ndf)
inlineinherited

Definition at line 138 of file FitStatus.h.

References genfit::FitStatus::ndf_.

Referenced by setBackwardNdf().

138 {ndf_ = ndf;}
void genfit::FitStatus::setNFailedPoints ( int  nFailedPoints)
inlineinherited

Definition at line 131 of file FitStatus.h.

References genfit::FitStatus::nFailedPoints_.

131 {nFailedPoints_ = nFailedPoints;}
genfit::FitStatus::nFailedPoints_
int nFailedPoints_
Number of failed TrackPoints.
Definition: FitStatus.h:151
void genfit::KalmanFitStatus::setNumIterations ( unsigned int  numIterations)
inline

Definition at line 60 of file KalmanFitStatus.h.

References numIterations_.

60 {numIterations_ = numIterations;}
void genfit::KalmanFitStatus::setTrackLen ( double  trackLen)
inline

Definition at line 63 of file KalmanFitStatus.h.

References trackLen_.

63 {trackLen_ = trackLen;}

Member Data Documentation

double genfit::FitStatus::charge_
protectedinherited

fitted charge

Definition at line 157 of file FitStatus.h.

Referenced by genfit::FitStatus::getCharge(), and genfit::FitStatus::setCharge().

double genfit::FitStatus::chi2_
protectedinherited

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 genfit::FitStatus::getChi2(), genfit::FitStatus::getPVal(), and genfit::FitStatus::setChi2().

double genfit::KalmanFitStatus::fChi2_
protected

Definition at line 79 of file KalmanFitStatus.h.

Referenced by getForwardChi2(), getForwardPVal(), and setForwardChi2().

bool genfit::KalmanFitStatus::fittedWithDaf_
protected

Definition at line 74 of file KalmanFitStatus.h.

Referenced by isFittedWithDaf(), and setIsFittedWithDaf().

bool genfit::KalmanFitStatus::fittedWithReferenceTrack_
protected

Definition at line 75 of file KalmanFitStatus.h.

Referenced by isFittedWithReferenceTrack(), and setIsFittedWithReferenceTrack().

double genfit::KalmanFitStatus::fNdf_
protected

Definition at line 80 of file KalmanFitStatus.h.

Referenced by getForwardNdf(), getForwardPVal(), and setForwardNdf().

double genfit::KalmanFitStatus::fPval_
protected

Definition at line 81 of file KalmanFitStatus.h.

bool genfit::FitStatus::isFitConvergedFully_
protectedinherited

did the fit converge with all TrackPoints?

Definition at line 147 of file FitStatus.h.

Referenced by genfit::FitStatus::isFitConverged(), genfit::FitStatus::isFitConvergedFully(), and genfit::FitStatus::setIsFitConvergedFully().

bool genfit::FitStatus::isFitConvergedPartially_
protectedinherited

did the fit converge with a subset of all TrackPoints?

Definition at line 149 of file FitStatus.h.

Referenced by genfit::FitStatus::isFitConverged(), genfit::FitStatus::isFitConvergedPartially(), and genfit::FitStatus::setIsFitConvergedPartially().

bool genfit::FitStatus::isFitted_
protectedinherited

has the track been fitted?

Definition at line 145 of file FitStatus.h.

Referenced by genfit::FitStatus::isFitted(), and genfit::FitStatus::setIsFitted().

double genfit::FitStatus::ndf_
protectedinherited

Definition at line 162 of file FitStatus.h.

Referenced by genfit::FitStatus::getNdf(), genfit::FitStatus::getPVal(), and genfit::FitStatus::setNdf().

int genfit::FitStatus::nFailedPoints_
protectedinherited

Number of failed TrackPoints.

Definition at line 151 of file FitStatus.h.

Referenced by genfit::FitStatus::getNFailedPoints(), and genfit::FitStatus::setNFailedPoints().

unsigned int genfit::KalmanFitStatus::numIterations_
protected

Definition at line 73 of file KalmanFitStatus.h.

Referenced by getNumIterations(), and setNumIterations().

PruneFlags genfit::FitStatus::pruneFlags_
protectedinherited

Prune flags.

Definition at line 155 of file FitStatus.h.

Referenced by genfit::FitStatus::getPruneFlags(), and genfit::FitStatus::isTrackPruned().

bool genfit::FitStatus::trackHasChanged_
protectedinherited

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 genfit::FitStatus::hasTrackChanged(), and genfit::FitStatus::setHasTrackChanged().

double genfit::KalmanFitStatus::trackLen_
protected

Definition at line 77 of file KalmanFitStatus.h.

Referenced by getTrackLen(), and setTrackLen().

The documentation for this class was generated from the following file:
Generated on Wed Apr 3 2019 10:03:52 for FairRoot/PandaRoot by   doxygen 1.8.5