TRestExperiment.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_TRestExperiment
#define REST_TRestExperiment
 
#include <TRandom3.h>
 
#include "TRestComponent.h"
#include "TRestDataSet.h"
#include "TRestMetadata.h"
 
class TRestExperiment : public TRestMetadata {
   private:
    Double_t fExposureTime = 0;  //<
 
    TRestComponent* fBackground = nullptr;  //<
 
    TRestComponent* fSignal = nullptr;  //<
 
    std::string fExperimentalDataSet = "";  //<
 
    TRestDataSet fExperimentalData;  //<
 
    Bool_t fMockData = false;  //<
 
    Bool_t fDataReady = false;  //<
 
    Bool_t fUseAverage = false;  //<
 
    Int_t fExperimentalCounts = 0;  //<
 
    TRandom3* fRandom = nullptr;  
 
    UInt_t fSeed = 0;  //<
 
   protected:
    void InitFromConfigFile() override;
 
   public:
    void GenerateMockDataSet(Bool_t useAverage = false);
    Int_t GetExperimentalCounts() const { return fExperimentalCounts; }
 
    Bool_t IsMockData() const { return fMockData; }
    Bool_t IsDataReady() const { return fDataReady; }
 
    void SetExposureInSeconds(const Double_t exposure) { fExposureTime = exposure / units("s"); }
    void SetSignal(TRestComponent* comp) { fSignal = comp; }
    void SetBackground(TRestComponent* comp) { fBackground = comp; }
 
    void SetExperimentalDataSet(const std::string& filename);
 
    Double_t GetExposureInSeconds() const { return fExposureTime * units("s"); }
    TRestComponent* GetBackground() const { return fBackground; }
    TRestComponent* GetSignal() const { return fSignal; }
    TRestDataSet GetExperimentalDataSet() const { return fExperimentalData; }
    ROOT::RDF::RNode GetExperimentalDataFrame() const { return fExperimentalData.GetDataFrame(); }
 
    void PrintExperimentalData() { GetExperimentalDataFrame().Display("")->Print(); }
 
    void Initialize() override;
 
    void PrintMetadata() override;
 
    TRestExperiment(const char* cfgFileName, const std::string& name = "");
    TRestExperiment();
    ~TRestExperiment();
 
    ClassDefOverride(TRestExperiment, 2);
};
#endif