FitStatus.h

/* Copyright 2008-2010, Technische Universitaet Muenchen,
   Authors: Christian Hoeppner & Sebastian Neubert & Johannes Rauch & Tobias Schlüter
 
   This file is part of GENFIT.
 
   GENFIT is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
   by the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   GENFIT is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.
 
   You should have received a copy of the GNU Lesser General Public License
   along with GENFIT.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef genfit_FitStatus_h
#define genfit_FitStatus_h
 
#include <Rtypes.h>
#include <Math/ProbFuncMathCore.h>
 
 
namespace genfit {
 
 
struct PruneFlags {
  PruneFlags();
  void reset();
  void setFlags(Option_t* option = "");
  bool hasFlags(Option_t* option = "CFLWRMIU") const;
  bool isPruned() const;
 
  void Print(const Option_t* = "") const;
 
private:
  enum fields { C = 1 << 0,
    F = 1 << 1,
    L = 1 << 2,
    W = 1 << 3,
    R = 1 << 4,
    M = 1 << 5,
    I = 1 << 6,
    U = 1 << 7 };
 
  int value; // bitfield composed from above.  ROOT cannot deal with
       // bitfield notation, so this is done manually.
 
  // No ClassDef here.  Update FitStatus version number when changing this.
};
 
 
class FitStatus {
 
 public:
 
  FitStatus() :
    isFitted_(false), isFitConvergedFully_(false), isFitConvergedPartially_(false), nFailedPoints_(0),
    trackHasChanged_(false), pruneFlags_(), charge_(0), chi2_(-1e99), ndf_(-1e99)
  {;}
 
  virtual ~FitStatus() {};
 
  virtual FitStatus* clone() const {return new FitStatus(*this);}
 
  bool isFitted() const {return isFitted_;}
 
  bool isFitConverged(bool inAllPoints = true) const {
    if (inAllPoints)
        return isFitConvergedFully_;
    return isFitConvergedPartially_;
  }
  bool isFitConvergedFully() const {return isFitConvergedFully_;}
  bool isFitConvergedPartially() const {return isFitConvergedPartially_;}
  int getNFailedPoints() const {return nFailedPoints_;}
  bool hasTrackChanged() const {return trackHasChanged_;}
  bool isTrackPruned() const {return pruneFlags_.isPruned();}
  double getCharge() const {return charge_;}
  double getChi2() const {return chi2_;}
  double getNdf() const {return ndf_;}
  virtual double getPVal() const {return std::max(0.,ROOT::Math::chisquared_cdf_c(chi2_, ndf_));}
 
  void setIsFitted(bool fitted = true) {isFitted_ = fitted;}
  void setIsFitConvergedFully(bool fitConverged = true) {isFitConvergedFully_ = fitConverged;}
  void setIsFitConvergedPartially(bool fitConverged = true) {isFitConvergedPartially_ = fitConverged;}
  void setNFailedPoints(int nFailedPoints) {nFailedPoints_ = nFailedPoints;}
  void setHasTrackChanged(bool trackChanged = true) {trackHasChanged_ = trackChanged;}
  void setCharge(double charge) {charge_ = charge;}
 
  PruneFlags& getPruneFlags() {return pruneFlags_;}
 
  void setChi2(const double& chi2) {chi2_ = chi2;}
  void setNdf(const double& ndf) {ndf_ = ndf;}
 
  virtual void Print(const Option_t* = "") const;
 
 protected:
 
  bool isFitted_;
  bool isFitConvergedFully_;
  bool isFitConvergedPartially_;
  int nFailedPoints_;
  bool trackHasChanged_;
  PruneFlags pruneFlags_;
  double charge_;
 
  double chi2_;
  double ndf_;
 
  ClassDef(FitStatus, 3);
};
 
} /* End of namespace genfit */
#endif // genfit_FitStatus_h