EMCAL/AliCaloCalibPedestal.h

   1 #ifndef ALICALOCALIBPEDESTAL_H
   2 #define ALICALOCALIBPEDESTAL_H
   3
   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 // \file AliCaloCalibPedestal.h
  11 //   \brief Description:
  12 //   A help class for monitoring and calibration tools: MOOD, AMORE etc.,
  13 //   that can process events from a standard AliCaloRawStreamV3,
  14 //   most usually from LED/pulser runs. It stores signal info as
  15 //   typical (highest) amplitude, and pedestal info in geometrically-binned
  16 //   2D profiles of the detectors (EMCAL and PHOS).
  17 //   Comparisons (ratios and differences) can be done with references.
  18
  19 //   \author: Timo Alho (Jyvaskyla), original version.
  20 //   [Consultant: D. Silvermyr (ORNL)]
  21 //   Partly based on AliTPCCalibPedestal.
  22 //
  23 //   \version $Revision$
  24 //   \date $Date$
  25
  26 #include "TProfile.h"
  27 #include "TProfile2D.h"
  28 #include "TH2.h"
  29 #include "TObjArray.h"
  30 #include "AliEMCALGeoParams.h"
  31 class AliCaloRawStreamV3;
  32 class AliCaloAltroMapping;
  33 class AliRawReader;
  34
  35 class AliCaloCalibPedestal : public TObject {
  36
  37  public:
  38
  39   enum kDetType {kPhos, kEmCal, kNone};//The detector types
  40   enum kDeadMapEntry{kAlive = 0, kDead, kHot, kWarning, kResurrected, kRecentlyDeceased, kNumDeadMapStates};//The entries being put to the deadmap
  41
  42   AliCaloCalibPedestal(kDetType detectorType = kPhos);
  43   virtual ~AliCaloCalibPedestal();
  44
  45   // copy ctor, and '=' operator, are not fully tested/debugged yet
  46   // at least for now; the reference info is not copied from one to the other
  47   AliCaloCalibPedestal(AliCaloCalibPedestal &ped);
  48   AliCaloCalibPedestal& operator = (AliCaloCalibPedestal &source);
  49
  50   // Event processing methods:
  51   Bool_t ProcessEvent(AliRawReader *rawReader);
  52   Bool_t ProcessEvent(AliCaloRawStreamV3    *in);
  53
  54   // Mapping handling
  55   AliCaloAltroMapping **GetAltroMapping() const { return fMapping; };
  56   void  SetAltroMapping(AliCaloAltroMapping **mapp) { fMapping = mapp; };
  57
  58   // Parameter/cut handling
  59   void SetParametersFromFile(const char *parameterFile);
  60   void WriteParametersToFile(const char *parameterFile);
  61
  62   ////////////////////////////
  63   //Simple getters
  64   // Main profiles:
  65   TProfile2D * GetPedProfileLowGain(int i) {ValidateProfiles(); return (TProfile2D*)fPedestalLowGain[i];};      // Return a pointer to the low-gain pedestal profile
  66   TProfile2D * GetPedProfileHighGain(int i) {ValidateProfiles(); return (TProfile2D*)fPedestalHighGain[i];};    // Return a pointer to the high-gain pedestal profile
  67   TProfile * GetPedLEDRefProfileLowGain(int i) {ValidateProfiles(); return (TProfile*)fPedestalLEDRefLowGain[i];};      // Return a pointer to the low-gain LEDRef profile
  68   TProfile * GetPedLEDRefProfileHighGain(int i) {ValidateProfiles(); return (TProfile*)fPedestalLEDRefHighGain[i];};    // Return a pointer to the high-gain LEDRef profile
  69   TProfile2D * GetPeakProfileLowGain(int i) {ValidateProfiles(); return (TProfile2D*)fPeakMinusPedLowGain[i];}; // Return a pointer to the low-gain peak-pedestal profile
  70   TProfile2D * GetPeakProfileHighGain(int i) {ValidateProfiles(); return (TProfile2D*)fPeakMinusPedHighGain[i];};       // Return a pointer to the high-gain peak-pedestal profile
  71
  72   // Differences to references:
  73   TProfile2D * GetPedProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainDiff[i];};     // Return a pointer to the low-gain pedestal profile difference
  74   TProfile2D * GetPedProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainDiff[i];};   // Return a pointer to the high-gain pedestal profile difference
  75   TProfile * GetPedLEDRefProfileLowGainDiff(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefLowGainDiff[i];};    // Return a pointer to the low-gain LEDRef profile difference
  76   TProfile * GetPedLEDRefProfileHighGainDiff(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefHighGainDiff[i];};  // Return a pointer to the high-gain LEDRef profile difference
  77   TProfile2D * GetPeakProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainDiff[i];};        // Return a pointer to the low-gain peak-pedestal profile difference
  78   TProfile2D * GetPeakProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainDiff[i];};      // Return a pointer to the high-gain peak-pedestal profile difference
  79
  80   // Ratio to references:
  81   TProfile2D * GetPedProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainRatio[i];};   // Return a pointer to the low-gain pedestal profile ratio
  82   TProfile2D * GetPedProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainRatio[i];}; // Return a pointer to the high-gain pedestal profile ratio
  83   TProfile * GetPedLEDRefProfileLowGainRatio(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefLowGainRatio[i];};  // Return a pointer to the low-gain LEDRef profile ratio
  84   TProfile * GetPedLEDRefProfileHighGainRatio(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefHighGainRatio[i];};        // Return a pointer to the high-gain LEDRef profile ratio
  85   TProfile2D * GetPeakProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainRatio[i];};      // Return a pointer to the low-gain peak-pedestal profile ratio
  86   TProfile2D * GetPeakProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainRatio[i];};    // Return a pointer to the high-gain peak-pedestal profile ratio
  87
  88   TH2F * GetPeakHighGainHisto(int i) {ValidateProfiles(); return (TH2F*)fPeakMinusPedHighGainHisto[i];};        // Return a pointer to the high-gain peak-pedestal histo
  89
  90
  91   TH2D * GetDeadMap(int i) {ValidateProfiles(); return (TH2D*)fDeadMap[i];}
  92   //void SetDeadMap(int i, TH2D *h) const {((TH2D*)fDeadMap[i])=h;}
  93
  94   Bool_t IsBadChannel(int imod, int icol, int irow) const;
  95   void SetChannelStatus(int imod, int icol, int irow, int status);
  96
  97   TObjArray GetDeadMap()  {ValidateProfiles(); return fDeadMap;}
  98   void SetDeadMap(TObjArray map) {fDeadMap = map;}
  99
 100   // Basic info: getters
 101   kDetType GetDetectorType() const {return fDetType;};//Returns if this is a PHOS or EMCAL object
 102   TString GetCaloString() const {return fCaloString;}; //Returns if this is a PHOS or EMCAL object
 103
 104   int GetColumns() const {return fColumns;}; //The number of columns per module
 105   int GetRows() const {return fRows;}; //The number of rows per module
 106   int GetLEDRefs() const {return fLEDRefs;}; //The number of LED references/monitors per module
 107   int GetModules() const {return fModules;}; //The number of modules
 108   int GetRowMin() const {return fRowMin;}; //for histo def.
 109   int GetRowMax() const {return fRowMax;}; //for histo def.
 110   int GetRowMultiplier() const {return fRowMultiplier;}; //for histo filling
 111
 112   // RunNumbers : setters and getters
 113   void SetRunNumber(int runNo) {fRunNumber = runNo;};
 114   int GetRunNumber() const {return fRunNumber;};
 115   int GetRefRunNumber() const {if (fReference) return fReference->GetRunNumber(); else return -1;};
 116
 117   // Possibility to select only some samples for the pedestal calculation
 118   void SetSelectPedestalSamples(Bool_t flag = kFALSE) {fSelectPedestalSamples = flag;} // select to to use only some range of samples for pedestal calc.
 119   Bool_t GetSelectPedestalSamples() const {return fSelectPedestalSamples;} // select to to use only some range of samples for pedestal calc.
 120   void SetFirstPedestalSample(int i) {fFirstPedestalSample = i;} // first sample to use
 121   void SetLastPedestalSample(int i) {fLastPedestalSample = i;} // last sample to use
 122   int GetFirstPedestalSample() const {return fFirstPedestalSample;}; // first sample to use
 123   int GetLastPedestalSample() const {return fLastPedestalSample;}; // last sample to use
 124
 125   //Set threshold/event fraction for tower warnings
 126   void SetDeadThreshold(int i) {fDeadThreshold = i;} // peak - pedestal dead threshold
 127   void SetWarningThreshold(int i) {fWarningThreshold = i;} // peak - pedestal warning threshold
 128   void SetWarningFraction(double d) {fWarningFraction = d;} // event fraction for warnings
 129   int GetDeadThreshold() const {return fDeadThreshold;}; // peak - pedestal dead threshold
 130   int GetWarningThreshold() const {return fWarningThreshold;}; // peak - pedestal warning threshold
 131   double GetWarningFraction() const {return fWarningFraction;}; // event fraction for warnings
 132   // hot towers
 133   void SetHotSigma(double d) {fHotSigma = d;} // rms away from normal
 134   double GetHotSigma() const {return fHotSigma;}; // rms away from normal
 135
 136   // Basic counters
 137   int GetNEvents() const {return fNEvents;};
 138   int GetNChanFills() const {return fNChanFills;};
 139
 140   /////////////////////////////
 141   //Analysis functions
 142   void SetDeadTowerCount(Int_t dead)  {fDeadTowers = dead;};//Returns the number of dead towers, by counting the bins in peak-pedestal smaller than threshold
 143   int GetDeadTowerCount() const {return fDeadTowers;};//Returns the number of dead towers, by counting the bins in peak-pedestal smaller than threshold
 144   double GetDeadTowerRatio() const {return fDeadTowers/(double)(fRows*fColumns);}; //returns the percentage of dead towers, relative to a full module
 145   int GetDeadTowerNew() const {return fNewDeadTowers;}; //return the new dead towers compared to the reference
 146   int GetDeadTowerResurrected() const {return fResurrectedTowers;}; //The the towers resurrected since the reference run
 147
 148   void Reset();//Resets the whole class.
 149   Bool_t AddInfo(AliCaloCalibPedestal *ped);//picks up new info from supplied argument
 150
 151   //////////////////////////////////////////////////////
 152   //Functions related to comparing this with another (reference) run.
 153   Bool_t LoadReferenceCalib(TString fileName, TString objectName); //Loads another AliCaloCalibPedestal by name "objectName" from the file "fileName", for reference
 154   void ComputeDiffAndRatio();//Actually computes the difference and ratio into the histo's in memory
 155   AliCaloCalibPedestal * GetReference() const {return fReference;}; //Get the reference object. Needed for debug, will probably be removed later
 156   Bool_t SetReference(AliCaloCalibPedestal *ref);
 157   void ComputeDeadTowers(const char * deadMapFile = 0);//Computes the dead tower values
 158   void ComputeHotAndWarningTowers(const char * hotMapFile = 0);//Computes the hot tower values
 159
 160   //Saving functions
 161   Bool_t SaveHistograms(TString fileName, Bool_t saveEmptyHistos = kFALSE); //Saves the histograms to a .root file
 162
 163   void Init() { ValidateProfiles(); } // do basic setup
 164
 165  private:
 166
 167   void ValidateProfiles(); //Makes sure that basic histos/profiles exist
 168   void CompressAndSetOwner(); //Makes sure that basic histos/profiles exist
 169   void ValidateComparisonProfiles(); //Makes sure that fPe..Diff and fPe..Ratio profiles exist
 170
 171   //The histograms. We use a TObjArray instead of a simple array,because this gives automatic streaming properties for the
 172   //class. A TClonesArray would be more efficient, but it's a bit more difficult to use and it doesn't matter too much
 173   //since we have only around 12 objects (maximum) in the array anyway.
 174   TObjArray fPedestalLowGain; // pedestal info for low gain
 175   TObjArray fPedestalHighGain; // pedestal info for high gain
 176   TObjArray fPedestalLEDRefLowGain; // pedestal LEDRef info for low gain
 177   TObjArray fPedestalLEDRefHighGain; // pedestal LEDRef info for high gain
 178   TObjArray fPeakMinusPedLowGain; // (peak-pedestal) info for low gain
 179   TObjArray fPeakMinusPedHighGain; // (peak-pedestal) info for high gain
 180
 181   TObjArray fPeakMinusPedHighGainHisto; // (peak-pedestal TH2F) info for high gain, used for hot towers eveluation
 182
 183   //The difference of profiles between this and the reference object
 184   TObjArray fPedestalLowGainDiff; //!
 185   TObjArray fPedestalHighGainDiff; //!
 186   TObjArray fPedestalLEDRefLowGainDiff; //!
 187   TObjArray fPedestalLEDRefHighGainDiff; //!
 188   TObjArray fPeakMinusPedLowGainDiff; //!
 189   TObjArray fPeakMinusPedHighGainDiff; //!
 190
 191   //The ratio of profiles between this and the reference object
 192   TObjArray fPedestalLowGainRatio; //!
 193   TObjArray fPedestalHighGainRatio; //!
 194   TObjArray fPedestalLEDRefLowGainRatio; //!
 195   TObjArray fPedestalLEDRefHighGainRatio; //!
 196   TObjArray fPeakMinusPedLowGainRatio; //!
 197   TObjArray fPeakMinusPedHighGainRatio; //!
 198
 199   TObjArray fDeadMap;//The deadmap
 200
 201   // status counters
 202   int fNEvents; //# total events processed,
 203   int fNChanFills; //# total channel fills (NChan * NEvents if not zero-suppressed)
 204
 205   //The dead tower counts
 206   int fDeadTowers; // Number of towers found dead.
 207   int fNewDeadTowers; //! Towers that have died since the reference run
 208   int fResurrectedTowers; //! Towers that have been resurrected from the dead, compared to the reference
 209
 210   AliCaloCalibPedestal * fReference; //! A reference object, for comparing the accumulated results to a previous run
 211
 212   kDetType fDetType; //The detector type for this object
 213   int fColumns; //The number of columns per module
 214   int fRows;    //The number of rows per module
 215   int fLEDRefs; //The number of LED references/monitors per module
 216   int fModules; //The number of modules
 217   int fRowMin; // Minimum Row number
 218   int fRowMax; // Maximum now number
 219   int fRowMultiplier; // Multiplication factor to get proper row range between PHOS and EMCAL
 220   TString fCaloString; // id for which detector type we have
 221   AliCaloAltroMapping **fMapping;    //! Altro Mapping object
 222   int fRunNumber; //The run number. Needs to be set by the user.
 223   Bool_t fSelectPedestalSamples; // select to to use only some range of samples for pedestal calc.
 224   int fFirstPedestalSample; // first sample to use
 225   int fLastPedestalSample; // last sample to use
 226
 227   int fDeadThreshold; // Peak - ped threshold used for dead towers evaluation
 228   int fWarningThreshold; // Peak - ped threshold used for warm/warning towers evaluation
 229   double fWarningFraction; //if(Peak - ped) > threshold in more than this fraction of event -> tower is assigned kWarning
 230   double fHotSigma; // if pedestal rms more than fHotSigma away from normal -> tower is assigned kHot
 231
 232   //Constants needed by the class: EMCAL ones are kept in AliEMCALGeoParams.h
 233   static const int fgkPhosRows = 64; // number of rows per module for PHOS
 234   static const int fgkPhosCols = 56; // number of columns per module for PHOS
 235   static const int fgkPhosLEDRefs = 1; // no LED monitor channels for PHOS, set to 1 just to keep code simpler (also create LEDRef histos for PHOS)
 236   static const int fgkPhosModules = 5; // number of modules for PHOS
 237
 238   ClassDef(AliCaloCalibPedestal, 8)
 239
 240 };
 241
 242 #endif