TDecay.h

Go to the documentation of this file.

// Author: Ryan Dunlop    09/15
#ifndef TDECAY_H
#define TDECAY_H
 
/** \addtogroup Fitting Fitting & Analysis
 *  @{
 */
 
#include "TNamed.h"
#include "TFitResult.h"
#include "TFitResultPtr.h"
#include "TGraph.h"
#include "TF1.h"
#include "TH1.h"
 
class TVirtualDecay;
class TSingleDecay;
class TDecay;
class TDecayChain;
 
class TDecayFit : public TF1 {
public:
   TDecayFit() = default;
   TDecayFit(const char* name, const char* formula, Double_t xmin = 0, Double_t xmax = 1)
      : TF1(name, formula, xmin, xmax)
   {
      DefaultGraphs();
   }
   TDecayFit(const char* name, Double_t xmin, Double_t xmax, Int_t npar) : TF1(name, xmin, xmax, npar)
   {
      DefaultGraphs();
   }
   TDecayFit(const char* name, const ROOT::Math::ParamFunctor& f, Double_t xmin = 0, Double_t xmax = 1, Int_t npar = 0)
      : TF1(name, f, xmin, xmax, npar)
   {
      DefaultGraphs();
   }
#if !defined(__CINT__) && !defined(__CLING__)
   TDecayFit(const char* name, Double_t (*fcn)(Double_t*, Double_t*), Double_t xmin = 0, Double_t xmax = 1, Int_t npar = 0)
      : TF1(name, fcn, xmin, xmax, npar)
   {
      DefaultGraphs();
   }
   TDecayFit(const char* name, Double_t (*fcn)(const Double_t*, const Double_t*), Double_t xmin = 0, Double_t xmax = 1, Int_t npar = 0)
      : TF1(name, fcn, xmin, xmax, npar)
   {
      DefaultGraphs();
   }
#endif
 
   template <class PtrObj, typename MemFn>
   TDecayFit(const char* name, const PtrObj& p, MemFn memFn, Double_t xmin, Double_t xmax, Int_t npar)
      : TF1(name, p, memFn, xmin, xmax, npar)
   {
      DefaultGraphs();
   }
 
   template <typename Func>
   TDecayFit(const char* name, Func f, Double_t xmin, Double_t xmax, Int_t npar, const char* className = nullptr)
      : TF1(name, f, xmin, xmax, npar, className)
   {
      DefaultGraphs();
   }
   TDecayFit(const TDecayFit&)                = default;
   TDecayFit(TDecayFit&&) noexcept            = default;
   TDecayFit& operator=(const TDecayFit&)     = default;
   TDecayFit& operator=(TDecayFit&&) noexcept = default;
   ~TDecayFit()                               = default;
 
   void           SetDecay(TVirtualDecay* decay);
   TVirtualDecay* GetDecay() const;
   void           DrawComponents() const;   // *MENU*
 
   void          Print(Option_t* opt = "") const override;
   void          UpdateResiduals(TH1* hist);
   void          DrawResiduals();   // *MENU*
   TGraph*       GetResiduals() { return &fResiduals; }
   TFitResultPtr Fit(TH1* hist, Option_t* opt = "");
 
private:
   void DefaultGraphs();
 
   TVirtualDecay* fDecay{nullptr};   // VirtualDecay that made this fit
   TGraph         fResiduals;        // Last histogram fit by this function
 
   /// \cond CLASSIMP
   ClassDefOverride(TDecayFit, 1);   // NOLINT(readability-else-after-return)
   /// \endcond
};
 
class TVirtualDecay : public TNamed {
public:
   TVirtualDecay()                                    = default;
   TVirtualDecay(const TVirtualDecay&)                = default;
   TVirtualDecay(TVirtualDecay&&) noexcept            = default;
   TVirtualDecay& operator=(const TVirtualDecay&)     = default;
   TVirtualDecay& operator=(TVirtualDecay&&) noexcept = default;
   ~TVirtualDecay()                                   = default;
 
   virtual void DrawComponents(Option_t* opt = "", Bool_t color_flag = true);
   void         Print(Option_t* opt = "") const override = 0;
 
private:
   virtual const TDecayFit* GetFitFunction() = 0;
 
