R3BFileSource.h

Go to the documentation of this file.

/******************************************************************************
 *   Copyright (C) 2019 GSI Helmholtzzentrum für Schwerionenforschung GmbH    *
 *   Copyright (C) 2019-2025 Members of R3B Collaboration                     *
 *                                                                            *
 *             This software is distributed under the terms of the            *
 *                 GNU General Public Licence (GPL) version 3,                *
 *                    copied verbatim in the file "LICENSE".                  *
 *                                                                            *
 * In applying this license GSI does not waive the privileges and immunities  *
 * granted to it by virtue of its status as an Intergovernmental Organization *
 * or submit itself to any jurisdiction.                                      *
 ******************************************************************************/
 
// -----------------------------------------------------------
// -----                 R3BFileSource                   -----
// -----    Created 12/05/21 by J.L. Rodriguez-Sanchez   -----
// -----------------------------------------------------------
 
#ifndef R3BFileSource_H
#define R3BFileSource_H 1
 
#include "FairSource.h"
#include "TChain.h"
#include "TF1.h"
#include "TFile.h"
#include "TFolder.h"
#include "TMCtls.h"
#include <fstream>
#include <list>
 
class FairEventHeader;
class FairFileHeader;
class FairMCEventHeader;
class TString;
class FairLogger;
class FairRuntimeDb;
class R3BEventHeader;
 
class R3BFileSource : public FairSource
{
  public:
    R3BFileSource(TFile* f, const char* Title = "InputRootFile", UInt_t identifier = 0);
    R3BFileSource(const TString* RootFileName, const char* Title = "InputRootFile", UInt_t identifier = 0);
    R3BFileSource(const TString RootFileName, const char* Title = "InputRootFile", UInt_t identifier = 0);
 
    ~R3BFileSource() override;

    static R3BFileSource* Instance();
 
    Bool_t Init() override;
    Int_t ReadEvent(UInt_t i = 0) override;
    void Close() override;
    void Reset() override;
 
    Source_Type GetSourceType() override { return kFILE; }
 
    void SetParUnpackers() override {}
 
    Bool_t InitUnpackers() override { return kTRUE; }
 
    Bool_t ReInitUnpackers() override { return kTRUE; }

    Int_t CheckMaxEventNo(Int_t EvtEnd = 0) override;
    void ReadBranchEvent(const char* BrName) override;
    void ReadBranchEvent(const char* BrName, Int_t Entry) override;
    void FillEventHeader(FairEventHeader* feh) override;
 
    const TFile* GetRootFile() { return fRootFile; }
    void AddFriend(TString FileName);
    void AddFile(TString FileName);
    void AddFriendsToChain();
    void PrintFriendList();
    Bool_t CompareBranchList(TFile* fileHandle, TString inputLevel);
    void CheckFriendChains();
    void CreateNewFriendChain(TString inputFile, TString inputLevel);
    TTree* GetInTree() { return fInChain->GetTree(); }
    TChain* GetInChain() { return fInChain; }
    TFile* GetInFile() { return fRootFile; }
    void CloseInFile()
    {
        if (fRootFile)
        {
            fRootFile->Close();
        }
    }

    void SetInTree(TTree* tempTree);
    TObjArray* GetListOfFolders() { return fListFolder; }
    TFolder* GetBranchDescriptionFolder() { return fFolderIn; }
    UInt_t GetEntries() { return fNoOfEntries; }
 
    void SetInputFile(TString name);

    void SetBeamTime(Double_t beamTime, Double_t gapTime);
    void SetEventTimeInterval(Double_t min, Double_t max);
    void SetEventMeanTime(Double_t mean);
    void SetEventTime();
    Double_t GetDeltaEventTime();
    void SetFileHeader(FairFileHeader* f) { fFileHeader = f; }
    Double_t GetEventTime();
 
    Bool_t ActivateObject(TObject** obj, const char* BrName) override;

    void SetEvtHeaderNew(Bool_t Status) { fEvtHeaderIsNew = Status; }
    Bool_t IsEvtHeaderNew() { return fEvtHeaderIsNew; }

    void SetCheckFileLayout(Bool_t enable) { fCheckFileLayout = enable; }
 
    void SetInputFileName(TString tstr) { fInputFileName = tstr; }

#if ROOT_VERSION_CODE <= ROOT_VERSION(6, 22, 8)
    Bool_t SpecifyRunId();
#else
    Bool_t SpecifyRunId() override;
#endif
 
  private:
    // static pointer to this class
    static TMCThreadLocal R3BFileSource* fSourceInstance;
    TString fInputTitle;
    TFile* fRootFile;
    Int_t fCurrentEntryNr; 
    std::list<TString> fFriendFileList;                               
    std::list<TString> fInputChainList;                               
    std::map<TString, TChain*> fFriendTypeList;                       
    std::map<TString, std::list<TString>*> fCheckInputBranches;       
    std::list<TString> fInputLevel;                                   
    std::map<TString, std::multimap<TString, TArrayI>> fRunIdInfoAll; 
    TChain* fInChain;
    TTree* fInTree;
    TObjArray* fListFolder; 
    FairRuntimeDb* fRtdb;
    TFolder* fFolderOut;
    TFolder* fFolderIn;
    /***/
    UInt_t fSourceIdentifier;
    UInt_t fNoOfEntries;
    Bool_t IsInitialized;

    FairMCEventHeader* fMCHeader; 

    R3BEventHeader* fEvtHeader; 

    FairFileHeader* fFileHeader; 

    Bool_t fEventTimeInMCHeader; 
    Bool_t fEvtHeaderIsNew; 

    UInt_t fCurrentEntryNo; 
    UInt_t fTimeforEntryNo; 

    Double_t fEventTimeMin; 
    Double_t fEventTimeMax; 
    Double_t fEventTime; 
    Double_t fBeamTime; 
    Double_t fGapTime; 
    Double_t fEventMeanTime; 
    TF1* fTimeProb; 
    Bool_t fCheckFileLayout; 

    Int_t GetRunid(uint64_t ts);

    std::ifstream fInputFile;
    TString fInputFileName;
 
    UInt_t fExpid;
    std::vector<UInt_t> fRunid;
    std::vector<uint64_t> fTimestamp;
    uint64_t prevts, nextts;
 
    R3BFileSource(const R3BFileSource&);
    R3BFileSource operator=(const R3BFileSource&);
 
    ClassDefOverride(R3BFileSource, 0)
};
 
#endif /* R3BFileSource_H */