TEcnaRead.h

Go to the documentation of this file.

#ifndef   CL_TEcnaRead_H
#define   CL_TEcnaRead_H

#include <time.h>
#include <math.h>

#include "TSystem.h"
#include "TObject.h"
#include "TString.h"
#include "Riostream.h"
#include "TVectorD.h"
#include "TMatrixD.h"

#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaObject.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaParEcal.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaHeader.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaParCout.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaParPaths.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaNumbering.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaParHistos.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaWrite.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaResultType.h"
#include "CalibCalorimetry/EcalCorrelatedNoiseAnalysisAlgos/interface/TEcnaRootFile.h"


class TEcnaRead: public TObject {
  
 private:

  //............ attributes

  // static  const  Int_t        fgMaxCar    = 512;          <== DANGEROUS ! 

  Int_t fgMaxCar;   // Max nb of caracters for char*

  Int_t fCnew;      // flags for dynamical allocation
  Int_t fCdelete;       

  TString fTTBELL;

  TEcnaObject    *fObjectManager;  // pointer to TEcnaObject keeped in attribute

  TEcnaParCout   *fCnaParCout;  // for comments or error messages
  TEcnaParPaths  *fCnaParPaths; // for NbBinsADC 

  TEcnaHeader    *fFileHeader;    // header for result file
  TEcnaParEcal   *fEcal;          // for Ecal parameters
  TEcnaNumbering *fEcalNumbering; // for Ecal numbering
  TEcnaParHistos *fCnaParHistos;  // for Histo codes
  TEcnaWrite     *fCnaWrite;      // for writing in ascii files

  //  TEcnaRootFile *gCnaRootFile;

  TString fFlagSubDet;
  TString fStexName, fStinName;

  Bool_t  fOpenRootFile; // flag open ROOT file (open = kTRUE, close = kFALSE)
  TString fCurrentlyOpenFileName; // Name of the file currently open
  TString fFlagNoFileOpen; // Flag to indicate that no file is open

  Int_t fReadyToReadRootFile;
  Int_t fLookAtRootFile;

  Int_t* fT1d_StexStinFromIndex; // 1D array[Stin] Stin Number as a function of the index Stin
  Int_t* fTagStinNumbers;
  Int_t  fMemoStinNumbers;

  //  Int_t fMemoReadNumberOfEventsforSamples;

  TString fPathRoot;  // path for results .root files directory

  Int_t fNbChanByLine;  // Nb channels by line (for ASCII results file)
  Int_t fNbSampByLine;  // Nb samples by line  (for ASCII results file)

  Int_t fFlagPrint;
  Int_t fCodePrintComments, fCodePrintWarnings, fCodePrintAllComments, fCodePrintNoComment;

  //............... flag data exists

  Bool_t fDataExist;

  //................ 3d array for sample ADC value fast transfert
  Double_t*** fT3d_AdcValues;   // 3D array[channel][sample][event] ADC values distibutions
  Double_t**  fT3d2_AdcValues; 
  Double_t*   fT3d1_AdcValues;

  //==========================================================================================
  //
  //                                      M E T H O D S
  //
  //==========================================================================================
  //.......................................... private methods

  void        fCopy(const TEcnaRead&);

 public: 

  //................. constructors
  TEcnaRead();                  //  constructor without argument (FOR USER'S DECLARATION)
  //  constructor with argument (FOR USER'S DECLARATION):
  TEcnaRead(TEcnaObject*, const TString);

  TEcnaRead(const TEcnaRead&);   //  copy constructor

  //.................... C++ methods
  TEcnaRead&  operator=(const TEcnaRead&);  //  overloading of the operator=

  //................. destructor
  virtual ~TEcnaRead();
  
  //========================================================================
  //
  //                    METHODS FOR THE USER
  //
  //========================================================================
  void     FileParameters(TString,
              const Int_t&, const Int_t&, const Int_t&,
              const Int_t&, const Int_t&, const Int_t&, TString);
  
  Bool_t   LookAtRootFile();  // if file exists: kTRUE , if not: kFALSE
  Bool_t   DataExist();       // if data exist:  kTRUE , if not: kFALSE

