PMsrHandler.h

Go to the documentation of this file.

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

  PMsrHandler.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 _PMSRHANDLER_H_
#define _PMSRHANDLER_H_

#include <memory>

#include <TString.h>
#include <TComplex.h>

#include "PMusr.h"
#include "PFunctionHandler.h"
#include "PFunctionGrammar.h"
#include "PFunction.h"

//-------------------------------------------------------------
class PMsrHandler
{
  public:
    PMsrHandler(const Char_t *fileName, PStartupOptions *startupOptions=0, const Bool_t fourierOnly=false);
    virtual ~PMsrHandler();

    virtual Int_t ReadMsrFile();
    virtual Int_t WriteMsrLogFile(const Bool_t messages = true);
    virtual Int_t WriteMsrFile(const Char_t *filename, std::map<UInt_t, TString> *commentsPAR = 0, std::map<UInt_t, TString> *commentsTHE = 0, \
                                                       std::map<UInt_t, TString> *commentsFUN = 0, std::map<UInt_t, TString> *commentsRUN = 0);

    virtual TString*                GetMsrTitle() { return &fTitle; }
    virtual PMsrParamList*          GetMsrParamList() { return &fParam; }
    virtual PMsrLines*              GetMsrTheory() { return &fTheory; }
    virtual PMsrLines*              GetMsrFunctions() { return &fFunctions; }
    virtual PMsrGlobalBlock*        GetMsrGlobal() { return &fGlobal; }
    virtual PMsrRunList*            GetMsrRunList() { return &fRuns; }
    virtual PMsrLines*              GetMsrCommands() { return &fCommands; }
    virtual PMsrFourierStructure*   GetMsrFourierList() { return &fFourier; }
    virtual PMsrPlotList*           GetMsrPlotList() { return &fPlots; }
    virtual PMsrStatisticStructure* GetMsrStatistic() { return &fStatistic; }

    virtual TString* GetMsrFileDirectoryPath() { return &fMsrFileDirectoryPath; }

    virtual UInt_t GetNoOfRuns() { return fRuns.size(); }

    virtual UInt_t GetNoOfParams() { return fParam.size(); }
    virtual const TString& GetFileName() const { return fFileName; }

    virtual void SetMsrTitle(const TString &title) { fTitle = title; }

    virtual Bool_t SetMsrParamValue(UInt_t i, Double_t value);
    virtual Bool_t SetMsrParamStep(UInt_t i, Double_t value);
    virtual Bool_t SetMsrParamPosErrorPresent(UInt_t i, Bool_t value);
    virtual Bool_t SetMsrParamPosError(UInt_t i, Double_t value);

    virtual void SetMsrT0Entry(UInt_t runNo, UInt_t idx, Double_t bin);
    virtual void SetMsrAddT0Entry(UInt_t runNo, UInt_t addRunIdx, UInt_t histoIdx, Double_t bin);
    virtual void SetMsrDataRangeEntry(UInt_t runNo, UInt_t idx, Int_t bin);
    virtual void SetMsrBkgRangeEntry(UInt_t runNo, UInt_t idx, Int_t bin);

    virtual void CopyMsrStatisticBlock() { fCopyStatisticsBlock = true; }
    virtual void SetMsrStatisticConverged(Bool_t converged) { fStatistic.fValid = converged; }
    virtual void SetMsrStatisticMin(Double_t min) { fStatistic.fMin = min; }
    virtual void SetMsrStatisticNdf(UInt_t ndf) { fStatistic.fNdf = ndf; }

