RFitDecay.hh

Go to the documentation of this file.

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

#ifndef R_FIT_DECAY_HH
#define R_FIT_DECAY_HH

#include "RFitBase1D.hh"
#include "RFitDataDecay.hh"

// Fit function.
#include "RDecayFunction.hh"
extern Double_t RFitDecayFunction ( Double_t *x, Double_t *p );

extern  const char  *rDecayBgName[];

// Decay fit options added to RFitOptions namespace
namespace RFitOptions
{
  /*! Use of relative efficiency for first and second filiation*/
  static const u_int  modeEfficiency      = 0x00000010;

  /*! Fit of decay phase.*/
  static const u_int  fitDecay            = 0x00000100;

  /*! Fit of production phase (constant production).*/
  static const u_int  fitGrowing          = 0x00000200;

  /*! Full fit: production and decay.*/
  static const u_int  fitGrowingAndDecay  = 0x00000300;

  /*! Production phase start as fit parameter (if production phase is
   *  part of the fit)*/
  static const u_int  varProdTime         = 0x00001000;

  /*! Decay phase start as fit parameter (if both production and decay
   *  phases are part of the fit).*/
  static const u_int  varDecayTime        = 0x00002000;

  /*! Use decay constant parameter instead of half-life.*/
  static const u_int  fitLambda           = 0x00010000;

  /*! The amplitude parameter is the number of nuclei (filiation excluded)
   *  at the beginning of the decay phase, instead of decay rate at
   *  beginning of decay phase.
   */
  static const u_int  fitNumber           = 0x00020000;

  /*! The amplitude parameter is the constant production rate
   *  during the production phase, instead of decay rate at
   *  beginning of decay phase.
   */
  static const u_int  fitProd             = 0x00040000;

  /*! Use a second nucleus as daughter of the first one.*/
  static const u_int  singleFiliation     = 0x00100000;

  /*! Use a third nucleus as daughter of the second one
   *  (the second nucleus is the daughter of the first).*/
  static const u_int  doubleFiliation     = 0x00200000;

  /*! The fit function contains a direct production component of the
   *  second nucleus.*/
  static const u_int  modeProdSecond      = 0x01000000;

  /*! The fit function contains a direct production component of the
   *  thirs nucleus.*/
  static const u_int  modeProdThird       = 0x02000000;
}


//======================================================================
/*! \class RFitDecay
 *
 *  Class for radioactive decay fits (see also RFitBase1D).
 *
 *  The decay can include up to 3 components, that can be defined as
 *  parent, daugther and grand-daughter, and/or produced directly
 *  (the production rate is assumed to be constant).
 *
 *  It is possible to include production phase (grow-in) and/or decay
 *  phase.
 *
 *  \par The decay phases
 *
 *  - background (if production phase is in the fit), from fit lower limit
 *    to production start time;
 *  - production (if production phase is in the fit), from production start
 *    time to decay start time:
 *  - decay: (if decay phase is in the fit), from decay start time to fit
 *    upper limit.
 *
 *  \par Detection efficiency
 *
 *  The detection efficiency can be different for the 3 components.
 *  Then a relative coefficient for number of counts (scale factor) can
 *  be defined for contributions of the second and the third component
 *  to take it into account.
 *  These relative efficiencies are defined as new fit parameters. 
 *
 *  \par Fit options
 *
 *  The fit options are defined in RFitOptions namespace, and the fit
 *  modes (chi2 minimisation or maximum likelyhood) in the RFitModes
 *  namespace.
 *
 *  The options must be defined before presetting of fixing parameters.
 *
 *  Fit modes:
 *    - fitChi2 : chi2 minimisation
 *    - fitLikelyhood : maximum likelyhood
 *
 *  Global fit options:
 *    - modeErrNorm :   uncertainties are normalised with Chi2.
 *
 *  Specific fit options:
 *    - fitDecay :            fit only the decay phase.
 *    - fitGrowing :          fit only the production phase.
 *    - fitGrowingAndDecay :  fit production and decay.
 *    - modeEfficiency :      detection efficiency is different for second and
 *                            third components : a parameter for relative
 *                            efficiency (with respect to first component)
 *                            is defined.
 *    - fitLambda :           use decay constant instead of half-life as
 *                            fit parameter
 *    - fitNumber :           use number of nuclei at beginning of decay
 *                            phase (end of production) instead of decay rate.
 *    - fitProd :             use production rate instead of decay rate (at
 *                            beginning of decay phase) as parameter
 *                            (valid if production phase is fitted).
 *    - singleFiliation :     second component is the daughter of the
 *                            first component (filiation: 1 -> 2).
 *    - doubleFiliation :     third component is the daughter of the
 *                            second component (implies also singleFiliation:
 *                            1 -> 2 -> 3).
 *    - modeProdSecond :      second component is produced directly (it is
 *                            compatible with singleFiliation).
 *    - modeProdThird :       second component is produced directly (it is
 *                            compatible with singleFiliation and
 *                            doubleFiliation).
 *
 *  Background types:
 *    - bgNone:     no background
 *    - bgConst:    constant background
 *    - bgLin:      linear background
 */
