EMCAL/AliEMCALRawUtils.h

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