TRestComponent.h

/*************************************************************************
 * This file is part of the REST software framework.                     *
 *                                                                       *
 * Copyright (C) 2016 GIFNA/TREX (University of Zaragoza)                *
 * For more information see https://gifna.unizar.es/trex                 *
 *                                                                       *
 * REST 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 3 of the License, or     *
 * (at your option) any later version.                                   *
 *                                                                       *
 * REST 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 a copy of the GNU General Public License along with   *
 * REST in $REST_PATH/LICENSE.                                           *
 * If not, see https://www.gnu.org/licenses/.                            *
 * For the list of contributors see $REST_PATH/CREDITS.                  *
 *************************************************************************/
 
#ifndef REST_TRestComponent
#define REST_TRestComponent
 
#include <TCanvas.h>
#include <THn.h>
#include <TRandom3.h>
 
#include <ROOT/RDataFrame.hxx>
#include <ROOT/RVec.hxx>
 
#include "TRestDataSet.h"
#include "TRestMetadata.h"
#include "TRestResponse.h"
 
class TRestComponent : public TRestMetadata {
   protected:
    std::string fNature = "unknown";  //<
 
    std::vector<std::string> fVariables;  //<
 
    std::vector<TVector2> fRanges;  //<
 
    std::vector<Int_t> fNbins;  //<
 
    std::string fParameter = "";  //<
 
    std::vector<Double_t> fParameterizationNodes;  //<
 
    Double_t fFirstParameterValue = 0;  //<
 
    Double_t fLastParameterValue = 0;  //<
 
    Double_t fStepParameterValue = 0;  //<
 
    Bool_t fExponential = false;  //<
 
    Int_t fActiveNode = -1;  //<
 
    std::vector<THnD*> fNodeDensity;  //<
 
    Int_t fSamples = 0;  //<
 
    Bool_t fInterpolation = true;  //<
 
    TRestResponse* fResponse = nullptr;  //<
 
    Float_t fPrecision = 0.01;  //<
 
    TRandom3* fRandom = nullptr;  
 
    UInt_t fSeed = 0;  //<
 
    TCanvas* fCanvas = nullptr;  
 
    Bool_t HasDensity() { return !fNodeDensity.empty(); }
 
    Bool_t ValidNode(Double_t node) {
        SetActiveNode(node);
        if (GetActiveNode() >= 0) return true;
        return false;
    }
 
    Int_t GetVariableIndex(std::string varName);
 
    void InitFromConfigFile() override;
 
    virtual void FillHistograms() = 0;
 
   public:
    void Initialize() override;
    void RegenerateHistograms(UInt_t seed = 0);
 
    void RegenerateParametricNodes(Double_t from, Double_t to, Double_t step, Bool_t expIncrease = false);
 
    Bool_t HasNodes() { return !fParameterizationNodes.empty(); }
 
    virtual void RegenerateActiveNodeDensity() {}
 
    std::string GetNature() const { return fNature; }
    TRestResponse* GetResponse() const { return fResponse; }
    Float_t GetPrecision() { return fPrecision; }
    size_t GetDimensions() { return fVariables.size(); }
    Int_t GetSamples() { return fSamples; }
    Int_t GetActiveNode() { return fActiveNode; }
    Double_t GetActiveNodeValue() {
        if (fActiveNode >= 0 && fActiveNode < (Int_t)fParameterizationNodes.size())
            return fParameterizationNodes[fActiveNode];
        return 0;
    }
    std::vector<Double_t> GetParameterizationNodes() { return fParameterizationNodes; }
 
    std::vector<std::string> GetVariables() const { return fVariables; }
    std::vector<TVector2> GetRanges() const { return fRanges; }
    std::vector<Int_t> GetNbins() const { return fNbins; }
 
    Double_t GetRawRate(std::vector<Double_t> point);
    Double_t GetTotalRate();
    Double_t GetMaxRate();
    Double_t GetAllNodesIntegratedRate();
    Double_t GetNormalizedRate(std::vector<Double_t> point);
    Double_t GetRate(std::vector<Double_t> point);
 
    Double_t GetBinCenter(Int_t nDim, const Int_t bin);
 
    void SetPrecision(const Float_t& pr) { fPrecision = pr; }
 
    Int_t FindActiveNode(Double_t node);
    Int_t SetActiveNode(Double_t node);
    Int_t SetActiveNode(Int_t n) {
        fActiveNode = n;
        return fActiveNode;
    }
 
    void SetSamples(Int_t samples) { fSamples = samples; }
 
    Bool_t Interpolation() { return fInterpolation; }
    void EnableInterpolation() { fInterpolation = true; }
    void DisableInterpolation() { fInterpolation = false; }
 
    THnD* GetDensityForNode(Double_t value);
    THnD* GetDensityForActiveNode();
    THnD* GetDensity() { return GetDensityForActiveNode(); }
 
    TH1D* GetHistogram(Double_t node, std::string varName);
    TH2D* GetHistogram(Double_t node, std::string varName1, std::string varName2);
    TH3D* GetHistogram(Double_t node, std::string varName1, std::string varName2, std::string varName3);
 
    TH1D* GetHistogram(std::string varName);
    TH2D* GetHistogram(std::string varName1, std::string varName2);
    TH3D* GetHistogram(std::string varName1, std::string varName2, std::string varName3);
 
    ROOT::RVecD GetRandom();
 
    ROOT::RDF::RNode GetMonteCarloDataFrame(Int_t N = 100);
 
    TCanvas* DrawComponent(std::vector<std::string> drawVariables, std::vector<std::string> scanVariables,
                           Int_t binScanSize = 1, TString drawOption = "");
 
    void LoadResponse(const TRestResponse& resp);
 
    void PrintMetadata() override;
 
    void PrintStatistics();
    void PrintNodes();
 
    TRestComponent(const char* cfgFileName, const std::string& name = "");
    TRestComponent();
    ~TRestComponent();
 
    ClassDefOverride(TRestComponent, 6);
};
#endif