TGo4Fitter.h

Go to the documentation of this file.

// $Id$
//-----------------------------------------------------------------------
//       The GSI Online Offline Object Oriented (Go4) Project
//         Experiment Data Processing at EE department, GSI
//-----------------------------------------------------------------------
// Copyright (C) 2000- GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
//                     Planckstr. 1, 64291 Darmstadt, Germany
// Contact:            http://go4.gsi.de
//-----------------------------------------------------------------------
// This software can be used under the license agreements as stated
// in Go4License.txt file which is part of the distribution.
//-----------------------------------------------------------------------

#ifndef TGO4FITTER_H
#define TGO4FITTER_H

#include "TGo4FitterAbstract.h"

class TH1;
class TGraph;

#include "TArrayD.h"
#include "TObjArray.h"

class TGo4FitComponent;
class TGo4FitData;
class TGo4FitDataHistogram;
class TGo4FitDataGraph;
class TGo4FitModel;
class TGo4FitModelGauss1;

typedef Double_t (*TUserFitFunction)(Double_t, Double_t, Double_t);

class TGo4Fitter : public TGo4FitterAbstract {
   public:
      enum  { ff_least_squares = 0,
              ff_chi_square    = 1,
              ff_chi_Pearson   = 2,
              ff_chi_Neyman    = 3,
              ff_chi_gamma     = 4,
              ff_ML_Poisson    = 5,
              ff_user          = 6 };

      TGo4Fitter();

      TGo4Fitter(const char *iName, const char *iTitle);

      TGo4Fitter(const char *iName, Int_t iFitFunctionType, Bool_t IsAddStandardActions);

      virtual ~TGo4Fitter();

      void SetFitFunctionType(Int_t iFitFunctionType) { fiFitFunctionType = iFitFunctionType; }

      Int_t GetFitFunctionType() const { return fiFitFunctionType; }

      void SetUserFitFunction(TUserFitFunction iFunc) { fxUserFitFunction = iFunc; fiFitFunctionType = ff_user; }

      void SetMemoryUsage(Int_t iMemoryUsage);

      Int_t GetMemoryUsage() const { return fiMemoryUsage; }

      void Clear(Option_t *option = "") override;

      Int_t GetNumData() const { return fxDatas.GetLast()+1; }

      TGo4FitData *GetData(Int_t n);

      const char *GetDataName(Int_t n);

      TGo4FitData *FindData(const char *DataName);

      TGo4FitData *AddData(TGo4FitData *d);

      TGo4FitDataHistogram* AddH1(const char *DataName, TH1 *histo, Bool_t Owned = kFALSE, Double_t lrange = 0., Double_t rrange = 0.);

      TGo4FitDataHistogram* SetH1(const char *DataName, TH1 *histo, Bool_t Owned = kFALSE);

      TGo4FitDataGraph* AddGraph(const char *DataName, TGraph *gr, Bool_t Owned = kFALSE, Double_t lrange = 0., Double_t rrange = 0.);

      TGo4FitDataGraph* SetGraph(const char *DataName, TGraph *gr, Bool_t Owned = kFALSE);

      TGo4FitData *RemoveData(const char *DataName, Bool_t IsDel = kFALSE);

      void DeleteAllData();

      Int_t GetNumModel() const { return fxModels.GetLast()+1; }

      TGo4FitModel *GetModel(Int_t n);

      TGo4FitModel *FindModel(const char *ModelName);

      TGo4FitModel *AddModel(TGo4FitModel *m);

      TGo4FitModel *AddModel(const char *DataName, TGo4FitModel *m);

      void AddPolynomX(const char *DataName, const char *NamePrefix, Int_t MaxOrder = 1, Int_t GroupIndex = 0, Double_t lrange = 0., Double_t rrange = 0.);

       void AddPolynomX(const char *DataName, const char *NamePrefix, TArrayD& Coef, Int_t GroupIndex = 0);

      void AddPolynoms(const char *DataName, const char *NamePrefix, Int_t MaxOrder = 1, Int_t NumAxis = 1, Int_t GroupIndex = 0);