class RFitDecay : virtual public RFitDataDecay, virtual public RFitBase1D
{
  //------------------------------------------------------------
  /*! \object_doc{RFitDecay} */
  GObject(RFitDecay);
  //------------------------------------------------------------

  friend Double_t RFitDecayFunction (Double_t *, Double_t *);

  ///! Background types identifiers
  enum BgType
  {
    bgNone    = 0,
    bgConst   = 1,
    bgLin     = 2
  };

  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[RDECAY_BG_MAX];  ///< Table du nombre de paramètres selon le type de fond

    static  Int_t   decay_number;     ///< Nombre de contributions (durée de vie)
    static  Int_t   prod_number;      ///< Nombre de contributions (production directe)

    static  Int_t   index_tprod;                  ///< Index du paramètre de temps de début de production
    static  Int_t   index_tdec;                   ///< Index du paramètre de temps de début de décroissance
    static  Int_t   index_prod[RDECAY_MAX];       ///< Index des productions (initiale ou taux)
    static  Int_t   index_dec [RDECAY_MAX];       ///< Index des durées de vies
    static  Int_t   index_eff [RDECAY_MAX];       ///< Index des efficacités relatives de détection
    static  Int_t   index_bg[RDECAY_MAX_BG_PAR];  ///< Index des paramètres de fond dans la table des paramètres

    static  bool    calc_prod[RDECAY_MAX];        ///< Indique les composantes de production directe à calculer
    static  bool    calc_fil1[RDECAY_MAX];        ///< Indique les composantes de première filiation
    static  bool    calc_fil2[RDECAY_MAX];        ///< Indique les composantes de seconde filiation
    static  bool    calc_bg;                      ///< Indique s'il faut calculer le fond

    static  Double_t  time_prod;                  ///< Temps de début de production (hors paramètre)
    static  Double_t  time_dec;                   ///< Temps de début de décroissance (hors paramètre)
    static  Double_t  rel_eff[RDECAY_MAX];        ///< Efficacités relatives d'observation des composantes
#endif

    // attributs de lignes
    static  TAttLine  latt_dec[3];  ///<  Attributs de lignes pour tracé des composantes de décroissance
    static  TAttLine  latt_bg;      ///<  Attributs de lignes pour tracé du fond

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RFitDecay ( TH1 *hptr, TH1 * herr = NULL );
    RFitDecay ( TH1 *hptr, const RFitDataDecay & fit_data );
    RFitDecay ( TH1 *hptr, TH1 * herr, const RFitDataDecay & fit_data );
    RFitDecay ( const RFitDecay & original );

    virtual ~RFitDecay ( );

  //------------------------------------------------------------
  // surcharge des fonctions de la classe de base
    virtual void      SetOption   ( const UInt_t opt, const bool b = true );
    virtual void      InitMode    ( );