   /// \cond CLASSIMP
   ClassDefOverride(TVirtualDecay, 1)   // NOLINT(readability-else-after-return)
   /// \endcond
};
 
class TSingleDecay : public TVirtualDecay {
   friend class TDecayChain;
   friend class TDecayFit;
   friend class TDecay;
   //  friend class TDecay;
 
public:
   TSingleDecay()
      : fDetectionEfficiency(1.0)
   {
   }
   TSingleDecay(UInt_t generation, TSingleDecay* parent, Double_t tlow = 0, Double_t thigh = 10);
   explicit TSingleDecay(TSingleDecay* parent, Double_t tlow = 0, Double_t thigh = 10);
   TSingleDecay(const TSingleDecay&)                = default;
   TSingleDecay(TSingleDecay&&) noexcept            = default;
   TSingleDecay& operator=(const TSingleDecay&)     = default;
   TSingleDecay& operator=(TSingleDecay&&) noexcept = default;
   ~TSingleDecay();
 
   ///// TF1 Helpers ////
   UInt_t   GetGeneration() const { return fGeneration; }
   Double_t GetHalfLife() const
   {
      return (fDecayFunc->GetParameter(1) > 0.) ? std::log(2.0) / fDecayFunc->GetParameter(1) : 0.0;
   }
   Double_t GetDecayRate() const { return fDecayFunc->GetParameter(1); }
   Double_t GetIntensity() const { return fDecayFunc->GetParameter(0); }
   Double_t GetEfficiency() const { return fDetectionEfficiency; }
   Double_t GetHalfLifeError() const
   {
      return (GetDecayRate() > 0.) ? GetHalfLife() * GetDecayRateError() / GetDecayRate() : 0.0;
   }
   Double_t GetDecayRateError() const { return fDecayFunc->GetParError(1); }
   Double_t GetIntensityError() const { return fDecayFunc->GetParError(0); }
   void     SetHalfLife(const Double_t& halflife)
   {
      fDecayFunc->SetParameter(1, std::log(2.0) / halflife);
      UpdateDecays();
   }
   void SetDecayRate(const Double_t& decayrate)
   {
      fDecayFunc->SetParameter(1, decayrate);
      UpdateDecays();
   }
   void SetIntensity(const Double_t& intens)
   {
      fDecayFunc->SetParameter(0, intens);
      UpdateDecays();
   }
   void SetEfficiency(const Double_t& eff) { fDetectionEfficiency = eff; }
   void FixHalfLife(const Double_t& halflife)
   {
      fDecayFunc->FixParameter(1, std::log(2) / halflife);
      UpdateDecays();
   }
   void FixHalfLife()
   {
      fDecayFunc->FixParameter(1, GetHalfLife());
      UpdateDecays();
   }
   void FixDecayRate(const Double_t& decayrate)
   {
      fDecayFunc->FixParameter(1, decayrate);
      UpdateDecays();
   }
   void FixDecayRate()
   {
      fDecayFunc->FixParameter(0, GetDecayRate());
      UpdateDecays();
   }
   void          FixIntensity(const Double_t& intensity) { fDecayFunc->FixParameter(0, intensity); }
   void          FixIntensity() { fDecayFunc->FixParameter(0, GetIntensity()); }
   void          SetHalfLifeLimits(const Double_t& low, const Double_t& high);
   void          SetIntensityLimits(const Double_t& low, const Double_t& high);
   void          SetDecayRateLimits(const Double_t& low, const Double_t& high);
   void          GetHalfLifeLimits(Double_t& low, Double_t& high) const;
   void          GetIntensityLimits(Double_t& low, Double_t& high) const;
   void          GetDecayRateLimits(Double_t& low, Double_t& high) const;
   void          ReleaseHalfLife() { fDecayFunc->ReleaseParameter(1); }
   void          ReleaseDecayRate() { fDecayFunc->ReleaseParameter(1); }
   void          ReleaseIntensity() { fDecayFunc->ReleaseParameter(0); }
   void          Draw(Option_t* option = "") override;
   Double_t      Eval(Double_t t);
   Double_t      EvalPar(const Double_t* x, const Double_t* par = nullptr);
   TFitResultPtr Fit(TH1* fithist, Option_t* opt = "");
   void          Fix();
   void          Release();
   void          SetRange(Double_t tlow, Double_t thigh);
   void          SetName(const char* name) override;
   void          SetLineColor(Color_t color) { fTotalDecayFunc->SetLineColor(color); }
   Color_t       GetLineColor() const { return fTotalDecayFunc->GetLineColor(); }
   void          SetMinimum(Double_t min)
   {
      fTotalDecayFunc->SetMinimum(min);
      fDecayFunc->SetMinimum(min);
   }
   void SetMaximum(Double_t max)
   {
      fTotalDecayFunc->SetMaximum(max);
      fDecayFunc->SetMaximum(max);
   }
 
