RFitDataBase.hh

Go to the documentation of this file.

//======================================================================
/*! \file RFitDataBase.hh
 *
 *  Include file for class RFitDataBase
 */
//======================================================================

#ifndef R_FIT_BASE_DATA_HH
#define R_FIT_BASE_DATA_HH

#include "RBase.hh"

///! Maximum number of fit parameters
#define RFIT_MAX_PAR        50

/*! Fit options namespace.*/
namespace RFitOptions
{
  ///! Global option for uncertainties normalisation with normalised Chi2.
  static const u_int modeErrNorm = 0x00000001;
}


/*! Fit modes namespace.*/
namespace RFitModes
{
  static const int fitChi2       = 0;   ///< Chi2 minimisation fit
  static const int fitLikelyhood = 1;   ///< Maximum likelyhood fit
}

//======================================================================
/*! \class RFitDataBase
 *
 *  Base data, fit conditions and results (parameters, errors,...) for fits.
 *
 *  The class does not define functions to change fit results, but
 *  it can change fit options, for use in a new fit initialisation.
 */
class RFitDataBase
{
  //------------------------------------------------------------
  /*! \object_doc{RFitDataBase} */
  GObjectV(RFitDataBase);
  //------------------------------------------------------------

  protected:
    UInt_t      fit_options;    ///< Fit options
    Int_t       fit_mode;       ///< Fit mode (Chi2 or Log-likelyhood)

    Int_t       fit_result;     ///< Fit result
    Double_t    fit_chi2;       ///< Chi2
    Int_t       fit_ndf;        ///< Number of degrees of freedom
    Double_t    fit_fcn;        ///< Minimized function value (FCN)
    Double_t    fit_edm;        ///< Estimated distance to minimum
    Double_t    fit_err_def;    ///< Error matrix status

    Int_t       par_number;     ///< Number of fit parameters (total)

    Double_t    par_val[RFIT_MAX_PAR];  ///< Parameters values
    Double_t    par_err[RFIT_MAX_PAR];  ///< Uncertainties values
    bool        par_fix[RFIT_MAX_PAR];  ///< Fix parameters
    Double_t    par_cov[RFIT_MAX_PAR][RFIT_MAX_PAR];  ///< Covariance matrix

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RFitDataBase ( );
    RFitDataBase ( const RFitDataBase & original );

    RFitDataBase & operator = ( const RFitDataBase & original );

    virtual ~RFitDataBase ( );

  //------------------------------------------------------------
    virtual void  Reset ( );

    virtual UInt_t    GetFitOptions ( ) const;    // inline
    virtual Int_t     GetFitMode    ( ) const;    // inline
    virtual Int_t     GetParNumber  ( ) const;    // inline
    virtual Int_t     GetFixNumber  ( ) const;

    virtual Double_t  GetParValue     ( const Int_t p ) const;
    virtual Double_t  GetParError     ( const Int_t p ) const;
    virtual Double_t  GetCovariance   ( const Int_t p, const Int_t q ) const;
    virtual bool      IsFixParameter  ( const Int_t p ) const;

    virtual Int_t     GetFitResult  ( ) const;
    virtual Double_t  GetFitChi2    ( ) const;
    virtual Int_t     GetFitNDF     ( ) const;
    virtual Double_t  GetFitFCN     ( ) const;
    virtual Double_t  GetFitEDM     ( ) const;
    virtual Double_t  GetFitErrDef  ( ) const;

  //------------------------------------------------------------
  protected:
    virtual Int_t     WriteData ( FILE * fp ) const;
    static  Int_t     ReadData  ( FILE * fp, RFitDataBase & fdata );

  public:
    /*! Save fit data to file (see derived classes).
     *  \param  fname   file name*/
    virtual Int_t   SaveFitData ( const string &fname ) const = 0;

    /*! Load fit data from file (see derived classes).
     *  \param  fname   file name*/
    virtual Int_t   LoadFitData ( const string &fname ) = 0;

  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
  public:
    ClassDef(RFitDataBase,0);
};

//----------------------------------------------------------------------
//  Inline functions
#include "icc/RFitDataBase.icc"

//======================================================================
#endif