RGFitGaus2D.hh

Go to the documentation of this file.

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

#ifndef RG_FIT_GAUS_2D_HH
#define RG_FIT_GAUS_2D_HH

#include "RFitGaus2D.hh"
#include "RGFitBase2D.hh"

///! Default width of control zone of the interface
#define RGFIT_GAUS2D_WIDTH    500
///! Default height of control zone of the interface
#define RGFIT_GAUS2D_HEIGHT   700

// include for points types.
#include "RGFitPeak.hh"


//======================================================================
/*! \class RGFitGaus2D
 *
 *  Graphical interface for the RFitGaus2D class.
 *  See RGFitBase2D class for general fit interface features.
 *
 *  It allows to define interactively the preset points:
 *  - 2 points for fit limits (corners)
 *  - 1 point for center of components
 *  - 2 points for sigma ellipse of components
 *
 *  \note
 *    The class inherits 2 times from RFitBase (virtual inheritance).
 *    ROOT interpreter cannot manage this case, and the derived class
 *    RGuiFitDecay may be used in ROOT sessions.
 */
class RGFitGaus2D : virtual public RFitGaus2D,
                    virtual public RGFitBase2D
{
  //------------------------------------------------------------
  /*! \object_doc{RGFitGaus2D} */
  GObject(RGFitGaus2D);
  //------------------------------------------------------------

  friend class RGFitDisplayer2D;

  public:

    static  TAttLine    bg_line_att;    ///< Background preset line attributes
    static  TAttLine    ctr_line_att;   ///< Peak center line attributes des centres
    static  TAttLine    sig_line_att;   ///< Peak width line attributes
    static  TAttMarker  bg_marker_att;  ///< Background preset marker attributes
    static  TAttMarker  ctr_marker_att; ///< Peak center marker attributes
    static  TAttMarker  sig_marker_att; ///< Peak width marker attributes

  protected:
    static  UInt_t      control_width;      ///< Default width for control zone of the interface
    static  UInt_t      control_height;     ///< Default height for control zone of the interface

    // variable pour saisie des points
    Int_t             np_bg;                ///< Number of points for background preset

    TH2             * h_bg;                 ///< Pointer to result background histogram
    TH2             * h_comp[RGAUS2D_MAX];  ///< Array of pointers to result components histograms

  // Widgets spécifiques
    bool                  show_relative;    ///< Indique s'il faut afficher les paramètres relatifs

    TGGroupFrame        * w_opt_frame;            ///<  Cadre des options de fit
    TGHorizontalFrame   *  w_opt_line;            ///<   Ligne des options de base
    TGLabel             *   w_opt_number_label;   ///<    Label nombre de pics
    TGNumberEntry       *   w_opt_number_value;   ///<    Valeur nombre de pics
    TGCheckButton       *   w_show_relative;      ///<    Visualisation des paramètres relatifs

    TGHorizontalFrame   *   w_opt_check;          ///<    Cadres des différentes options (check-buttons)
    TGCheckButton       *    w_opt_err;           ///<     Indicateur option normalisation des erreurs
    TGCheckButton       *    w_opt_counts;        ///<     Indicateur option surface
    TGCheckButton       *    w_opt_theta;         ///<     Indicateur option choix de paramètres
    TGCheckButton       *    w_opt_common_sig;    ///<     Indicateur option sigma commun
    TGCheckButton       *    w_opt_common_corr;   ///<     Indicateur option paramètre de corrélation commun

    TGGroupFrame        * w_bg_frame;                             ///<  Cadre des paramètres de fond
    TGHorizontalFrame   *  w_bg_type_frame;                       ///<   Ligne type de fond
    TGLabel             *   w_bg_type_label;                      ///<    Label type de fond
    TGComboBox          *   w_bg_type_select;                     ///<    Sélection type de fond
    TGVerticalFrame     *   w_bg_xy1_vf;                          ///<    Cadre point de présélection
    TGNumberEntry       *    w_bg_x1_value;                       ///<     Valeur X point 1 de précalcul du fond
    TGNumberEntry       *    w_bg_y1_value;                       ///<     Valeur Y point 1 de précalcul du fond
    TGVerticalFrame     *   w_bg_dx_vf;                           ///<    Cadre point dX de présélection
    TGNumberEntry       *    w_bg_dx_value;                       ///<     Valeur X point X1+dX de présélection
    TGVerticalFrame     *   w_bg_dy_vf;                           ///<    Cadre point dY de présélection
    TGNumberEntry       *    w_bg_dy_value;                       ///<     Valeur Y point Y1+dY de présélection
    TGHorizontalFrame   *  w_bg_par_frame;                        ///<  Zone des paramètres fond
    TGVerticalFrame     *   w_bg_par_label_frame;                 ///<   Cadre des labels
    TGVerticalFrame     *   w_bg_par_value_frame;                 ///<   Cadre des valeurs
    TGVerticalFrame     *   w_bg_par_fix_frame;                   ///<   Cadre des param. fix
    TGLabel             *    w_bg_par_label[RGAUS2D_MAX_BG_PAR];  ///<   Nom paramètre fond
    TGNumberEntry       *    w_bg_par_value[RGAUS2D_MAX_BG_PAR];  ///<   Valeur paramètre fond
    TGCheckButton       *    w_bg_par_fix  [RGAUS2D_MAX_BG_PAR];  ///<   Fixe paramètre fond
    TGTextButton        *   w_bg_par_preset;                      ///<   Bouton de précalcul

    TGCanvas            * w_comp_canvas;                          ///< Fenêtre pour paramètres des pics
    TGVerticalFrame     * w_comp_canvas_frame;                    ///< Cadre de la fenêtre

    TGGroupFrame        * w_comp_frame          [RGAUS2D_MAX];    ///<  Cadre des paramètres des pics
    TGHorizontalFrame   *  w_comp_sub_frame     [RGAUS2D_MAX];    ///<   Cadre horizontal

    TGVerticalFrame     *  w_comp_factor_frame   [RGAUS2D_MAX];   ///<    Cadre facteur (amplitude/surface)
    TGLabel             *   w_comp_factor_label  [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_factor_value  [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_factor_fix    [RGAUS2D_MAX];   ///<     Fix
    TGHorizontalFrame   *   w_comp_factor_rel_hf [RGAUS2D_MAX];   ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_comp_factor_rel    [RGAUS2D_MAX];   ///<     Pic de référence

    TGVerticalFrame     *  w_comp_ctr_frame      [RGAUS2D_MAX];   ///<    Cadre centre X et Y
    TGLabel             *   w_comp_ctr_x_label   [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_ctr_x_value   [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_ctr_x_fix     [RGAUS2D_MAX];   ///<     Fix
    TGLabel             *   w_comp_ctr_y_label   [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_ctr_y_value   [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_ctr_y_fix     [RGAUS2D_MAX];   ///<     Fix
    TGHorizontalFrame   *   w_comp_ctr_rel_hf    [RGAUS2D_MAX];   ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_comp_ctr_rel       [RGAUS2D_MAX];   ///<     Pic de référence

    TGVerticalFrame     *  w_comp_sig_frame      [RGAUS2D_MAX];   ///<    Cadre sigma 1 et 2
    TGLabel             *   w_comp_sig_1_label   [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_sig_1_value   [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_sig_1_fix     [RGAUS2D_MAX];   ///<     Fix
    TGLabel             *   w_comp_sig_2_label   [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_sig_2_value   [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_sig_2_fix     [RGAUS2D_MAX];   ///<     Fix
    TGHorizontalFrame   *   w_comp_sig_rel_hf    [RGAUS2D_MAX];   ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_comp_sig_rel       [RGAUS2D_MAX];   ///<     Pic de référence

    TGVerticalFrame     *  w_comp_correl_frame   [RGAUS2D_MAX];   ///<    Cadre paramètre de corrélation
    TGLabel             *   w_comp_correl_label  [RGAUS2D_MAX];   ///<     Label
    TGNumberEntry       *   w_comp_correl_value  [RGAUS2D_MAX];   ///<     Valeur
    TGCheckButton       *   w_comp_correl_fix    [RGAUS2D_MAX];   ///<     Fix
    TGHorizontalFrame   *   w_comp_correl_rel_hf [RGAUS2D_MAX];   ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_comp_correl_rel    [RGAUS2D_MAX];   ///<     Pic de référence

    TGTextButton        *  w_comp_preset         [RGAUS2D_MAX];   ///<    Bouton de prédéfinition

  //----------------------------------------------------------
  public:
    // Constructeurs
    RGFitGaus2D ( const TGWindow * parent, TH2 *hptr, TH2 * herr = NULL );
    RGFitGaus2D ( const TGWindow * parent, TH2 *hptr, const RFitDataGaus2D & fit_data );
    RGFitGaus2D ( const TGWindow * parent, TH2 *hptr, const Double_t x1, const Double_t x2,
                                                      const Double_t y1, const Double_t y2 );
    RGFitGaus2D ( const TGWindow * parent, TH2 *hptr, TH2 * herr, const RFitDataGaus2D & fit_data );
    RGFitGaus2D ( const TGWindow * parent, TH2 *hptr, TH2 * herr, const Double_t x1, const Double_t x2,
                                                                  const Double_t y1, const Double_t y2 );

  protected:
    RGFitGaus2D ( const RGFitGaus2D & original );

  public:
    // Destructeur
    virtual ~RGFitGaus2D ( );

  protected:
    void    ClassInit ( );

  public:
    //----------------------------------------------------------
    // gestion de l'interface
    virtual void    Init                ( );
    virtual void    ConstructFitData    ( );
    virtual void    ConstructOpts       ( );
    virtual void    ConstructBg         ( );
    virtual void    ConstructComponents ( );

    virtual void    Request   ( );

    virtual void    SetControlWidth ( const UInt_t w );

    // options (statiques pour pouvoir être vues dans la fonction de fit)
    //    elles sont redéfinies pour appeler explicitement les fonctions
    //    de la classe RFitGaus2D et non de RGGetPoints
    virtual void      SetOptions  ( const UInt_t opts );
    virtual void      SetOption   ( const UInt_t opt, const bool b = true );
    virtual UInt_t    GetOptions  ( ) const;
    virtual bool      GetOption   ( const UInt_t opt ) const;

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

  //----------------------------------------------------------
  //  Surchage des fonctions de la classe RFitGaus2D
  //  (pour associer la mise à jour de l'interface graphique)
    virtual void  SetBgType     ( const Int_t bg );

    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. );

    virtual RFitData2D  * CreateFitData ( );
    virtual RFitData2D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData2D * fit_data );


    virtual void  ResetFunctions ( );
    virtual void  CalcFunctions  ( const bool bg = false );
    virtual bool  SaveFunctions  ( const string &fname = "" ) const;

  //----------------------------------------------------------
  //  Fonctions liées à la saisie des points

  protected:
    // Renvoit le point le plus proche (distance en pixels)
    virtual Int_t SelectedPoint ( const Double_t x, const Double_t y );
    virtual Int_t GetPointType  ( const Int_t p );

    // Retrace les points saisis
    virtual void  RedrawPoints ( );

    virtual void  AddPoint    ( const Double_t x, const Double_t y, const bool select = true );
    virtual void  DeletePoint ( const Int_t p );

    virtual void  PointMoved      ( const Int_t p );
    virtual void  PointSelected   ( const Int_t p );
    virtual void  PointUnselected ( const Int_t p );

  //----------------------------------------------------------
  //  Fonctions de mise à jour de l'interface

    // remise à jour de l'interface lorsque les paramètres de fit ont
    // été perdus (appel à InitMode())
    virtual void  ParamUpdateAll ( );

    virtual void  ResetComponents ( );
    virtual void  ResetComponent  ( const Int_t pk = 0 );

    // points de saisie -> paramètres de fit (classe de base)
    virtual void  PointsToParam           ( );
    virtual void  PointsToParamComponents ( );
    virtual void  PointsToParamComponent  ( const Int_t pk = 0 );

    // points de saisie -> valeurs widgets
    virtual void  PointsToWidget           ( );
    virtual void  PointsToWidgetBg         ( );
    virtual void  PointsToWidgetComponents ( );
    virtual void  PointsToWidgetComponent  ( const Int_t pk = 0 );

    // valeurs widgets -> paramètres de fit (classe de base)
    virtual void  WidgetsToParam           ( );
    virtual void  WidgetsToParamBg         ( );
    virtual void  WidgetsToParamComponents ( );
    virtual void  WidgetsToParamComponent  ( const Int_t pk = 0 );

    // valeurs widgets -> points de saisie
    virtual void  WidgetsToPoint           ( );
    virtual void  WidgetsToPointBg         ( );
    virtual void  WidgetsToPointComponents ( );
    virtual void  WidgetsToPointComponent  ( const Int_t pk = 0 );

    // paramètres de fit (classe de base) -> valeurs des widgets
    virtual void  ParamToWidget           ( );
    virtual void  ParamToWidgetBg         ( );
    virtual void  ParamToWidgetComponents ( );
    virtual void  ParamToWidgetComponent  ( const Int_t pk = 0 );

    // paramètres de fit (classe de base) -> points de saisie
    virtual void  ParamToPoint           ( );
    virtual void  ParamToPointComponents ( );
    virtual void  ParamToPointComponent  ( const Int_t pk = 0 );

  //----------------------------------------------------------
  // affichage des widgets
    virtual void  GuiUpdateOptions           ( );
    virtual void  GuiUpdateDisplay           ( );
    virtual void  GuiUpdateDisplayBg         ( );
    virtual void  GuiUpdateDisplayComponents ( );

  //----------------------------------------------------------
  //  Fonctions globales de fit
    virtual void  GuiPreset  ( );
    virtual void  GuiUpdate  ( );
    virtual void  GuiDrawFct ( );

  //----------------------------------------------------------
  //  SLOTS
  public:
    virtual void  ComponentsNumberChanged      ( Long_t n );
    virtual void  ComponentsNumberTextChanged  ( const char * str );

    virtual void  ShowRelativeToggled     ( Bool_t b );

    virtual void  OptCountsToggled        ( Bool_t b );
    virtual void  OptErrToggled           ( Bool_t b );
    virtual void  OptModeThetaToggled     ( Bool_t b );
    virtual void  CommonSigmaToggled      ( Bool_t b );
    virtual void  CommonCorrelToggled     ( Bool_t b );

    virtual void  BgTypeSelected          ( Int_t bg );
    virtual void  BgPreset                ( );

    virtual void  RelFactorSelected       ( const Int_t sel );
    virtual void  RelCenterSelected       ( const Int_t sel );
    virtual void  RelSigmaSelected        ( const Int_t sel );

    virtual void  FixParamClicked         ( const Int_t pk );
    virtual void  FixSigma1Clicked        ( const Int_t pk );
    virtual void  FixSigma2Clicked        ( const Int_t pk );
    virtual void  FixCorrelClicked        ( const Int_t pk );

    virtual void  FactorValueTextChanged  ( const char * str );
    virtual void  CenterValueTextChanged  ( const char * str );
    virtual void  SigmaValueTextChanged   ( const char * str );
    virtual void  CorrelValueTextChanged  ( const char * str );

    virtual void  ComponentPreset         ( const Int_t pk );

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

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

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