PFitter.h

Go to the documentation of this file.

/***************************************************************************

  PFitter.h

  Author: Andreas Suter
  e-mail: andreas.suter@psi.ch

***************************************************************************/

/***************************************************************************
 *   Copyright (C) 2007-2023 by Andreas Suter                              *
 *   andreas.suter@psi.ch                                                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef _PFITTER_H_
#define _PFITTER_H_

#include <memory>

#include "Minuit2/MnUserParameters.h"
#include "Minuit2/FunctionMinimum.h"

#include "PMusr.h"
#include "PMsrHandler.h"
#include "PRunListCollection.h"
#include "PFitterFcn.h"

#define PMN_INTERACTIVE       0
#define PMN_CONTOURS          1
#define PMN_EIGEN             2
#define PMN_FIT_RANGE         3
#define PMN_FIX               4
#define PMN_HESSE             5
#define PMN_MACHINE_PRECISION 6
#define PMN_MIGRAD            7
#define PMN_MINIMIZE          8
#define PMN_MINOS             9
#define PMN_PLOT              10
#define PMN_RELEASE           11
#define PMN_RESTORE           12
#define PMN_SAVE              13
#define PMN_SCAN              14
#define PMN_SIMPLEX           15
#define PMN_STRATEGY          16
#define PMN_USER_COVARIANCE   17
#define PMN_USER_PARAM_STATE  18
#define PMN_PRINT             19
#define PMN_SECTOR            20

//-----------------------------------------------------------------------------
class PSectorChisq
{
  public:
    PSectorChisq(UInt_t noOfRuns);

    void SetRunFirstTime(Double_t first, UInt_t idx);
    void SetSectorTime(Double_t last) { fLast = last; }
    void SetChisq(Double_t chisq) { fChisq = chisq; }
    void SetChisq(Double_t chisq, UInt_t idx);
    void SetExpectedChisq(Double_t expChisq) { fExpectedChisq = expChisq; }
    void SetExpectedChisq(Double_t chisq, UInt_t idx);
    void SetNDF(UInt_t ndf) { fNDF = ndf; }
    void SetNDF(UInt_t ndf, UInt_t idx);

    Double_t GetTimeRangeFirst(UInt_t idx);
    Double_t GetTimeRangeLast() { return fLast; }
    Double_t GetChisq() { return fChisq; }
    Double_t GetChisq(UInt_t idx);
    Double_t GetExpectedChisq() { return fExpectedChisq; }
    Double_t GetExpectedChisq(UInt_t idx);
    UInt_t   GetNDF() { return fNDF; }
    UInt_t   GetNDF(UInt_t idx);
    UInt_t   GetNoRuns() { return fNoOfRuns; }

  private:
    UInt_t   fNoOfRuns; 
    Double_t fLast;  
    Double_t fChisq; 
    Double_t fExpectedChisq; 
    UInt_t   fNDF;   
    PDoubleVector fFirst; 
    PDoubleVector fChisqRun; 
    PDoubleVector fExpectedChisqRun; 
    PUIntVector fNDFRun; 
};

//-----------------------------------------------------------------------------
class PFitter
{
  public:
    PFitter(PMsrHandler *runInfo, PRunListCollection *runListCollection, Bool_t chisq_only = false);
    virtual ~PFitter();

    Bool_t IsValid() { return fIsValid; }
    Bool_t IsScanOnly() { return fIsScanOnly; }
    Bool_t HasConverged() { return fConverged; }
    Bool_t DoFit();

  private:
    Bool_t fIsValid;     
    Bool_t fIsScanOnly;  
    Bool_t fConverged;   
    Bool_t fChisqOnly;   
    Bool_t fUseChi2;     
    UInt_t fPrintLevel;  

    UInt_t fStrategy; 

    PMsrHandler *fRunInfo; 
    PRunListCollection *fRunListCollection; 

    PMsrParamList fParams; 

    PMsrLines      fCmdLines; 
    PIntPairVector fCmdList;  

    std::unique_ptr<PFitterFcn> fFitterFcn; 

    ROOT::Minuit2::MnUserParameters fMnUserParams; 
    std::unique_ptr<ROOT::Minuit2::FunctionMinimum> fFcnMin;       

    // minuit2 scan/contours command relate variables (see MnScan/MnContours in the minuit2 user manual)
    Bool_t fScanAll;           
    UInt_t fScanParameter[2];  
    UInt_t fScanNoPoints;      
    Double_t fScanLow;         
    Double_t fScanHigh;        
    PDoublePairVector fScanData; 

    PDoublePairVector fOriginalFitRange; 

    PStringVector fElapsedTime;

    Bool_t fSectorFlag; 
    std::vector<PSectorChisq> fSector; 

    std::vector<bool> fPhase; 

    // phase related functions
    void GetPhaseParams();
    PIntVector GetParFromFun(const TString funStr);
    PIntVector GetParFromMap(const TString mapStr);

    // commands
    Bool_t CheckCommands();
    Bool_t SetParameters();

    Bool_t ExecuteContours();
    Bool_t ExecuteFitRange(UInt_t lineNo);
    Bool_t ExecuteFix(UInt_t lineNo);
    Bool_t ExecuteHesse();
    Bool_t ExecuteMigrad();
    Bool_t ExecuteMinimize();
    Bool_t ExecuteMinos();
    Bool_t ExecutePlot();
    Bool_t ExecutePrintLevel(UInt_t lineNo);
    Bool_t ExecuteRelease(UInt_t lineNo);
    Bool_t ExecuteRestore();
    Bool_t ExecuteScan();
    Bool_t ExecuteSave(Bool_t first);
    Bool_t ExecuteSimplex();
    void   PrepareSector(PDoubleVector &param, PDoubleVector &error);
    Bool_t ExecuteSector(std::ofstream &fout);

    Double_t MilliTime();
};

#endif // _PFITTER_H_