RFitBase2D.hh

Go to the documentation of this file.

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

#ifndef R_FIT_BASE_2D_HH
#define R_FIT_BASE_2D_HH


#include "RFitData2D.hh"
#include "ROptionString.hh"

#include "Rtypes.h"
#include "TAttLine.h"
#include "TH2.h"
#include "TF2.h"
#include "TVirtualFitter.h"
#include "TPad.h"
#include "TStyle.h"


//======================================================================
/*! \class RFitBase2D
 *
 *  Base class for 2D fit classes.
 *
 *  \note
 *    Variables and functions used by fitting functions are static, which
 *    causes that some of them are defined twice, since they are already
 *    defined in the fit data class.
 *    The fit classes take care of this problem, so that static and non
 *    static variable remain consistant.
 *    These variables have to be static so that external fit functions
 *    can access them (like options, ...).
 */
class RFitBase2D : virtual public RFitData2D
{
  //------------------------------------------------------------
  /*! \object_doc{RFitBase2D} */
  GObjectV(RFitBase2D);
  //------------------------------------------------------------

  protected:

    // données statiques
    static  Double_t  epsilon;        ///< Test du zéro

    // pointeurs statiques sur des données (non statiques) de la classe
    // de base RFitData2D
    static  UInt_t  fit_options;      ///< Options pour le fit (statique pour être vue dans la fonction de fit)
    static  Int_t   fit_mode;         ///< Mode de fit (Chi2 ou Log-likelyhood)
    static  Int_t   par_number;       ///< Nombre de paramètres pour le fit

    static  Double_t  histo_bin_x;      ///< Largeur de bin de l'histogramme (pour calcul avec la surface comme paramètre)
    static  Double_t  histo_bin_y;      ///< Largeur de bin de l'histogramme (pour calcul avec la surface comme paramètre)

    // données variables d'une instance à l'autre
    TH2           * histo_ptr;    ///< Pointeur sur l'histogramme à fitter
    TH2           * herr1_ptr;    ///< Pointeur sur l'histogramme d'erreur négatif
    TH2           * herr2_ptr;    ///< Pointeur sur l'histogramme d'erreur positif
    bool            histo_err;    ///< Indique si l'histo est fitté avec une erreur

#ifndef __MAKECINT__
    string          par_name[RFIT_MAX_PAR];   ///< tableau des noms de paramètres
#endif
    Int_t           ix_min;       ///< Borne inférieure du fit en canaux de l'histogramme
    Int_t           ix_max;       ///< Borne supérieure du fit en canaux de l'histogramme
    Int_t           nx_bin;       ///< Nombre de bins de la zone de fit
    Int_t           iy_min;       ///< Borne inférieure du fit en canaux de l'histogramme
    Int_t           iy_max;       ///< Borne supérieure du fit en canaux de l'histogramme
    Int_t           ny_bin;       ///< Nombre de bins de la zone de fit

    // fonction fittée    TF2           * fct_ptr;      ///< Pointeur sur la fonction de fit

    // attributs de lignes
    static  TAttLine  latt_histo;   ///<  Attributs de lignes pour tracé de l'histogramme
    static  TAttLine  latt_error;   ///<  Attributs de lignes pour tracé de l'erreur
    static  TAttFill  fatt_error;   ///<  Attributs de remplissage pour tracé de l'erreur
    static  TAttLine  latt_fct;     ///<  Attributs de lignes pour tracé de la fonction globale

    static  Double_t  pad_theta;    ///<  Angle de vue pour les tracés 3D (en degrés)
    static  Double_t  pad_phi;      ///<  Angle de vue pour les tracés 3D (en degrés)

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RFitBase2D ( );
    RFitBase2D ( TH2 *hptr, TH2 * herr = NULL );
    RFitBase2D ( TH2 *hptr, const RFitData2D & fit_data );
    RFitBase2D ( TH2 *hptr, TH2 * herr, const RFitData2D & fit_data );

    RFitBase2D ( const RFitBase2D & original );

    virtual ~RFitBase2D ( );

  protected:
    void    ClassInit ( );

  public:
  //------------------------------------------------------------
    static  bool      Zero ( const Double_t val );

    virtual void      SetAngles3D ( const Double_t theta, const Double_t phi );

