correct mask for V0 charge decoding in STU payload
[u/mrichter/AliRoot.git] / EMCAL / AliCaloCalibSignal.h
1 #ifndef ALICALOCALIBSIGNAL_H
2 #define ALICALOCALIBSIGNAL_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: AliCaloCalibSignal.h  $ */
8
9 // \file AliCaloCalibSignal.h
10 //   \brief Description:
11 //   A help class for monitoring and calibration tools: MOOD, AMORE etc.,
12 //   that can process events from a standard AliCaloRawStreamV3,
13 //   most usually from LED/pulser runs. It stores signal info as
14 //   typical (highest) amplitude vs time in TGraphs (one per channel)
15 //   or TProfiles if we decide to just store the averages (and not all points) 
16 //   for the detectors (EMCAL and PHOS).
17
18 //   \author: Josh Hamblen (UTenn), original version. 
19 //   [Consultant: D. Silvermyr (ORNL)]
20 //   Partly based on AliCaloCalibPedestal.
21 //   
22 //   \version $Revision:  $
23 //   \date $Date: $
24
25 #include "TString.h"
26 #include "TTree.h"
27 #include "AliEMCALGeoParams.h"
28 class AliCaloRawStreamV3;
29 class AliCaloAltroMapping;
30 class AliRawReader;
31
32 class AliCaloCalibSignal : public TObject {
33   
34  public:
35
36   enum kDetType {kPhos, kEmCal, kNone};//The detector types
37   
38   AliCaloCalibSignal(kDetType detectorType = kPhos); //ctor
39   virtual ~AliCaloCalibSignal(); //dtor
40   
41 private:
42   //Just declare them, avoid compilation warning
43   AliCaloCalibSignal(const AliCaloCalibSignal & /*sig*/); // copy ctor
44   AliCaloCalibSignal& operator = (const  AliCaloCalibSignal &/*source*/); // assing operator
45   
46 public:
47   // Event processing methods:
48   Bool_t ProcessEvent(AliRawReader *rawReader);
49   Bool_t ProcessEvent(AliCaloRawStreamV3 *in, UInt_t Timestamp); // added header for time info
50   Bool_t CheckFractionAboveAmp(const int *AmpVal, int resultArray[]); // check fraction of signals to check for LED events
51   Bool_t CheckLEDRefAboveAmp(const int *AmpVal, int resultArray[]); // check if LED Ref is also above cut
52
53   // Mapping handling
54   AliCaloAltroMapping **GetAltroMapping() const { return fMapping; };
55   void  SetAltroMapping(AliCaloAltroMapping **mapp) { fMapping = mapp; };
56
57   // Parameter/cut handling
58   void SetParametersFromFile(const char *parameterFile);
59   void WriteParametersToFile(const char *parameterFile);
60
61   ////////////////////////////
62   //Simple getters
63   // for TTree
64   TTree * GetTreeAmpVsTime() const { return fTreeAmpVsTime; } //!
65   TTree * GetTreeAvgAmpVsTime() const {return fTreeAvgAmpVsTime; } //!
66   TTree * GetTreeLEDAmpVsTime() const {return fTreeLEDAmpVsTime; } //!
67   TTree * GetTreeLEDAvgAmpVsTime() const {return fTreeLEDAvgAmpVsTime; } //!
68
69   // how many points do we have for each tower&gain
70   int GetNHighGain(int imod, int icol, int irow) const //!
71     { int towId = GetTowerNum(imod, icol, irow); return fNHighGain[towId];};    //!
72   int GetNLowGain(int imod, int icol, int irow) const //!
73     { int towId = GetTowerNum(imod, icol, irow); return fNLowGain[towId];};     //!
74   int GetNHighGain(int towId) const { return fNHighGain[towId];};       //!
75   int GetNLowGain(int towId) const { return fNLowGain[towId];}; //!
76
77   // also for LED reference
78   int GetNRef(const int imod, const int istripMod, const int igain) //!
79     { int refId = GetRefNum(imod, istripMod, igain); return fNRef[refId];}; //!
80   int GetNRef(int refId) const { return fNRef[refId];}; //!
81
82   // Basic info: getters  
83   kDetType GetDetectorType() const {return fDetType;};//Returns if this is a PHOS or EMCAL object
84   TString GetCaloString() const {return fCaloString;}; //Returns if this is a PHOS or EMCAL object  
85
86   int GetColumns() const {return fColumns;}; //The number of columns per module
87   int GetRows() const {return fRows;}; //The number of rows per module
88   int GetLEDRefs() const {return fLEDRefs;}; //The number of LED references/monitors per module
89   int GetModules() const {return fModules;}; //The number of modules
90
91   int GetTowerNum(const int imod, const int icol, const int irow) const { return (imod*fColumns*fRows + icol*fRows + irow);}; // help index
92
93   int GetChannelNum(const int imod, const int icol, const int irow, const int igain) const { return (igain*fModules*fColumns*fRows + imod*fColumns*fRows + icol*fRows + irow);}; // channel number with gain included
94
95   Bool_t DecodeChannelNum(const int chanId, 
96                           int *imod, int *icol, int *irow, int *igain) const; // return the module, column, row, and gain for a given channel number
97
98   // LED reference indexing
99   int GetRefNum(const int imod, const int istripMod, const int igain) const { return (igain*fModules*fLEDRefs + imod*fLEDRefs + istripMod);}; // channel number with gain included
100
101   Bool_t DecodeRefNum(const int refId, 
102                       int *imod, int *istripMod, int *igain) const; // return the module, stripModule, and gain for a given reference number
103
104   // Basic Counters
105   int GetNEvents() const {return fNEvents;};
106   int GetNAcceptedEvents() const {return fNAcceptedEvents;};
107
108   ///////////////////////////////
109   //  Get and Set Cuts
110   // Section for if we should help with the event selection of what is likely LED events
111   void SetAmpCut(double d) { fAmpCut = d; } //!
112   double GetAmpCut() const { return fAmpCut; }; //!
113   void SetReqFractionAboveAmpCutVal(double d) { fReqFractionAboveAmpCutVal = d; } //!
114   double GetReqFractionAboveAmpCutVal() const { return fReqFractionAboveAmpCutVal; }; //!
115   void SetReqFractionAboveAmp(bool b) { fReqFractionAboveAmp = b; } //!
116   bool GetReqFractionAboveAmp() const { return fReqFractionAboveAmp; }; //!
117   // also for LED Reference/Mon channels
118   void SetAmpCutLEDRef(double d) { fAmpCutLEDRef = d; } //!
119   double GetAmpCutLEDRef() const { return fAmpCutLEDRef; }; //!
120   void SetReqLEDRefAboveAmpCutVal(bool b) { fReqLEDRefAboveAmpCutVal = b; } //!
121   bool GetReqLEDRefAboveAmpCutVal() const { return fReqLEDRefAboveAmpCutVal; }; //!
122
123   // We may select to get averaged info
124   void SetUseAverage(bool b) { fUseAverage = b; } //!
125   bool GetUseAverage() const { return fUseAverage; }; //!
126   void SetSecInAverage(int secInAverage) {fSecInAverage = secInAverage;}; // length of the interval that should be used for the average calculation (determines number of bins in TProfile)
127   int GetSecInAverage() const {return fSecInAverage;}; //!
128
129   // Info on time since start of run
130   double GetHour() const { return fHour; }; // time info for current event
131   double GetCurrentHour() const { return fHour; }; // time info for current event (same as GetHour(), just more explicitly named)
132   double GetLatestHour() const { return fLatestHour; }; // the latest time encountered
133   // These times are typically the same, but not necessarily if the events do not come in order 
134   void SetLatestHour(double d) { fLatestHour = d; }; // could be useful when we know the length of the run (i.e. after it is over), e.g. for PreProcessor
135
136   // RunNumbers : setters and getters
137   void SetRunNumber(int runNo) {fRunNumber = runNo;}; //!
138   int GetRunNumber() const {return fRunNumber;};  //!
139   
140   // Start-of-run timestamp : set and get
141   void SetStartTime(int startTime) {fStartTime = startTime;}; //!
142   int GetStartTime() const {return fStartTime;}; //!
143
144   /////////////////////////////
145   //Analysis functions
146   void ResetInfo();// trees and counters.
147   Bool_t AddInfo(const AliCaloCalibSignal *sig);//picks up new info from supplied argument  
148
149   //Saving functions
150   Bool_t Save(TString fileName); //Saves the objects to a .root file
151   Bool_t Analyze(); // makes average tree and summary tree 
152
153  private:
154  
155   void DeleteTrees(); // delete old objects and set pointers
156   void Zero(); // set all counters to 0
157   void CreateTrees(); //! create/setup the TTrees
158     
159  private:
160
161   kDetType fDetType; //The detector type for this object
162   int fColumns; //The number of columns per module
163   int fRows;    //The number of rows per module
164   int fLEDRefs; //The number of LED references/monitors per module
165   int fModules; //The number of modules
166   TString fCaloString; // id for which detector type we have 
167   AliCaloAltroMapping **fMapping;    //! Altro Mapping object
168   int fRunNumber; //The run number. Needs to be set by the user.
169   int fStartTime;  // Time of first event
170
171   double fAmpCut; // amplitude cut value
172   double fReqFractionAboveAmpCutVal; // required fraction that should be above cut
173   bool fReqFractionAboveAmp; // flag to select if we should do some event selection based on amplitudes
174
175   double fAmpCutLEDRef; // amplitude cut value for LED reference
176   bool fReqLEDRefAboveAmpCutVal; // flag to select if we should require that signal is also seen in LED Reference/Monitoring channel
177
178   double fHour; // fraction of hour since beginning of run, for amp vs. time graphs, for current event
179   double fLatestHour; // largest fraction of hour since beginning of run, for amp vs. time graphs
180   bool fUseAverage; // flag to average graph points into over a time interval
181   int fSecInAverage; // time interval for the graph averaging
182
183   // status counters
184   int fNEvents; // # events processed
185   int fNAcceptedEvents; // # events accepted
186
187   //Constants needed by the class: EMCAL ones are kept in AliEMCALGeoParams.h
188   static const int fgkPhosRows = 64; // number of rows per module for PHOS
189   static const int fgkPhosCols = 56; // number of columns per module for PHOS
190   static const int fgkPhosLEDRefs = 0; // no LED monitor channels for PHOS
191   static const int fgkPhosModules = 5; // number of modules for PHOS
192   
193   // From numbers above: PHOS has more possible towers (17920) than EMCAL (13824) 
194   // so use PHOS numbers to set max. array sizes
195   static const int fgkMaxTowers = 17920; // fgkPhosModules * fgkPhosCols * fgkPhosRows; 
196   // for LED references; maximum from EMCAL
197   static const int fgkMaxRefs = 288; // AliEMCALGeoParams::fgkEMCALModules * AliEMCALGeoParams::fgkEMCALLEDRefs
198
199   static const int fgkNumSecInHr = 3600;  // number of seconds in an hour, for the fractional hour conversion on the time graph
200   
201   // trees
202   TTree *fTreeAmpVsTime; // stores channel, gain, amp, and time info
203   TTree *fTreeAvgAmpVsTime; // same, for averages
204   TTree *fTreeLEDAmpVsTime; // same, for LED reference
205   TTree *fTreeLEDAvgAmpVsTime; // same, for LED reference - averages
206
207   // counters
208   int fNHighGain[fgkMaxTowers]; // Number of Amp. vs. Time readings per tower
209   int fNLowGain[fgkMaxTowers]; // same, for low gain
210   int fNRef[fgkMaxRefs * 2]; // same, for LED refs; *2 for both gains
211   
212   ClassDef(AliCaloCalibSignal, 6) // don't forget to change version if you change class member list..
213     
214 };
215     
216 #endif