RFitGaus2D.hh

Go to the documentation of this file.

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

#ifndef R_FIT_GAUS_2D_HH
#define R_FIT_GAUS_2D_HH

#include "RFitBase2D.hh"
#include "RFitDataGaus2D.hh"

#include "RGauss2DFunctions.hh"

#include "TEllipse.h"

// Fit function.
extern Double_t RFitGaus2DFunction ( Double_t *x, Double_t *p );

extern  const char  *rGaus2DBgName[];

// pour les options de fit communnes au gaussiennes 2D et pics 1D
#include "RFitPeak.hh"

// 2D Gauss fit options added to RFitOptions namespace
namespace RFitOptions
{
  /*! Les paramètres sont SigA, SigB (largeur selon les axes principaux)
   *  et l'angle de rotation, au lieu des largeurs selon les axes X et Y
   *  et le coefficient de corrélation.
   */
  static const u_int  modeTheta       = 0x00000020;

  /*! Les coefficients de corrélation ou angles de rotation sont communs
   *  à tous les pics.
   */
  static const u_int  commonCorrel    = 0x00000200;
}


//======================================================================
/*! \class RFitGaus2D
 *
 *  Voir les remarques générales de la classe de base RFitBase2D.
 *
 *  Cette classe permet de fitter des gaussiennes 2D dans un histogramme 2D.
 *  Pour chaque gaussienne, on définit 6 paramètres:
 *  - le facteur d'échelle, qui est soit l'amplitude, soit le nombre de coups
 *    dans la gaussienne
 *  - les valeurs en X et Y du centre
 *  - les paramètres de largeur et corrélation: soit les largeurs en X et Y et
 *    le coefficient de corrélation (SigX, SigY, r), soit les largeurs selon
 *    les axes principaux A et B et l'angle de rotation (SigA, SigB, Theta).
 *
 *  Fonction de fit avec les paramètres d'une ellipse droite avec angle de
 *  rotation:
 *
 *  \image html equations_1.gif
 *
 *  \image html equations_2.gif
 *
 *  Fonction de fit avec les paramètres de largeur X et Y et le coefficeint
 *  de corrélation:
 *
 *  \image html equations_3.gif
 *
 *
 *  Paramètres relatifs:
 *
 *  Les paramètres des composantes gaussiennes peuvent être définis
 *  relativement aux valeurs d'une autre composante (de référence).
 *  Le numéro de la composante de référence doit être inférieur à celui
 *  de la composante considérée.
 *
 *
 *
 *  Les options de fit sont définies dans l'espace de nom RFitOptions, et les
 *  modes de fit (minimisation de chi2, maximum de vraisemblance) sont
 *  définis dans l'espace de nom RFitModes.
 *
 *
 *  Modes de fit:
 *    - fitChi2 : minimisation de chi2
 *    - fitLikelyhood : maximum de vraisemblance
 *
 *  Options pour le fit (options générales):
 *    - modeErrNorm :   les erreurs obtenues sur les paramètres sont
 *                      renormalisées pour obtenir un Chi2 de 1.
 *
 *  Options pour le fit (options spécifiques):
 *    - modeCounts :    le paramètre utilisé pour la constante de normalisation
 *                      du pic est le nombre de coups dans le pics, au lieu de l'amplitude.
 *    - modeTheta :
 *    - commonSigma :   les paramètres sigma sont communs à tous les pics
 *    - commonCorrel :  le paramètre de correlation est commun à tous les pics
 *
 *  Types de fond:
 *    - bgNone:     pas de fond
 *    - bgConst:    fond constant
 *    - bgLinX:     fond linéaire en X de la forme P0 + P1*x
 *    - bgLinY:     fond linéaire en Y de la forme P0 + P1*y
 *    - bgLinXY:    fond linéaire en X et Y de la forme P0 + P1*x + P2*y
 *    - bgExpX:     fond exponentiel en X de la forme exp(P0 + P1*x)
 *    - bgExpY:     fond exponentiel en Y de la forme exp(P0 + P1*y)
 *    - bgExpXY:    fond exponentiel en X et Y de la forme exp(P0 + P1*x + P2*y)
 *
 */