   void  SetDaughterDecay(TSingleDecay* daughter) { fDaughter = daughter; }
   void  SetParentDecay(TSingleDecay* parent) { fParent = parent; }
   void  SetTotalDecayParameters();
   void  SetDecayId(Int_t Id) { fUnId = Id; }
   Int_t GetDecayId() const { return fUnId; }
   Int_t GetChainId() const { return fChainId; }
 
   const TDecayFit* GetDecayFunc() const { return fDecayFunc; }
   const TDecayFit* GetTotalDecayFunc()
   {
      SetTotalDecayParameters();
      return fTotalDecayFunc;
   }
 
   TSingleDecay* GetParentDecay();
   TSingleDecay* GetDaughterDecay();
 
   Double_t ActivityFunc(Double_t* dim, Double_t* par);
 
   void Print(Option_t* option = "") const override;
 
private:
   void SetDecayRateError(Double_t err) { fDecayFunc->SetParError(1, err); }
   void SetIntensityError(Double_t err) { fDecayFunc->SetParError(0, err); }
 
   void UpdateDecays();
 
   void SetChainId(Int_t id) { fChainId = id; }
 
   const TDecayFit* GetFitFunction() override
   {
      SetTotalDecayParameters();
      return fTotalDecayFunc;
   }
 
   UInt_t        fGeneration{0};             // Generation from the primary
   Double_t      fDetectionEfficiency{0.};   // The probability that this decay can be detected
   TDecayFit*    fDecayFunc{nullptr};        // Function describing decay
   TDecayFit*    fTotalDecayFunc{nullptr};   // Function used to access other fits
   TSingleDecay* fParent{nullptr};           // Parent Decay
   TSingleDecay* fDaughter{nullptr};         // Daughter Decay
   TSingleDecay* fFirstParent{nullptr};      // FirstParent in the decay
   Int_t         fUnId{0};                   // The Unique ID of the Decay
   static UInt_t fCounter;                   // Helps set unique Id's
   Int_t         fChainId{-1};               // The chain that the single decay belongs to
 
   /// \cond CLASSIMP
   ClassDefOverride(TSingleDecay, 1)   // NOLINT(readability-else-after-return)
   /// \endcond
};
 
class TDecayChain : public TVirtualDecay {
public:
   TDecayChain() = default;
   explicit TDecayChain(UInt_t generations);
   TDecayChain(const TDecayChain&)                = default;
   TDecayChain(TDecayChain&&) noexcept            = default;
   TDecayChain& operator=(const TDecayChain&)     = default;
   TDecayChain& operator=(TDecayChain&&) noexcept = default;
   ~TDecayChain();
 
   TSingleDecay* GetDecay(UInt_t generation);
   Double_t      Eval(Double_t t) const;
   void          Draw(Option_t* opt = "") override;
   Int_t         Size() const { return static_cast<Int_t>(fDecayChain.size()); }
 
   void Print(Option_t* option = "") const override;
 
   void             SetChainParameters();
   void             SetRange(Double_t xlow, Double_t xhigh);
   const TDecayFit* GetChainFunc()
   {
      SetChainParameters();
      return fChainFunc;
   }
   void          DrawComponents(Option_t* opt = "", Bool_t color_flag = true) override;
   TFitResultPtr Fit(TH1* fithist, Option_t* opt = "");
   Double_t      EvalPar(const Double_t* x, const Double_t* par = nullptr);
 
   Int_t GetChainId() const { return fChainId; }
 
private:
   void             AddToChain(TSingleDecay* decay);
   Double_t         ChainActivityFunc(Double_t* dim, Double_t* par);
   static UInt_t    fChainCounter;
   const TDecayFit* GetFitFunction() override
   {
      SetChainParameters();
      return fChainFunc;
   }
 
