EMCAL/AliEMCALRawUtils.h

   1 #ifndef ALIEMCALRAWUTILS_H
   2 #define ALIEMCALRAWUTILS_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice     */
   5
   6 /* $Id$ */
   7
   8 //_________________________________________________________________________
   9 //  Utility Class for handling Raw data
  10 //  Does all transitions from Digits to Raw and vice versa,
  11 //  for simu and reconstruction
  12 //
  13 //  Note: the current version is still simplified. Only
  14 //    one raw signal per digit is generated; either high-gain or low-gain
  15 //    Need to add concurrent high and low-gain info in the future
  16 //    No pedestal is added to the raw signal.
  17 //
  18 //*-- Author: Marco van Leeuwen (LBL)
  19 //
  20 #include "TObject.h" // for ROOT types
  21 #include <TString.h>
  22 //#include "AliCaloRawStreamV3.h"
  23 class AliCaloRawStreamV3;
  24 class AliAltroMapping;
  25 class TGraph;
  26 class AliRawReader;
  27 class AliEMCALGeometry;
  28 class AliCaloCalibPedestal;
  29 class AliCaloRawAnalyzer;
  30
  31 class AliEMCALRawUtils : public TObject {
  32  public:
  33   enum fitAlgorithm {kStandard = 0, kFastFit= 1, kNeuralNet = 2, kLogFit = 3, kLMS = 4, kPeakFinder = 5, kCrude = 6};
  34
  35  AliEMCALRawUtils(fitAlgorithm fitAlgo = kStandard);
  36   AliEMCALRawUtils(AliEMCALGeometry *pGeometry, fitAlgorithm fitAlgo = kStandard);
  37   virtual ~AliEMCALRawUtils();
  38
  39   AliEMCALRawUtils(const AliEMCALRawUtils& rawUtils);  //copy ctor
  40   AliEMCALRawUtils& operator =(const AliEMCALRawUtils& rawUtils);
  41
  42   void Digits2Raw();
  43   void Raw2Digits(AliRawReader *reader, TClonesArray *digitsArr, const AliCaloCalibPedestal* pedbadmap,
  44                                   TClonesArray *digitsTRG=0x0);
  45
  46   void AddDigit(TClonesArray *digitsArr, Int_t id, Int_t lowGain, Float_t amp, Float_t time);
  47   void AddDigit(TClonesArray *digitsArr, Int_t id, Int_t timeSamples[], Int_t nSamples);
  48   void TrimDigits(TClonesArray *digitsArr);
  49
  50   // Signal shape parameters
  51   Double_t GetRawFormatHighLowGainFactor() const { return fHighLowGainFactor ;}
  52   Int_t    GetRawFormatOrder()             const { return fOrder ; }
  53   Double_t GetRawFormatTau()               const { return fTau ; }
  54   Int_t    GetNoiseThreshold()             const { return fNoiseThreshold; }
  55   Int_t    GetNPedSamples()                const { return fNPedSamples; }
  56
  57   // get methods for fast fit simulation
  58   Int_t    GetPedestalValue()     const {return fgPedestalValue;}
  59   Double_t GetFEENoise()          const {return fgFEENoise;}
  60
  61   Bool_t   GetRemoveBadChannels() const {return fRemoveBadChannels;}
  62   Int_t    GetFittingAlgorithm()  const {return fFittingAlgorithm; }
  63   Float_t  GetTimeMax()           const {return fTimeMax ;}
  64   Float_t  GetTimeMin()           const {return fTimeMin ;}
  65   Bool_t   UseFALTRO()            const {return fUseFALTRO; }
  66
  67   void SetRawFormatHighLowGainFactor(Double_t val) {fHighLowGainFactor=val;}
  68   void SetRawFormatOrder(Int_t val)                {fOrder=val; }
  69   void SetRawFormatTau(Double_t val)               {fTau=val; }
  70   void SetNoiseThreshold(Int_t val)                {fNoiseThreshold=val; }
  71   void SetNPedSamples(Int_t val)                   {fNPedSamples=val; }
  72   void SetRemoveBadChannels(Bool_t val)            {fRemoveBadChannels=val; }
  73   void SetFittingAlgorithm(Int_t val) ;
  74   void SetTimeMin(Float_t t)                       {fTimeMin   = t          ;}
  75   void SetTimeMax(Float_t t)                       {fTimeMax   = t          ;}
  76   void SetFALTROUsage(Bool_t val)                  {fUseFALTRO=val; }
  77
  78   // set methods for fast fit simulation
  79   void SetFEENoise(Double_t val)                   {fgFEENoise = val;}
  80   void SetRawFormatTimeBins(Int_t val)             {fgTimeBins = val;}
  81   void SetPedestalValue(Int_t val)                 {fgPedestalValue = val;}
  82
  83   static Int_t GetRawFormatTimeBins()        { return fgTimeBins ; }
  84   static Double_t GetRawFormatTimeMax()      { return fgTimeBins*fgTimeBinWidth; }
  85   static Double_t GetRawFormatTimeBinWidth() { return fgTimeBinWidth; }
  86   static Double_t GetRawFormatTimeBin()
  87   { return GetRawFormatTimeMax() / GetRawFormatTimeBins(); }
  88   Double_t GetRawFormatTimeTrigger()    const { return fgTimeTrigger ; }
  89   Int_t GetRawFormatThreshold()         const { return fgThreshold ; }
  90   Int_t GetRawFormatDDLPerSuperModule() const { return fgDDLPerSuperModule ; }
  91   AliCaloRawAnalyzer *GetRawAnalyzer()  const { return fRawAnalyzer;}
  92
  93   virtual Option_t* GetOption() const { return fOption.Data(); }
  94   void SetOption(const Option_t* opt) { fOption = opt; }
  95
  96   // Signal shape functions
  97
  98   void FitRaw(const Int_t firstTimeBin, const Int_t lastTimeBin, Float_t & amp, Float_t & time, Bool_t & fitDone) const ;
  99   void FitParabola(const TGraph *gSig, Float_t & amp) const ;
 100   static Double_t RawResponseFunction(Double_t *x, Double_t *par);
 101   static Double_t RawResponseFunctionLog(Double_t *x, Double_t *par);
 102   Bool_t   RawSampledResponse(Double_t dtime, Double_t damp, Int_t * adcH, Int_t * adcL, const Int_t keyErr=0) const;
 103
 104   static void CalculateChi2(const Double_t* t,const Double_t* y,const Int_t nPoints,
 105                             const Double_t sig, const Double_t tau, const Double_t amp, const Double_t t0, Double_t &chi2);
 106
 107  private:
 108   Double_t fHighLowGainFactor ;         // high to low gain factor for the raw RO signal
 109   Int_t fOrder ;                        // order of the gamma function for the RO signal
 110   Double_t fTau ;                       // tau parameter of gamma function for the RO signal
 111   Int_t fNoiseThreshold;                // threshold to consider signal or noise
 112   Int_t fNPedSamples;                   // number of samples to use in pedestal calculation
 113
 114   static const Int_t fgkOverflowCut = 950;  // cut to discriminate overflowed channels
 115   static const Int_t fgkRawSignalOverflow = 0x3FF; // maximum signal (10 bits)
 116   static Int_t fgTimeBins; // number of sampling bins of the raw RO signal
 117
 118   static Double_t fgTimeTrigger ;       // time of the trigger for the RO signal
 119   static Double_t fgTimeBinWidth;       // maximum sampled time of the raw RO signal
 120   static Int_t fgThreshold;             // threshold
 121   static Int_t fgDDLPerSuperModule;     // number of DDL per SuperModule
 122   static Int_t fgPedestalValue;         // pedestal value for Digits2Raw
 123   static Double_t fgFEENoise;           // electronics noise in ADC units
 124
 125   AliEMCALGeometry* fGeom;              // geometry
 126   AliAltroMapping*  fMapping[4];        // only two for now
 127
 128   TString fOption;                      //! option passed from Reconstructor
 129
 130   Bool_t  fRemoveBadChannels;           // select if bad channels are removed before fitting
 131   Int_t   fFittingAlgorithm;            // select the fitting algorithm
 132   Float_t fTimeMin;                     // minimum threshold for the time of the signal
 133   Float_t fTimeMax;                     // maximum threshold for the time of the signal
 134   Bool_t  fUseFALTRO;                   // use FALTRO and pass it to the digits
 135
 136   AliCaloRawAnalyzer *fRawAnalyzer;     // e.g. for sample selection for fits
 137
 138   ClassDef(AliEMCALRawUtils,7)          // utilities for raw signal fitting
 139 };
 140
 141 #endif