class RFitGaus2D : virtual public RFitDataGaus2D, virtual public RFitBase2D
{
  //------------------------------------------------------------
  /*! \object_doc{RFitGaus2D} */
  GObject(RFitGaus2D);
  //------------------------------------------------------------

  friend Double_t RFitGaus2DFunction (Double_t *, Double_t *);

  ///! Background types identifiers
  enum BgType
  {
    bgNone    = 0,
    bgConst   = 1,
    bgLinX    = 2,
    bgLinY    = 3,
    bgLinXY   = 4,
    bgExpX    = 5,
    bgExpY    = 6,
    bgExpXY   = 7
  };

  protected:

    // données statiques
#ifndef __MAKECINT__

    static  UInt_t  bg_type;      ///< Type de fond (statique pour être vue dans la fonction de fit)
    static  UInt_t  bg_par_number[RGAUS2D_BG_MAX];  ///< Table du nombre de paramètres selon le type de fond

    static  Int_t   comp_number;  ///< Nombre de gaussiennes à fitter

    static  Int_t   index_bg[RGAUS2D_MAX_BG_PAR]; ///< Index des paramètres de fond dans la table des paramètres
    static  Int_t   index_fact [RGAUS2D_MAX];     ///< Index des facteurs de normalisation (amplitude ou surface) dans la table des paramètres
    static  Int_t   index_ctrx [RGAUS2D_MAX];     ///< Index des centres en X dans la table des paramètres
    static  Int_t   index_ctry [RGAUS2D_MAX];     ///< Index des centres en Y dans la table des paramètres
    static  Int_t   index_sig1 [RGAUS2D_MAX];     ///< Index des sigma (X ou A) dans la table des paramètres
    static  Int_t   index_sig2 [RGAUS2D_MAX];     ///< Index des sigma (Y ou B) dans la table des paramètres
    static  Int_t   index_corr [RGAUS2D_MAX];     ///< Index du paramètre de corrélation (ou angle de rotation)

    static  Int_t   rel_ctr    [RGAUS2D_MAX];     ///< Tableau des positions relatives des centres
    static  Int_t   rel_fact   [RGAUS2D_MAX];     ///< Tableau des valeurs relatives des constantes (amplitude/surface)
    static  Int_t   rel_sig    [RGAUS2D_MAX];     ///< Tableau des valeurs relatives des sigma

    static  bool    calc_comp  [RGAUS2D_MAX];     ///< Indique les composantes gaussiennes à calculer
    static  bool    calc_bg;                      ///< Indique s'il faut calculer le fond
#endif


    Double_t  xbg1;   ///< Point pour pré-calcul du fond
    Double_t  ybg1;   ///< Point pour pré-calcul du fond
    Double_t  xbg2;   ///< Point pour pré-calcul du fond
    Double_t  ybg2;   ///< Point pour pré-calcul du fond
    Double_t  xbg3;   ///< Point pour pré-calcul du fond
    Double_t  ybg3;   ///< Point pour pré-calcul du fond

    // attributs de lignes
    static  TAttLine  latt_1sig;    ///<  Attributs de lignes pour tracé des ellipses à 1 sigma
    static  TAttLine  latt_2sig;    ///<  Attributs de lignes pour tracé des ellipses à 2 sigma

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

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

    virtual ~RFitGaus2D ( );

  //------------------------------------------------------------
  // surcharge des fonctions de la classe de base
    virtual void      InitMode ( );

    virtual void      SetFitLimits ( const Double_t x1, const Double_t x2,
                                     const Double_t y1, const Double_t y2 );

  //------------------------------------------------------------
    virtual void      SetComponentNumber        ( const Int_t num );
    static  Int_t     GetStaticComponentNumber  ( );

    // type de fond (statiques pour pouvoir être vues dans la fonction de fit)
    virtual void      SetBgType             ( const Int_t bg );
    static  Int_t     GetStaticBgType       ( );
    static  Int_t     GetStaticBgParNumber  ( );
    static  Int_t     GetBgParNumber        ( const Int_t bg );