      TGo4FitModelGauss1 *AddGauss1(const char *DataName, const char *ModelName, Double_t iPosition, Double_t iWidth, Double_t iAmpl = 1., Int_t Axis = 0);

      Int_t NumModelsAssosiatedTo(const char *DataName);

      TGo4FitModel *CloneModel(const char *ModelName, const char *NewName = nullptr);

      TGo4FitModel *RemoveModel(const char *ModelName, Bool_t IsDel = kFALSE);

      void DeleteModelsAssosiatedTo(const char *DataName);

      void DeleteAllModels();

      void AssignModelTo(const char *ModelName, const char *DataName, Double_t RatioValue = 1., Bool_t FixRatio = kFALSE);

      void ClearModelAssignmentTo(const char *ModelName, const char *DataName = nullptr);

      void ChangeDataNameInAssignments(const char *oldname, const char *newname);

      Int_t GetNumComp() const { return GetNumData() + GetNumModel(); }

      TGo4FitComponent *GetComp(Int_t n);

      void EstimateAmplitudes(Int_t NumIters = 1);

      void AddAmplEstimation(Int_t NumIters = 1);

      void AddStandardActions();

      Double_t CalculateFitFunction(Double_t *pars = nullptr, Int_t FitFunctionType = -1, const char *DataName = nullptr);

      Int_t CalculateNDF(const char *DataName = nullptr);

      void FillSlotList(TSeqCollection *) override;

      void Print(Option_t *option = "") const override;

      Bool_t CalculatesMomentums(const char *DataName, Bool_t UseRanges, Bool_t SubstractModels, Double_t& first, Double_t& second);

      Double_t CalculatesIntegral(const char *DataName, const char *ModelName = nullptr, Bool_t OnlyCounts = kFALSE);

      Double_t CalculatesModelIntegral(const char *ModelName, Bool_t OnlyCounts = kFALSE);

      TObject *CreateDrawObject(const char *ObjName, const char *DataName, Bool_t IsModel = kFALSE, const char *ModelName = nullptr);

      void Draw(Option_t *option) override;

      void ProvideLastDrawObjects(TObjArray& lst);

      void PrintAmpls() const;

      void PrintLines() const;

      TString FindNextName(const char *Head, Int_t start, Bool_t isModel = kTRUE);

   protected:

      friend class TGo4FitAmplEstimation;

      // a set of function to access data buffers

      Bool_t ModelBuffersAllocated(TGo4FitModel *model);
      Bool_t DataBuffersAllocated(TGo4FitData *data);

      Int_t GetDataBinsSize(TGo4FitData *data) const;
      Double_t *GetDataBinsValues(TGo4FitData *data) const;
      Double_t *GetDataBinsDevs(TGo4FitData *data) const;
      Double_t *GetDataBinsResult(TGo4FitData *data) const;
      Double_t *GetModelBinsValues(TGo4FitModel *model, const char *DataName) const;

      void RebuildAll(Bool_t ForceBuild = kFALSE);

      void CollectAllPars() override;

      Double_t DoCalculation() override;
      Int_t DoNDFCalculation() override;
      Double_t CalculateFCN(Int_t FitFunctionType, TGo4FitData *selectdata = nullptr);
      Double_t PointFitFunction(Int_t FitFunctionType, Double_t value, Double_t modelvalue, Double_t standdev);

      Bool_t InitFitterData() override;
      void FinalizeFitterData() override;

      TObjArray fxDatas;

      TObjArray fxModels;

      Int_t fiFitFunctionType{0};

      Int_t fiMemoryUsage{0};

   private:

      void MoveDrawObjectsToROOT();
      void CheckSlotsBeforeDelete(TGo4FitComponent *comp);

      TUserFitFunction fxUserFitFunction{nullptr};    

      TObjArray *fxDrawObjs{nullptr};                

   ClassDefOverride(TGo4Fitter,1)
};

#endif // TGO4FITTER_H