  //------------------------------------------------------------
  protected:
    // mise en place des histogrammes (fit et erreur)
    virtual bool      SetHisto    ( TH2 * hptr, TH2 * herr = NULL );

  public:
    // initialisation des champs statiques (après changement des options)
    virtual void      Reset    ( );
    virtual void      InitMode ( );

    // options (statiques pour pouvoir être vues dans la fonction de fit)
    virtual void      SetOptions  ( const UInt_t opts );
    virtual void      SetOption   ( const UInt_t opt, const bool b = true );
    static  UInt_t    GetStaticOptions   ( );
    static  bool      GetStaticOption    ( const UInt_t opt );
    static  Int_t     GetStaticParNumber ( );

    // mode de fit
    virtual void      SetFitMode   ( const Int_t mode );
    virtual void      SetFitLimits ( const Double_t x1, const Double_t x2,
                                     const Double_t y1, const Double_t y2 );

    // paramètres de la fonction de fit
    virtual void      SetParValue   ( const Int_t p, const Double_t val );
    virtual string    GetParName    ( const Int_t p ) const;

    virtual void      FixParameter      ( const Int_t p, const bool b = true );

    // access to fit function
    TF2 *             GetFitFunction ( );   // inline

  //------------------------------------------------------------
    // styles de tracé
    static  void      SetFctLineAtt  ( const TAttLine att );
    static  void      SetFctLineAtt  ( const Color_t c, const Style_t s, const Width_t w );

  //------------------------------------------------------------
    // tracés de la fonction

    /*! Indicate that all components of the fit function must be included.*/
    virtual void      SetCalcAll        ( ) = 0;

    /*! Indicate that none of the components of the fit function must be included.*/
    virtual void      SetCalcNone       ( ) = 0;

    /*! Defines the fit function and the parameters.*/
    virtual void      SetFunction       ( ) = 0;

    /*! Scale the function, and adjust parameters according to the scale.
     *  \param  s   scaling factor*/
    virtual void      ScaleFunction     ( const Double_t s ) = 0;
    virtual void      NormaliseFunction ( const Double_t nor = 1. );

    virtual void      DrawHisto     ( const char *opts = "", const Double_t zinf = 0., const Double_t zsup = 0.);
    virtual void      DrawFunction  ( const char *opts = "" );

    virtual void      DrawFctResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawDifResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawFitResult ( TVirtualPad * pad, const ROptionString &opts = "" );

    // création d'histogrammes à partir de la fonction
    virtual void      FillFunctionHisto   ( TH2 *hptr );
    virtual TH2     * GetFunctionHisto    ( const char *name );

    virtual TH2     * GetDifferenceHisto  ( const char *name );
    virtual TH2     * GetSqrtHisto        ( const char *name );
    virtual TH2     * GetSqrtPosHisto     ( const char *name );
    virtual TH2     * GetSqrtNegHisto     ( const char *name );

  //------------------------------------------------------------
    // évaluation de la fonction
    virtual Double_t    Eval  ( const Double_t x, const Double_t y );

    virtual void        GetRandom        ( Double_t &x, Double_t &y );
    virtual TH2       * GetRandomHisto   ( const char *name, const Int_t n );
    virtual void        FillRandomHisto  ( TH2 *hptr, const Int_t n );

  //------------------------------------------------------------
    // fit de la fonction
    virtual void        Preset ( );
    virtual Double_t    Fit    ( const char *opts = "" );

    /*! Fonction qui écrit le résultat de fit dans une chaine de caractères.*/
    virtual string      GetFitText ( ) const = 0;

    virtual bool        PrintFit   ( const string &fname ) const;
    virtual bool        PrintFit   ( FILE *fptr = stdout ) const;

    virtual bool        WriteParam ( const string &fname ) const;
    virtual bool        WriteParam ( FILE *fptr = stdout ) const;

    virtual bool        WriteOutput ( const string &fname ) const;
    virtual bool        WriteOutput ( FILE *fptr = stdout ) const;