    /*! Redefinition of RFitDataDecay function, to avoid compilation
     *  warning due to -Woverloaded-virtual option.*/
    virtual Int_t     GetBgParNumber ( ) const
      { return (GetStaticBgParNumber()); }

    // index des paramètres selon leur type
    virtual Int_t     GetBgParIndex      ( const Int_t p );
    virtual Int_t     GetFactorParIndex  ( const Int_t pk );
    virtual Int_t     GetCenterXParIndex ( const Int_t pk );
    virtual Int_t     GetCenterYParIndex ( const Int_t pk );
    virtual Int_t     GetSigma1ParIndex  ( const Int_t pk );
    virtual Int_t     GetSigma2ParIndex  ( const Int_t pk );
    virtual Int_t     GetCorrelParIndex  ( const Int_t pk );

    // prédéfinition du fond et des pics
    virtual bool      SetRelativeCenter ( const Int_t pk, const Int_t pkref = -1 );
    virtual bool      SetRelativeFactor ( const Int_t pk, const Int_t pkref = -1 );
    virtual bool      SetRelativeSigma  ( const Int_t pk, const Int_t pkref = -1 );

    virtual void      SetBgPar        ( const Int_t p,  const Double_t val );

    virtual void      SetFactor       ( const Int_t pk, const Double_t val );
    virtual void      SetAbsFactor    ( const Int_t pk, const Double_t val );
    virtual void      SetAmplitude    ( const Int_t pk, const Double_t val );
    virtual void      SetAbsAmplitude ( const Int_t pk, const Double_t val );

    virtual void      SetCenterX      ( const Int_t pk, const Double_t val );
    virtual void      SetAbsCenterX   ( const Int_t pk, const Double_t val );
    virtual void      SetCenterY      ( const Int_t pk, const Double_t val );
    virtual void      SetAbsCenterY   ( const Int_t pk, const Double_t val );

    virtual void      SetSigma1       ( const Int_t pk, const Double_t val );
    virtual void      SetAbsSigma1    ( const Int_t pk, const Double_t val );
    virtual void      SetSigma2       ( const Int_t pk, const Double_t val );
    virtual void      SetAbsSigma2    ( const Int_t pk, const Double_t val );

    virtual void      SetCorrelPar    ( const Int_t pk, const Double_t val );


    virtual Double_t  GetBgPar      ( const Int_t p ) const;
    virtual Double_t  GetFactor     ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsFactor  ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAmplitude  ( const Int_t pk = 0 ) const;
    virtual Double_t  GetCounts     ( const Int_t pk = 0 ) const;

    virtual Double_t  GetCenterX    ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsCenterX ( const Int_t pk = 0 ) const;
    virtual Double_t  GetCenterY    ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsCenterY ( const Int_t pk = 0 ) const;

    virtual Double_t  GetSigma1     ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsSigma1  ( const Int_t pk = 0 ) const;
    virtual Double_t  GetSigma2     ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsSigma2  ( const Int_t pk = 0 ) const;

    virtual Double_t  GetCorrelPar  ( const Int_t pk = 0 ) const;
    virtual Double_t  GetTheta      ( const Int_t pk = 0 ) const;

    virtual Double_t  GetBgParError       ( const Int_t p ) const;
    virtual Double_t  GetFactorError      ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsFactorError   ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAmplitudeError   ( const Int_t pk = 0 ) const;
    virtual Double_t  GetCountsError      ( const Int_t pk = 0 ) const;

    virtual Double_t  GetCenterXError     ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsCenterXError  ( const Int_t pk = 0 ) const;
    virtual Double_t  GetCenterYError     ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsCenterYError  ( const Int_t pk = 0 ) const;

    virtual Double_t  GetSigma1Error      ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsSigma1Error   ( const Int_t pk = 0 ) const;
    virtual Double_t  GetSigma2Error      ( const Int_t pk = 0 ) const;
    virtual Double_t  GetAbsSigma2Error   ( const Int_t pk = 0 ) const;

