RGFitPeak.hh

Go to the documentation of this file.

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

#ifndef RG_FIT_PEAK_HH
#define RG_FIT_PEAK_HH

#include "RFitPeak.hh"
#include "RGFitBase1D.hh"

///! Default width of control zone of the interface
#define RGFIT_PEAK_WIDTH    600

// New point type for the fit.
namespace RGFitPointType
{
  /*! Background preset point type.*/
  static const int bgDef       = 1;

  /*! Peak center point type.*/
  static const int peakCenter  = 2;

  /*! Peak width point type.*/
  static const int peakSigma   = 3;

  /*! Peak tail point type.*/
  static const int peakTail    = 4;
}

//======================================================================
/*! \class RGFitPeak
 *
 *  Graphical interface for the RFitPeak class.
 *  See RGFitBase1D class for general fit interface features.
 *
 *  It allows to define interactively the preset points:
 *  - 2 points for fit limits (corners)
 *  - 1 or 2 points for background preset (if needed)
 *  - 1 point for center of peaks
 *  - 1 points for sigma of peaks
 *
 *  \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 RGFitPeak : virtual public RFitPeak,
                  virtual public RGFitBase1D
{
  //------------------------------------------------------------
  /*! \object_doc{RGFitPeak} */
  GObject(RGFitPeak);
  //------------------------------------------------------------

  friend class RGFitDisplayer1D;

  public:

    static  TAttLine    bg_line_att;          ///< Background preset line attributes
    static  TAttLine    peak_ctr_line_att;    ///< Peak center line attributes
    static  TAttLine    peak_sig_line_att;    ///< Peak width line attributes
    static  TAttLine    peak_tail_line_att;   ///< Peak tail line attributes

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

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

    TH1             * h_bg;                 ///< Pointer to result background histogram
    TH1             * h_peak[RPEAK_MAX];    ///< Array of pointers to result peaks histograms
    TH1             * h_gaus[RPEAK_MAX];    ///< Array of pointers to result Gauss peaks components histograms
    TH1             * h_tail[RPEAK_MAX];    ///< Array of pointers to result tail peaks 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)
    TGVerticalFrame     *    w_opt_check1;        ///<     1ere colonne d'options
    TGVerticalFrame     *    w_opt_check2;        ///<     2e colonne d'options
    TGVerticalFrame     *    w_opt_check3;        ///<     3e colonne d'options
    TGCheckButton       *     w_opt_surf;         ///<      Indicateur option surface
    TGCheckButton       *     w_opt_tail;         ///<      Indicateur option traîne
    TGCheckButton       *     w_opt_err;          ///<      Indicateur option normalisation des erreurs
    TGCheckButton       *     w_opt_common_sig;   ///<      Indicateur option sigma commun
    TGCheckButton       *     w_opt_common_tail;  ///<      Indicateur option traîne commune
    TGCheckButton       *     w_opt_common_ratio; ///<      Indicateur option rapport 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
    TGNumberEntry       *   w_bg_x1_value;                      ///<    Valeur point 1 de précalcul du fond
    TGNumberEntry       *   w_bg_x2_value;                      ///<    Valeur point 2 de précalcul du fond
    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[RPEAK_MAX_BG_PAR];  ///<   Nom paramètre fond
    TGNumberEntry       *    w_bg_par_value[RPEAK_MAX_BG_PAR];  ///<   Valeur paramètre fond
    TGCheckButton       *    w_bg_par_fix  [RPEAK_MAX_BG_PAR];  ///<   Fixe paramètre fond
    TGTextButton        *   w_bg_par_preset;                    ///<   Bouton de précalcul

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

    TGGroupFrame        * w_peaks_frame         [RPEAK_MAX];    ///<  Cadre des paramètres des pics
    TGHorizontalFrame   *  w_peaks_sub_frame    [RPEAK_MAX];    ///<   Cadre horizontal

    TGVerticalFrame     *  w_peaks_factor_frame   [RPEAK_MAX];    ///<    Cadre facteur (amplitude/surface)
    TGLabel             *   w_peaks_factor_label  [RPEAK_MAX];    ///<     Label
    TGNumberEntry       *   w_peaks_factor_value  [RPEAK_MAX];    ///<     Valeur
    TGCheckButton       *   w_peaks_factor_fix    [RPEAK_MAX];    ///<     Fix
    TGHorizontalFrame   *   w_peaks_factor_rel_hf [RPEAK_MAX];    ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_peaks_factor_rel    [RPEAK_MAX];    ///<     Pic de référence

    TGVerticalFrame     *  w_peaks_center_frame   [RPEAK_MAX];    ///<    Cadre centre
    TGLabel             *   w_peaks_center_label  [RPEAK_MAX];    ///<     Label
    TGNumberEntry       *   w_peaks_center_value  [RPEAK_MAX];    ///<     Valeur
    TGCheckButton       *   w_peaks_center_fix    [RPEAK_MAX];    ///<     Fix
    TGHorizontalFrame   *   w_peaks_center_rel_hf [RPEAK_MAX];    ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_peaks_center_rel    [RPEAK_MAX];    ///<     Pic de référence

    TGVerticalFrame     *  w_peaks_sigma_frame    [RPEAK_MAX];    ///<    Cadre sigma
    TGLabel             *   w_peaks_sigma_label   [RPEAK_MAX];    ///<     Label
    TGNumberEntry       *   w_peaks_sigma_value   [RPEAK_MAX];    ///<     Valeur
    TGCheckButton       *   w_peaks_sigma_fix     [RPEAK_MAX];    ///<     Fix
    TGHorizontalFrame   *   w_peaks_sigma_rel_hf  [RPEAK_MAX];    ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_peaks_sigma_rel     [RPEAK_MAX];    ///<     Pic de référence

    TGVerticalFrame     *  w_peaks_tail_frame     [RPEAK_MAX];    ///<    Cadre taille de traîne
    TGLabel             *   w_peaks_tail_label    [RPEAK_MAX];    ///<     Label
    TGNumberEntry       *   w_peaks_tail_value    [RPEAK_MAX];    ///<     Valeur
    TGCheckButton       *   w_peaks_tail_fix      [RPEAK_MAX];    ///<     Fix
    TGHorizontalFrame   *   w_peaks_tail_rel_hf   [RPEAK_MAX];    ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_peaks_tail_rel      [RPEAK_MAX];    ///<     Pic de référence

    TGVerticalFrame     *  w_peaks_ratio_frame    [RPEAK_MAX];    ///<    Cadre rapport de traîne
    TGLabel             *   w_peaks_ratio_label   [RPEAK_MAX];    ///<     Label
    TGNumberEntry       *   w_peaks_ratio_value   [RPEAK_MAX];    ///<     Valeur
    TGCheckButton       *   w_peaks_ratio_fix     [RPEAK_MAX];    ///<     Fix
    TGHorizontalFrame   *   w_peaks_ratio_rel_hf  [RPEAK_MAX];    ///<     Cadre horizontal pour pic de référence
    TGComboBox          *   w_peaks_ratio_rel     [RPEAK_MAX];    ///<     Pic de référence

    TGTextButton        *  w_peak_preset          [RPEAK_MAX];    ///<    Bouton de prédéfinition

  //----------------------------------------------------------
  public:
    // Constructeurs
    RGFitPeak ( const TGWindow * parent, TH1 *hptr, TH1 * herr = NULL );
    RGFitPeak ( const TGWindow * parent, TH1 *hptr, const RFitDataPeak & fit_data );
    RGFitPeak ( const TGWindow * parent, TH1 *hptr, const Double_t x1, const Double_t x2 );
    RGFitPeak ( const TGWindow * parent, TH1 *hptr, TH1 * herr, const RFitDataPeak & fit_data );
    RGFitPeak ( const TGWindow * parent, TH1 *hptr, TH1 * herr, const Double_t x1, const Double_t x2 );

  protected:
    RGFitPeak ( const RGFitPeak & original );

  public:
    // Destructeur
    virtual ~RGFitPeak ( );

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

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

  //----------------------------------------------------------
  //  Surchage des fonctions de la classe RFitPeak
  //  (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 x2 = 0. );
    virtual void  PresetPeak    ( const Int_t pk, const Double_t ctr, const Double_t sig = -1. );

    virtual RFitData1D  * CreateFitData ( );
    virtual RFitData1D  * GetFitData    ( );
    virtual void          SetFitData    ( const RFitData1D * 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 );
    virtual Int_t GetPointType  ( const Int_t p );

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

    virtual void  AddPoint    ( const Double_t x, 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 ( );

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

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

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

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

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

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

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

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

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

    virtual void  ShowRelativeToggled     ( Bool_t b );

    virtual void  OptSurfToggled          ( Bool_t b );
    virtual void  OptTailToggled          ( Bool_t b );
    virtual void  OptErrToggled           ( Bool_t b );

    virtual void  CommonSigmaToggled      ( Bool_t b );
    virtual void  CommonTailToggled       ( Bool_t b );
    virtual void  CommonRatioToggled      ( 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  RelTailSelected         ( const Int_t sel );
    virtual void  RelRatioSelected        ( const Int_t sel );

    virtual void  FixSigmaClicked         ( const Int_t pk );
    virtual void  FixTailClicked          ( const Int_t pk );
    virtual void  FixRatioClicked         ( const Int_t pk );

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

    virtual void  PeakPreset              ( const Int_t pk );

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

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

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