  TVectorD Read1DHisto(const Int_t&, const TString, const Int_t&, const Int_t&, const Int_t&);
  TVectorD Read1DHisto(const Int_t&, const TString, const Int_t&);
  TVectorD Read1DHisto(const Int_t&, const TString, const TString);

  TMatrixD ReadMatrix(const Int_t&, const TString, const TString, const Int_t&, const Int_t&);
  TMatrixD ReadMatrix(const Int_t&, const TString, const TString);

  //========================================================================
  //
  //                       "TECHNICAL" METHODS
  //
  //========================================================================
  //...................................................... methods that will (should) be private
  void     Init();
  void     SetEcalSubDetector(const TString);

  void     Anew(const TString);
  void     Adelete(const TString);

  Bool_t   OpenRootFile(const Text_t *, TString);
  Bool_t   CloseRootFile(const Text_t *);
  void     TestArrayDimH1(const TString, const TString, const Int_t&, const Int_t&);
  void     TestArrayDimH2(const TString, const TString, const Int_t&, const Int_t&);

  Bool_t   ReadRootFileHeader(const Int_t&);

  TVectorD ReadSampleAdcValues(const Int_t&, const Int_t&, const Int_t&, const Int_t&);  //(nb evts in burst) of (StinEcha,samp)
  //------------------------------------------------------------------------------------------------
  TVectorD ReadSampleMeans(const Int_t&,  const Int_t&, const Int_t&);    // (sample) of (StexStin,Xtal)
  TVectorD ReadSampleMeans(const Int_t&,  const Int_t&);                  // (MaxCrysInStin*sample) of (StexStin)

  TVectorD ReadSampleSigmas(const Int_t&, const Int_t&, const Int_t&);    // (sample) of (StexStin,Xtal)
  TVectorD ReadSampleSigmas(const Int_t&, const Int_t&);                  // (MaxCrysInStin*sample) of (StexStin)

  //------------------------------------------------------------------------------------------------
  TVectorD ReadNumberOfEvents(const Int_t&);                    // EcnaStexCrys of (StexEcha)
  TVectorD ReadPedestals(const Int_t&);                         // EcnaStexCrys of (StexEcha)
  TVectorD ReadTotalNoise(const Int_t&);                        // EcnaStexCrys of (StexEcha)
  TVectorD ReadLowFrequencyNoise(const Int_t&);                 // EcnaStexCrys of (StexEcha)
  TVectorD ReadHighFrequencyNoise(const Int_t&);                // EcnaStexCrys of (StexEcha)
  TVectorD ReadMeanCorrelationsBetweenSamples(const Int_t&);    // EcnaStexCrys of (StexEcha)
  TVectorD ReadSigmaOfCorrelationsBetweenSamples(const Int_t&); // EcnaStexCrys of (StexEcha)

  //------------------------------------------------------------------------------------------------
  TVectorD ReadAverageNumberOfEvents(const Int_t&);                    // EcnaStexStin of (StexStin)
  TVectorD ReadAveragePedestals(const Int_t&);                         // EcnaStexStin of (StexStin)
  TVectorD ReadAverageTotalNoise(const Int_t&);                        // EcnaStexStin of (StexStin)
  TVectorD ReadAverageLowFrequencyNoise(const Int_t&);                 // EcnaStexStin of (StexStin)
  TVectorD ReadAverageHighFrequencyNoise(const Int_t&);                // EcnaStexStin of (StexStin)
  TVectorD ReadAverageMeanCorrelationsBetweenSamples(const Int_t&);    // EcnaStexStin of (StexStin)
  TVectorD ReadAverageSigmaOfCorrelationsBetweenSamples(const Int_t&); // EcnaStexStin of (StexStin)

  //------------------------------------------------------------------------------------------------
  TMatrixD ReadCovariancesBetweenSamples(const Int_t&, const Int_t&, const Int_t&);  // (samp,samp) of (StexStin,Xtal)
  TMatrixD ReadCorrelationsBetweenSamples(const Int_t&, const Int_t&, const Int_t&); // (samp,samp) of (StexStin,Xtal)