    virtual Double_t  GetCorrelParError   ( const Int_t pk = 0 ) const;
    //virtual Double_t  GetThetaError       ( const Int_t pk = 0 ) const;

    // paramètres fixes
    virtual void      FixBgParameter      ( const Int_t p,  const bool b = true );
    virtual void      FixFactorParameter  ( const Int_t pk, const bool b = true );
    virtual void      FixCenterXParameter ( const Int_t pk, const bool b = true );
    virtual void      FixCenterYParameter ( const Int_t pk, const bool b = true );
    virtual void      FixSigma1Parameter  ( const Int_t pk, const bool b = true );
    virtual void      FixSigma2Parameter  ( const Int_t pk, const bool b = true );
    virtual void      FixCorrelParameter  ( const Int_t pk, const bool b = true );

    virtual bool      IsFixBgParameter      ( const Int_t p  ) const;
    virtual bool      IsFixFactorParameter  ( const Int_t pk ) const;
    virtual bool      IsFixCenterXParameter ( const Int_t pk ) const;
    virtual bool      IsFixCenterYParameter ( const Int_t pk ) const;
    virtual bool      IsFixSigma1Parameter  ( const Int_t pk ) const;
    virtual bool      IsFixSigma2Parameter  ( const Int_t pk ) const;
    virtual bool      IsFixCorrelParameter  ( const Int_t pk ) const;

    // préinitialisation
    virtual void      PresetBg    ( const Double_t x1, const Double_t y1 );
    virtual void      PresetBg    ( const Double_t x1, const Double_t y1, const Double_t delta );
    virtual void      PresetBg    ( const Double_t x1, const Double_t y1, const Double_t dx, const Double_t dy );
    virtual void      PresetComponent ( const Int_t pk,
                                        const Double_t cx, const Double_t cy,
                                        const Double_t s1 = -1., const Double_t s2 = -1. );

  //------------------------------------------------------------
  // styles de tracé
  //------------------------------------------------------------
  // tracés de la fonction
    virtual void      SetCalcAll        ( );
    virtual void      SetCalcNone       ( );
    virtual void      SetFunction       ( );
    virtual void      ScaleFunction     ( const Double_t s );

    virtual void      DrawComponent     ( const Int_t pk, const bool bg = true, const char *opts = "COL" );
    virtual void      DrawEllipse       ( const Int_t pk );
    virtual void      DrawBg            ( const char *opts = "COL" );

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

    virtual TEllipse  * GetEllipse      ( const Int_t pk, const Double_t rsig = 1. );

    // création d'histogrammes à partir de la fonction
    virtual TH2     * GetComponentHisto ( const char *name, const Int_t pk, const bool bg = false );
    virtual TH2     * GetBgHisto        ( const char *name );

    // résultat (texte)
    virtual string        GetFitText ( ) const;

    virtual RFitData2D  * CreateFitData ( );
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );
    virtual Int_t         LoadFitData   ( const string &fname );


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

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

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


  //------------------------------------------------------------
  // tracés de la fonction
    virtual void      SetCalcAll        ( );
    virtual void      SetCalcNone       ( );
    virtual void      SetFunction       ( );
    virtual void      ScaleFunction     ( const Double_t s );

    virtual void      DrawComponent     ( const Int_t pk, const bool bg = true, const char *opts = "COL" );
    virtual void      DrawEllipse       ( const Int_t pk );
    virtual void      DrawBg            ( const char *opts = "COL" );

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

    virtual TEllipse  * GetEllipse      ( const Int_t pk, const Double_t rsig = 1. );

    // création d'histogrammes à partir de la fonction
    virtual TH2     * GetComponentHisto ( const char *name, const Int_t pk, const bool bg = false );
    virtual TH2     * GetBgHisto        ( const char *name );

    // résultat (texte)
    virtual string        GetFitText ( ) const;

    virtual RFitData2D  * CreateFitData ( );
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );
    virtual Int_t         LoadFitData   ( const string &fname );


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

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

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