    /*! Creation d'une structure de données relatives au fit (voir classes dérivées).*/
    virtual RFitData2D  * CreateFitData ( ) = 0;
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );

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

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

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

    TF2           * fct_ptr;      ///< Pointeur sur la fonction de fit

    // attributs de lignes
    static  TAttLine  latt_histo;   ///<  Attributs de lignes pour tracé de l'histogramme
    static  TAttLine  latt_error;   ///<  Attributs de lignes pour tracé de l'erreur
    static  TAttFill  fatt_error;   ///<  Attributs de remplissage pour tracé de l'erreur
    static  TAttLine  latt_fct;     ///<  Attributs de lignes pour tracé de la fonction globale

    static  Double_t  pad_theta;    ///<  Angle de vue pour les tracés 3D (en degrés)
    static  Double_t  pad_phi;      ///<  Angle de vue pour les tracés 3D (en degrés)

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RFitBase2D ( );
    RFitBase2D ( TH2 *hptr, TH2 * herr = NULL );
    RFitBase2D ( TH2 *hptr, const RFitData2D & fit_data );
    RFitBase2D ( TH2 *hptr, TH2 * herr, const RFitData2D & fit_data );

    RFitBase2D ( const RFitBase2D & original );

    virtual ~RFitBase2D ( );

  protected:
    void    ClassInit ( );

  public:
  //------------------------------------------------------------
    static  bool      Zero ( const Double_t val );

    virtual void      SetAngles3D ( const Double_t theta, const Double_t phi );

  //------------------------------------------------------------
  protected:
    // mise en place des histogrammes (fit et erreur)
    virtual bool      SetHisto    ( TH2 * hptr, TH2 * herr = NULL );

  public:
    // initialisation des champs statiques (après changement des options)
    virtual void      Reset    ( );
    virtual void      InitMode ( );

    // options (statiques pour pouvoir être vues dans la fonction de fit)
    virtual void      SetOptions  ( const UInt_t opts );
    virtual void      SetOption   ( const UInt_t opt, const bool b = true );
    static  UInt_t    GetStaticOptions   ( );
    static  bool      GetStaticOption    ( const UInt_t opt );
    static  Int_t     GetStaticParNumber ( );

    // mode de fit
    virtual void      SetFitMode   ( const Int_t mode );
    virtual void      SetFitLimits ( const Double_t x1, const Double_t x2,
                                     const Double_t y1, const Double_t y2 );

    // paramètres de la fonction de fit
    virtual void      SetParValue   ( const Int_t p, const Double_t val );
    virtual string    GetParName    ( const Int_t p ) const;

    virtual void      FixParameter      ( const Int_t p, const bool b = true );

    // access to fit function
    TF2 *             GetFitFunction ( );   // inline

  //------------------------------------------------------------
    // styles de tracé    static  void      SetFctLineAtt  ( const TAttLine att );
    static  void      SetFctLineAtt  ( const Color_t c, const Style_t s, const Width_t w );

  //------------------------------------------------------------
    // tracés de la fonction

    /*! Indicate that all components of the fit function must be included.*/
    virtual void      SetCalcAll        ( ) = 0;

    /*! Indicate that none of the components of the fit function must be included.*/
    virtual void      SetCalcNone       ( ) = 0;

    /*! Defines the fit function and the parameters.*/
    virtual void      SetFunction       ( ) = 0;

    /*! Scale the function, and adjust parameters according to the scale.
     *  \param  s   scaling factor*/
    virtual void      ScaleFunction     ( const Double_t s ) = 0;
    virtual void      NormaliseFunction ( const Double_t nor = 1. );

    virtual void      DrawHisto     ( const char *opts = "", const Double_t zinf = 0., const Double_t zsup = 0.);
    virtual void      DrawFunction  ( const char *opts = "" );

    virtual void      DrawFctResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawDifResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawFitResult ( TVirtualPad * pad, const ROptionString &opts = "" );

    // création d'histogrammes à partir de la fonction
    virtual void      FillFunctionHisto   ( TH2 *hptr );
    virtual TH2     * GetFunctionHisto    ( const char *name );

    virtual TH2     * GetDifferenceHisto  ( const char *name );
    virtual TH2     * GetSqrtHisto        ( const char *name );
    virtual TH2     * GetSqrtPosHisto     ( const char *name );
    virtual TH2     * GetSqrtNegHisto     ( const char *name );

  //------------------------------------------------------------
    // évaluation de la fonction
    virtual Double_t    Eval  ( const Double_t x, const Double_t y );

    virtual void        GetRandom        ( Double_t &x, Double_t &y );
    virtual TH2       * GetRandomHisto   ( const char *name, const Int_t n );
    virtual void        FillRandomHisto  ( TH2 *hptr, const Int_t n );

  //------------------------------------------------------------
    // fit de la fonction
    virtual void        Preset ( );
    virtual Double_t    Fit    ( const char *opts = "" );

    /*! Fonction qui écrit le résultat de fit dans une chaine de caractères.*/
    virtual string      GetFitText ( ) const = 0;

    virtual bool        PrintFit   ( const string &fname ) const;
    virtual bool        PrintFit   ( FILE *fptr = stdout ) const;

    virtual bool        WriteParam ( const string &fname ) const;
    virtual bool        WriteParam ( FILE *fptr = stdout ) const;

    virtual bool        WriteOutput ( const string &fname ) const;
    virtual bool        WriteOutput ( FILE *fptr = stdout ) const;

    /*! Creation d'une structure de données relatives au fit (voir classes dérivées).*/
    virtual RFitData2D  * CreateFitData ( ) = 0;
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );

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

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

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

    static  void      SetFctLineAtt  ( const TAttLine att );
    static  void      SetFctLineAtt  ( const Color_t c, const Style_t s, const Width_t w );

  //------------------------------------------------------------
    // tracés de la fonction

    /*! Indicate that all components of the fit function must be included.*/
    virtual void      SetCalcAll        ( ) = 0;

    /*! Indicate that none of the components of the fit function must be included.*/
    virtual void      SetCalcNone       ( ) = 0;

    /*! Defines the fit function and the parameters.*/
    virtual void      SetFunction       ( ) = 0;

    /*! Scale the function, and adjust parameters according to the scale.
     *  \param  s   scaling factor*/
    virtual void      ScaleFunction     ( const Double_t s ) = 0;
    virtual void      NormaliseFunction ( const Double_t nor = 1. );

    virtual void      DrawHisto     ( const char *opts = "", const Double_t zinf = 0., const Double_t zsup = 0.);
    virtual void      DrawFunction  ( const char *opts = "" );

    virtual void      DrawFctResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawDifResult ( TVirtualPad * pad, const ROptionString &opts = "" );
    virtual void      DrawFitResult ( TVirtualPad * pad, const ROptionString &opts = "" );

    // création d'histogrammes à partir de la fonction
    virtual void      FillFunctionHisto   ( TH2 *hptr );
    virtual TH2     * GetFunctionHisto    ( const char *name );

    virtual TH2     * GetDifferenceHisto  ( const char *name );
    virtual TH2     * GetSqrtHisto        ( const char *name );
    virtual TH2     * GetSqrtPosHisto     ( const char *name );
    virtual TH2     * GetSqrtNegHisto     ( const char *name );

  //------------------------------------------------------------
    // évaluation de la fonction
    virtual Double_t    Eval  ( const Double_t x, const Double_t y );

    virtual void        GetRandom        ( Double_t &x, Double_t &y );
    virtual TH2       * GetRandomHisto   ( const char *name, const Int_t n );
    virtual void        FillRandomHisto  ( TH2 *hptr, const Int_t n );

  //------------------------------------------------------------
    // fit de la fonction
    virtual void        Preset ( );
    virtual Double_t    Fit    ( const char *opts = "" );

    /*! Fonction qui écrit le résultat de fit dans une chaine de caractères.*/
    virtual string      GetFitText ( ) const = 0;

    virtual bool        PrintFit   ( const string &fname ) const;
    virtual bool        PrintFit   ( FILE *fptr = stdout ) const;

    virtual bool        WriteParam ( const string &fname ) const;
    virtual bool        WriteParam ( FILE *fptr = stdout ) const;

    virtual bool        WriteOutput ( const string &fname ) const;
    virtual bool        WriteOutput ( FILE *fptr = stdout ) const;

    /*! Creation d'une structure de données relatives au fit (voir classes dérivées).*/
    virtual RFitData2D  * CreateFitData ( ) = 0;
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );

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

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

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