   std::vector<TSingleDecay*> fDecayChain;           // The Decays in the Decay Chain
   TDecayFit*                 fChainFunc{nullptr};   // Function describing the total chain activity
   Int_t                      fChainId{-1};
 
   /// \cond CLASSIMP
   ClassDefOverride(TDecayChain, 1)   // NOLINT(readability-else-after-return)
   /// \endcond
};
 
////////////////////////////////////////////////////////////////////////
///
/// \class TDecay
///
/// TDecay is a class for fitting halflives during nuclear decay
/// A TDecay consists of multiple TDecayChains, where a TDecayChain
/// is starts at a specific nucleus which has a population before the
/// decay fit takes place. This could be a nucleus with a daughter.
/// One TDecayChain would consist of just the daughter while the
/// the other decay chain would be the parent and daughter.
/// TDecayChains are made up of multiple TSingleDecays which holds
/// the nucleus specific information such as name, id, halflife and
/// intensity. When any of the above classes are fit to a histogram,
/// they use a TDecayFit. The TDecayFit is a a TF1 with extra information
/// such as the class that was used to create the TDecayFit. Furthermore,
/// the function DrawComponents() can be used to draw the activites of the
/// individual nuclei involved in the TDecayFit.
///
////////////////////////////////////////////////////////////////////////
 
class TDecay : public TVirtualDecay {
public:
   TDecay() = default;
   explicit TDecay(std::vector<TDecayChain*> chainList);
   TDecay(const TDecay&)                = default;
   TDecay(TDecay&&) noexcept            = default;
   TDecay& operator=(const TDecay&)     = default;
   TDecay& operator=(TDecay&&) noexcept = default;
   ~TDecay()                            = default;
 
   void         AddChain(TDecayChain* chain) { fChainList.push_back(chain); }
   Double_t     DecayFit(Double_t* dim, Double_t* par);
   TDecayChain* GetChain(UInt_t idx);
 
   void SetHalfLife(Int_t Id, Double_t halflife);
   void SetHalfLifeLimits(Int_t Id, Double_t low, Double_t high);
   void SetDecayRateLimits(Int_t Id, Double_t low, Double_t high);
   void FixHalfLife(Int_t Id, Double_t halflife)
   {
      SetHalfLife(Id, halflife);
      SetHalfLifeLimits(Id, halflife, halflife);
   }
   TFitResultPtr Fit(TH1* fithist, Option_t* opt = "");
 
   void       Print(Option_t* opt = "") const override;
   void       PrintMap() const;
   TDecayFit* GetFitFunc() { return fFitFunc; }
   void       SetBackground(Double_t background) { fFitFunc->SetParameter(0, background); }
   Double_t   GetBackground() const { return fFitFunc->GetParameter(0); }
   Double_t   GetBackgroundError() const { return fFitFunc->GetParError(0); }
   void       SetRange(Double_t xlow, Double_t xhigh);
   void       DrawComponents(Option_t* opt = "", Bool_t color_flag = true) override;
   void       Draw(Option_t* opt = "") override;
   void       DrawBackground(Option_t* opt = "");
   void       FixBackground(const Double_t& background) { fFitFunc->FixParameter(0, background); }
   void       FixBackground() { fFitFunc->FixParameter(0, GetBackground()); }
   void       SetBackgroundLimits(const Double_t& low, const Double_t& high) { fFitFunc->SetParLimits(0, low, high); }
   void       ReleaseBackground() { fFitFunc->ReleaseParameter(0); }
 
   TGraph* GetResiduals() { return fFitFunc->GetResiduals(); }
 
private:
   void             RemakeMap();
   void             SetParameters();
   Double_t         ComponentFunc(Double_t* dim, Double_t* par);
   const TDecayFit* GetFitFunction() override { return fFitFunc; }
 
   std::vector<TDecayChain*>                   fChainList;
   TDecayFit*                                  fFitFunc{nullptr};
   std::map<Int_t, std::vector<TSingleDecay*>> fDecayMap;   //
 
   /// \cond CLASSIMP
   ClassDefOverride(TDecay, 1)   // NOLINT(readability-else-after-return)
   /// \endcond
};
/*! @} */
#endif