    virtual Int_t GetNoOfFuncs() { return fFuncHandler->GetNoOfFuncs(); }
    virtual UInt_t GetFuncNo(Int_t idx) { return fFuncHandler->GetFuncNo(idx); }
    virtual UInt_t GetFuncIndex(Int_t funNo) { return fFuncHandler->GetFuncIndex(funNo); }
    virtual Bool_t CheckMapAndParamRange(UInt_t mapSize, UInt_t paramSize)
                       { return fFuncHandler->CheckMapAndParamRange(mapSize, paramSize); }
    virtual Double_t EvalFunc(UInt_t i, std::vector<Int_t> map, std::vector<Double_t> param, PMetaData metaData)
                       { return fFuncHandler->Eval(i, map, param, metaData); }
    virtual UInt_t GetNoOfFitParameters(UInt_t idx);
    virtual Int_t ParameterInUse(UInt_t paramNo);
    virtual Bool_t CheckRunBlockIntegrity();
    virtual Bool_t CheckUniquenessOfParamNames(UInt_t &parX, UInt_t &parY);
    virtual Bool_t CheckMaps();
    virtual Bool_t CheckFuncs();
    virtual Bool_t CheckHistoGrouping();
    virtual Bool_t CheckAddRunParameters();
    virtual Bool_t CheckRRFSettings();
    virtual void CheckMaxLikelihood();

    virtual void GetGroupingString(Int_t runNo, TString detector, TString &groupingStr);
    virtual Bool_t EstimateN0();

  private:
    Bool_t                 fFourierOnly; 
    PStartupOptions       *fStartupOptions; 

    TString                fFileName;  
    TString                fMsrFileDirectoryPath; 
    TString                fTitle;     
    PMsrParamList          fParam;     
    PMsrLines              fTheory;    
    PMsrLines              fFunctions; 
    PMsrGlobalBlock        fGlobal;    
    PMsrRunList            fRuns;      
    PMsrLines              fCommands;  
    PMsrFourierStructure   fFourier;   
    PMsrPlotList           fPlots;     
    PMsrStatisticStructure fStatistic; 

    Int_t  fMsrBlockCounter; 

    std::unique_ptr<PFunctionHandler> fFuncHandler; 

    PIntVector fParamInUse; 

    Bool_t fCopyStatisticsBlock; 

    virtual Bool_t HandleFitParameterEntry(PMsrLines &line);
    virtual Bool_t HandleTheoryEntry(PMsrLines &line);
    virtual Bool_t HandleFunctionsEntry(PMsrLines &line);
    virtual Bool_t HandleGlobalEntry(PMsrLines &line);
    virtual Bool_t HandleRunEntry(PMsrLines &line);
    virtual Bool_t HandleCommandsEntry(PMsrLines &line);
    virtual Bool_t HandleFourierEntry(PMsrLines &line);
    virtual Bool_t HandlePlotEntry(PMsrLines &line);
    virtual Bool_t HandleStatisticEntry(PMsrLines &line);

    virtual void FillParameterInUse(PMsrLines &theory, PMsrLines &funcs, PMsrLines &run);

    virtual void InitFourierParameterStructure(PMsrFourierStructure &fourier);
    virtual void RemoveComment(const TString &str, TString &truncStr);
    virtual Bool_t ParseFourierPhaseValueVector(PMsrFourierStructure &fourier, const TString &str, Bool_t &error);
    virtual Bool_t ParseFourierPhaseParVector(PMsrFourierStructure &fourier, const TString &str, Bool_t &error);
    virtual Bool_t ParseFourierPhaseParIterVector(PMsrFourierStructure &fourier, const TString &str, Bool_t &error);

    virtual Bool_t FilterNumber(TString str, const Char_t *filter, Int_t offset, Int_t &no);

    virtual UInt_t NeededPrecision(Double_t dval, UInt_t precLimit=13);
    virtual UInt_t LastSignificant(Double_t dval, UInt_t precLimit=6);

    virtual void MakeDetectorGroupingString(TString str, PIntVector &group, TString &result, Bool_t includeDetector = true);
    virtual TString BeautifyFourierPhaseParameterString();

    virtual void CheckLegacyLifetimecorrection();
};

#endif // _PMSRHANDLER_H_