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