  //-----------------------------------------------------------------------------------------------
  TMatrixD ReadLowFrequencyCovariancesBetweenChannels(const Int_t&, const Int_t&, const Int_t&);
  TMatrixD ReadHighFrequencyCovariancesBetweenChannels(const Int_t&, const Int_t&, const Int_t&);
                                       // (Xtal in Stin X, Xtal in Stin Y) of (Stin_X, Stin_Y)

  TMatrixD ReadLowFrequencyCorrelationsBetweenChannels(const Int_t&, const Int_t&, const Int_t&);
  TMatrixD ReadHighFrequencyCorrelationsBetweenChannels(const Int_t&, const Int_t&, const Int_t&);
                                       // (Xtal in Stin X, Xtal in Stin Y) of (Stin_X, Stin_Y)

  //------------------- (BIG MATRIX 1700x1700 for barrel, 5000x5000? for endcap) ------------------
  TMatrixD ReadLowFrequencyCovariancesBetweenChannels(const Int_t&);  // (Xtal in Stin X, Xtal in Stin Y) for all Stins
  TMatrixD ReadHighFrequencyCovariancesBetweenChannels(const Int_t&);
  TMatrixD ReadLowFrequencyCorrelationsBetweenChannels(const Int_t&); // (Xtal in Stin X, Xtal in Stin Y) for all Stins
  TMatrixD ReadHighFrequencyCorrelationsBetweenChannels(const Int_t&);

  //-----------------------------------------------------------------------------------------------
  TMatrixD ReadLowFrequencyMeanCorrelationsBetweenStins(const Int_t&);  // 1 of (Stin,Stin) 
  TMatrixD ReadHighFrequencyMeanCorrelationsBetweenStins(const Int_t&); // 1 of (Stin,Stin) 

  //------------------------------------------------------------------------------------------------
  TString  GetAnalysisName();
  Int_t    GetNbOfSamples();
  Int_t    GetRunNumber();
  Int_t    GetFirstReqEvtNumber();
  Int_t    GetLastReqEvtNumber();
  Int_t    GetReqNbOfEvts();
  Int_t    GetStexNumber();

  time_t   GetStartTime();
  time_t   GetStopTime();
  TString  GetStartDate();
  TString  GetStopDate();
  TString  GetRootFileName();
  TString  GetRootFileNameShort();

  TString  GetRunType();

  //-------------------------------------------------------------------------------  "technical" methods
  TVectorD ReadRelevantCorrelationsBetweenSamples(const Int_t&, const Int_t&, const Int_t&);
  // N(N-1)/2 of (StexStin, Xtal)

  Int_t    GetStexStinFromIndex(const Int_t&);      // (no read in the ROOT file)
  Int_t    GetStinIndex(const Int_t&);              // Stin index from Stin number (StexStin)

  TVectorD ReadStinNumbers(const Int_t&);
  TMatrixD ReadNumberOfEventsForSamples(const Int_t&, const Int_t&, const Int_t&); // (Xtal,sample) of (StexStin)

  Double_t*** ReadSampleAdcValuesSameFile(const Int_t&, const Int_t&, const Int_t&); 

  Int_t   GetNumberOfEvents(const Int_t&, const Int_t&);
  Int_t   GetNumberOfBinsSampleAsFunctionOfTime();

  TString GetTypeOfQuantity(const CnaResultTyp);

  TString GetTechReadCode(const TString, const TString);

  //------------------------------------------------------------------------------------------------
  //............... Flags Print Comments/Debug

  void  PrintNoComment();   // (default) Set flags to forbid the printing of all the comments
                            // except ERRORS
  void  PrintWarnings();    // Set flags to authorize printing of some warnings
  void  PrintComments();    // Set flags to authorize printing of infos and some comments
                            // concerning initialisations
  void  PrintAllComments(); // Set flags to authorize printing of all the comments

ClassDef(TEcnaRead,1) // Calculation of correlated noises from data
};  

#endif    //  CL_TEcnaRead_H