  //------------------------------------------------------------
    static  Int_t     GetStaticDecayNumber  ( );
    static  Int_t     GetStaticProdNumber   ( );

    // 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()); }

    // paramètres
    virtual Int_t     GetBgParIndex     ( const Int_t p );
    virtual Int_t     GetDecayParIndex  ( const Int_t p );
    virtual Int_t     GetProdParIndex   ( const Int_t p );

    // prédéfinition du fond et des contributions
    virtual void      SetProdTime         ( const Double_t val );
    virtual void      SetDecayTime        ( const Double_t val );
    virtual Double_t  GetStaticProdTime   ( ) const;
    virtual Double_t  GetStaticDecayTime  ( ) const;
    virtual Int_t     CheckTimes          ( const bool warn = false );

    virtual void      SetEfficiency       ( const Int_t n, const Double_t val );
    virtual Double_t  GetStaticEfficiency ( const Int_t n );

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

    virtual void      SetHalfLife       ( const Int_t n, const Double_t val );
    virtual void      SetLambda         ( const Int_t n, const Double_t val );

    virtual void      SetDecayRate      ( const Int_t n, const Double_t val );
    virtual void      SetInitNumber     ( const Int_t n, const Double_t val );
    virtual void      SetProdRate       ( const Int_t n, const Double_t val );

    virtual Double_t  GetHalfLife       ( const Int_t n ) const;
    virtual Double_t  GetLambda         ( const Int_t n ) const;

    virtual Double_t  GetBgPar          ( const Int_t p ) const;
    virtual Double_t  GetDecayPar       ( const Int_t n ) const;
    virtual Double_t  GetProdPar        ( const Int_t n ) const;

    virtual Double_t  GetBgParError     ( const Int_t p ) const;
    virtual Double_t  GetDecayParError  ( const Int_t n ) const;
    virtual Double_t  GetProdParError   ( const Int_t n ) const;

    // paramètres fixes
    virtual void      FixBgParameter    ( const Int_t p, const bool b = true );
    virtual void      FixDecayParameter ( const Int_t n, const bool b = true );
    virtual void      FixProdParameter  ( const Int_t n, const bool b = true );

    virtual bool      IsFixBgParameter    ( const Int_t p ) const;
    virtual bool      IsFixDecayParameter ( const Int_t n ) const;
    virtual bool      IsFixProdParameter  ( const Int_t n ) const;

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

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

    virtual void      DrawDecay     ( const Int_t n, const Int_t fil, const bool bg = true, const char *opts = "" );
    virtual void      DrawBg        ( const char *opts = "" );

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

    // création d'histogrammes à partir de la fonction
    virtual TH1     * GetDecayHisto       ( const char *name, const Int_t n, const Int_t fil, const bool bg = true );
    virtual TH1     * GetBgHisto          ( const char *name );

    // résultat (texte)
    virtual void          Preset   ( );
    virtual void          Preset   ( const Double_t t0, const Double_t t1 = 0., const Double_t t2 = 0. );
    virtual void          PresetBg ( );
    virtual Double_t      Fit      ( const char *opts = "" );
    virtual string        GetFitText ( ) const;

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

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

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

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

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

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

    virtual void      DrawDecay     ( const Int_t n, const Int_t fil, const bool bg = true, const char *opts = "" );
    virtual void      DrawBg        ( const char *opts = "" );

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

    // création d'histogrammes à partir de la fonction
    virtual TH1     * GetDecayHisto       ( const char *name, const Int_t n, const Int_t fil, const bool bg = true );
    virtual TH1     * GetBgHisto          ( const char *name );

    // résultat (texte)
    virtual void          Preset   ( );
    virtual void          Preset   ( const Double_t t0, const Double_t t1 = 0., const Double_t t2 = 0. );
    virtual void          PresetBg ( );
    virtual Double_t      Fit      ( const char *opts = "" );
    virtual string        GetFitText ( ) const;

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

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

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

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