use the new AliCaloRawStreamV3 decoder (from Yuri), based on the new AliAltroRawStrea...
[u/mrichter/AliRoot.git] / 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 "TProfile2D.h"
27 #include "TH2.h"
28 #include "TObjArray.h"
29 class AliCaloRawStreamV3;
30 class AliCaloAltroMapping;
31 class AliRawReader;
32
33 class AliCaloCalibPedestal : public TObject {
34   
35  public:
36
37   enum kDetType {kPhos, kEmCal, kNone};//The detector types
38   enum kDeadMapEntry{kAlive = 0, kDead, kResurrected, kRecentlyDeceased, kNumDeadMapStates};//The entries being put to the deadmap
39   
40   AliCaloCalibPedestal(kDetType detectorType = kPhos);
41   virtual ~AliCaloCalibPedestal();
42
43   // copy ctor, and '=' operator, are not fully tested/debugged yet
44   // at least for now; the reference info is not copied from one to the other
45   AliCaloCalibPedestal(const AliCaloCalibPedestal &ped); 
46   AliCaloCalibPedestal& operator = (const  AliCaloCalibPedestal &source);
47   
48   //Functions to ask for the constants (in case a GUI needs them, for an example
49   int GetSampleMax() const {return fgkSampleMax;};
50   int GetSampleMin() const {return fgkSampleMin;};
51
52   // Event processing methods:  
53   Bool_t ProcessEvent(AliRawReader *rawReader);
54   Bool_t ProcessEvent(AliCaloRawStreamV3    *in);
55   
56   // Mapping handling
57   AliCaloAltroMapping **GetAltroMapping() { return fMapping; };
58   void  SetAltroMapping(AliCaloAltroMapping **mapp) { fMapping = mapp; };
59
60   ////////////////////////////
61   //Simple getters
62   // Main profiles:
63   TProfile2D * GetPedProfileLowGain(int i) const {return (TProfile2D*)fPedestalLowGain[i];};    // Return a pointer to the low-gain pedestal profile
64   TProfile2D * GetPedProfileHighGain(int i) const {return (TProfile2D*)fPedestalHighGain[i];};  // Return a pointer to the high-gain pedestal profile
65   TProfile2D * GetPedRMSProfileLowGain(int i) const {return (TProfile2D*)fPedestalRMSLowGain[i];};      // Return a pointer to the low-gain rms profile 
66   TProfile2D * GetPedRMSProfileHighGain(int i) const {return (TProfile2D*)fPedestalRMSHighGain[i];};    // Return a pointer to the high-gain rms profile 
67   TProfile2D * GetPeakProfileLowGain(int i) const {return (TProfile2D*)fPeakMinusPedLowGain[i];};       // Return a pointer to the low-gain peak-pedestal profile
68   TProfile2D * GetPeakProfileHighGain(int i) const {return (TProfile2D*)fPeakMinusPedHighGain[i];};     // Return a pointer to the high-gain peak-pedestal profile
69   
70   // Differences to references:
71   TProfile2D * GetPedProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainDiff[i];};     // Return a pointer to the low-gain pedestal profile difference
72   TProfile2D * GetPedProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainDiff[i];};   // Return a pointer to the high-gain pedestal profile difference
73   TProfile2D * GetPeakProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainDiff[i];};        // Return a pointer to the low-gain peak-pedestal profile difference
74   TProfile2D * GetPeakProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainDiff[i];};      // Return a pointer to the high-gain peak-pedestal profile difference
75   
76   // Ratio to references:
77   TProfile2D * GetPedProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainRatio[i];};   // Return a pointer to the low-gain pedestal profile ratio
78   TProfile2D * GetPedProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainRatio[i];}; // Return a pointer to the high-gain pedestal profile ratio
79   TProfile2D * GetPeakProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainRatio[i];};      // Return a pointer to the low-gain peak-pedestal profile ratio
80   TProfile2D * GetPeakProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainRatio[i];};    // Return a pointer to the high-gain peak-pedestal profile ratio
81   
82   TH2D * GetDeadMap(int i) const {return (TH2D*)fDeadMap[i];};
83
84   // Basic info: getters  
85   kDetType GetDetectorType() const {return fDetType;};//Returns if this is a PHOS or EMCAL object
86   TString GetCaloString() const {return fCaloString;}; //Returns if this is a PHOS or EMCAL object
87   
88   int GetColumns() const {return fColumns;}; //The number of columns per module
89   int GetRows() const {return fRows;}; //The number of rows per module
90   int GetModules() const {return fModules;}; //The number of modules
91   int GetRowMin() const {return fRowMin;}; //for histo def.
92   int GetRowMax() const {return fRowMax;}; //for histo def.
93   int GetRowMultiplier() const {return fRowMultiplier;}; //for histo filling
94
95   // RunNumbers : setters and getters
96   void SetRunNumber(int runNo) {fRunNumber = runNo;};
97   int GetRunNumber() const {return fRunNumber;};
98   int GetRefRunNumber() const {if (fReference) return fReference->GetRunNumber(); else return -1;};
99
100   // Possibility to select only some samples for the pedestal calculation
101   void SetSelectPedestalSamples(Bool_t flag = kFALSE) {fSelectPedestalSamples = flag;} // select to to use only some range of samples for pedestal calc.
102   Bool_t GetSelectPedestalSamples() const {return fSelectPedestalSamples;} // select to to use only some range of samples for pedestal calc.
103   void SetFirstPedestalSample(int i) {fFirstPedestalSample = i;} // first sample to use
104   void SetLastPedestalSample(int i) {fLastPedestalSample = i;} // last sample to use
105   int GetFirstPedestalSample() const {return fFirstPedestalSample;}; // first sample to use
106   int GetLastPedestalSample() const {return fLastPedestalSample;}; // last sample to use
107
108   // Basic counters
109   int GetNEvents() const {return fNEvents;};
110   int GetNChanFills() const {return fNChanFills;};
111   
112   /////////////////////////////
113   //Analysis functions
114   int GetDeadTowerCount() const {return fDeadTowers;};//Returns the number of dead towers, by counting the bins in peak-pedestal smaller than threshold
115   double GetDeadTowerRatio() const {return fDeadTowers/(double)(fRows*fColumns);}; //returns the percentage of dead towers, relative to a full module
116   int GetDeadTowerNew() const {return fNewDeadTowers;}; //return the new dead towers compared to the reference
117   int GetDeadTowerResurrected() const {return fResurrectedTowers;}; //The the towers resurrected since the reference run
118
119   void Reset();//Resets the whole class.
120   Bool_t AddInfo(const AliCaloCalibPedestal *ped);//picks up new info from supplied argument
121   
122   //////////////////////////////////////////////////////
123   //Functions related to comparing this with another (reference) run.
124   Bool_t LoadReferenceCalib(TString fileName, TString objectName); //Loads another AliCaloCalibPedestal by name "objectName" from the file "fileName", for reference
125   void ComputeDiffAndRatio();//Actually computes the difference and ratio into the histo's in memory
126   AliCaloCalibPedestal * GetReference() const {return fReference;}; //Get the reference object. Needed for debug, will probably be removed later
127   void ComputeDeadTowers(int threshold = 5, const char * deadMapFile = 0);//Computes the dead tower values
128   
129   //Saving functions
130   Bool_t SaveHistograms(TString fileName, Bool_t saveEmptyHistos = kFALSE); //Saves the histograms to a .root file
131   
132  private:
133   
134   void ValidateComparisonProfiles(); //Makes sure that fPe..Diff and fPe..Ratio profiles exist
135   
136   //The histograms. We use a TObjArray instead of a simple array,because this gives automatic streaming properties for the
137   //class. A TClonesArray would be more efficient, but it's a bit more difficult to use and it doesn't matter too much
138   //since we have only around 12 objects (maximum) in the array anyway.
139   TObjArray fPedestalLowGain; // pedestal info for low gain
140   TObjArray fPedestalHighGain; // pedestal info for high gain
141   TObjArray fPedestalRMSLowGain; // pedestal rms info for low gain
142   TObjArray fPedestalRMSHighGain; // pedestal rms info for high gain
143   TObjArray fPeakMinusPedLowGain; // (peak-pedestal) info for low gain
144   TObjArray fPeakMinusPedHighGain; // (peak-pedestal) info for high gain
145   
146   //The difference of profiles between this and the reference object
147   TObjArray fPedestalLowGainDiff; //!
148   TObjArray fPedestalHighGainDiff; //!
149   TObjArray fPeakMinusPedLowGainDiff; //!
150   TObjArray fPeakMinusPedHighGainDiff; //!
151   
152   //The ratio of profiles between this and the reference object
153   TObjArray fPedestalLowGainRatio; //!
154   TObjArray fPedestalHighGainRatio; //!
155   TObjArray fPeakMinusPedLowGainRatio; //!
156   TObjArray fPeakMinusPedHighGainRatio; //!
157   
158   TObjArray fDeadMap;//The deadmap
159
160   // status counters
161   int fNEvents; //# total events processed, 
162   int fNChanFills; //# total channel fills (NChan * NEvents if not zero-suppressed)
163
164   //The dead tower counts
165   int fDeadTowers; //!
166   int fNewDeadTowers; //! Towers that have died since the reference run
167   int fResurrectedTowers; //! Towers that have been resurrected from the dead, compared to the reference
168   
169   AliCaloCalibPedestal * fReference; //! A reference object, for comparing the accumulated results to a previous run
170   
171   kDetType fDetType; //The detector type for this object
172   int fColumns; //The number of columns per module
173   int fRows;    //The number of rows per module
174   int fModules; //The number of modules
175   int fRowMin; // Mimimum Row number
176   int fRowMax; // Maximum now number
177   int fRowMultiplier; // Multiplication factor to get proper row range between PHOS and EMCAL
178   TString fCaloString; // id for which detector type we have 
179   AliCaloAltroMapping **fMapping;    //! Altro Mapping object
180   int fRunNumber; //The run number. Needs to be set by the user.
181   Bool_t fSelectPedestalSamples; // select to to use only some range of samples for pedestal calc.
182   int fFirstPedestalSample; // first sample to use
183   int fLastPedestalSample; // last sample to use
184
185   //Constants needed by the class
186   static const int fgkSampleMax = 1023; // highest possible sample value (10-bit = 0x3ff)
187   static const int fgkSampleMin = 0; // lowest possible sample value 
188   
189   static const int fgkPhosRows = 64; // number of rows per module for PHOS
190   static const int fgkPhosCols = 56; // number of columns per module for PHOS
191   static const int fgkPhosModules = 5; // number of modules for PHOS
192   
193   static const int fgkEmCalRows = 24; // number of rows per module for EMCAL
194   static const int fgkEmCalCols = 48; // number of columns per module for EMCAL
195   static const int fgkEmCalModules = 12; // number of modules for EMCAL
196   
197   ClassDef(AliCaloCalibPedestal,3)
198
199 };
200     
201 #endif