- add protection against invalid sector/stack information in on-line track matching
[u/mrichter/AliRoot.git] / TRD / AliTRDCalibraFillHisto.h
1 #ifndef ALITRDCALIBRAFILLHISTO_H
2 #define ALITRDCALIBRAFILLHISTO_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7
8 ///////////////////////////////////////////////////////////////////////////////
9 //                                                                           //
10 //  TRD calibration class for the HLT parameters                             //
11 //                                                                           //
12 ///////////////////////////////////////////////////////////////////////////////
13
14 #ifndef ROOT_TObject
15 #  include <TObject.h>
16 #endif
17 #ifndef ROOT_TProfile2D
18 #  include <TProfile2D.h> 
19 #endif
20
21
22 class TProfile2D;
23 class TObjArray;
24 class TH1F;
25 class TH2I;
26 class TH2F;
27 class TH2;
28 class TLinearFitter;
29 class TTreeSRedirector;
30
31 class AliLog;
32 class AliRawReader;
33
34 class AliESDtrack;
35
36 class AliTRDCalibraMode;
37 class AliTRDCalibraVector;
38 class AliTRDCalibraVdriftLinearFit;
39 class AliTRDCalibraExbAltFit;
40 class AliTRDcluster;
41 class AliTRDtrackV1;
42 class AliTRDseedV1;
43 class AliTRDgeometry;
44 class AliTRDCalDet;
45 class AliTRDCalROC;
46 class AliTRDcalibDB;
47
48 class AliTRDdigitsManager;
49 class AliTRDSignalIndex;
50
51 struct eventHeaderStruct;
52
53 class AliTRDCalibraFillHisto : public TObject {
54
55  public: 
56
57   // Instance
58   static AliTRDCalibraFillHisto *Instance();
59   static void Terminate();
60   static void Destroy();
61   void DestroyDebugStreamer();
62
63
64   AliTRDCalibraFillHisto(const AliTRDCalibraFillHisto &c);
65   AliTRDCalibraFillHisto &operator=(const AliTRDCalibraFillHisto &) { return *this; }
66
67   // Functions for initialising and filling with AliTRDtrackV1
68           Bool_t  Init2Dhistos(Int_t nboftimebin = -1);
69           Bool_t  InitCalDet();
70           Bool_t  UpdateHistogramsV1(const AliTRDtrackV1 *t,const AliESDtrack *esdtrack = NULL);
71  
72   // Process events DAQ
73           Int_t   ProcessEventDAQ(AliRawReader *rawReader);
74
75   // Is Pad on
76           Bool_t   IsPadOn(Int_t detector, Int_t row, Int_t col) const;
77
78   // Functions for write
79           void     Write2d(const Char_t *filename = "TRD.calibration.root", Bool_t append = kFALSE);
80
81   //For the statistics
82           Double_t *StatH(TH2 *ch, Int_t i);
83           Double_t *GetMeanMedianRMSNumberCH();
84           Double_t *GetMeanMedianRMSNumberLinearFitter() const;
85  // LinearFitter
86           void     AnalyseLinearFitter();
87        
88          
89   //
90   // Set of Get the variables
91   //
92
93           void     SetIsHLT(Bool_t isHLT = kTRUE)                            { fIsHLT = isHLT;                       }  
94           Bool_t   IsHLT() const                                             { return fIsHLT;                        }  
95
96   // Choice to fill or not the 2D
97           void     SetPH2dOn(Bool_t ph2don = kTRUE)                          { fPH2dOn          = ph2don;            }
98           void     SetCH2dOn(Bool_t ch2don = kTRUE)                          { fCH2dOn          = ch2don;            }
99           void     SetPRF2dOn(Bool_t prf2don = kTRUE)                        { fPRF2dOn         = prf2don;           }
100           void     SetHisto2d(Bool_t histo2d = kTRUE)                        { fHisto2d         = histo2d;           }
101           void     SetVector2d(Bool_t vector2d = kTRUE)                      { fVector2d        = vector2d;          }
102           void     SetLinearFitterOn(Bool_t linearfitteron = kTRUE)          { fLinearFitterOn      = linearfitteron;}
103           void     SetLinearFitterDebugOn(Bool_t debug = kTRUE)              { fLinearFitterDebugOn = debug;         }
104           void     SetExbAltFitOn(Bool_t fiton = kTRUE)                      { fExbAltFitOn      = fiton;}
105           void     SetScaleWithTPCSignal(Bool_t scaleWithTPCSignal = kTRUE)  { fScaleWithTPCSignal = scaleWithTPCSignal;}
106           void     SetFirstRunGain(Int_t firstRunGain)                       { fFirstRunGain = firstRunGain;   }
107           void     SetVersionGainUsed(Int_t versionGainUsed)                 { fVersionGainUsed = versionGainUsed;   }
108           void     SetSubVersionGainUsed(Int_t subVersionGainUsed)           { fSubVersionGainUsed = subVersionGainUsed;   }
109           void     SetFirstRunGainLocal(Int_t firstRunGainLocal)             { fFirstRunGainLocal = firstRunGainLocal;   }
110           void     SetVersionGainLocalUsed(Int_t versionGainLocalUsed)       { fVersionGainLocalUsed = versionGainLocalUsed;   }
111           void     SetSubVersionGainLocalUsed(Int_t subVersionGainLocalUsed) { fSubVersionGainLocalUsed = subVersionGainLocalUsed;   }
112           void     SetFirstRunVdrift(Int_t firstRunVdrift)                   { fFirstRunVdrift = firstRunVdrift;   }
113           void     SetVersionVdriftUsed(Int_t versionVdriftUsed)             { fVersionVdriftUsed = versionVdriftUsed;   }
114           void     SetSubVersionVdriftUsed(Int_t subVersionVdriftUsed)       { fSubVersionVdriftUsed = subVersionVdriftUsed;   }
115           void     SetFirstRunExB(Int_t firstRunExB)                         { fFirstRunExB = firstRunExB;   }
116           void     SetVersionExBUsed(Int_t versionExBUsed)                   { fVersionExBUsed = versionExBUsed;   }
117           void     SetSubVersionExBUsed(Int_t subVersionExBUsed)             { fSubVersionExBUsed = subVersionExBUsed;   }
118           
119   
120           Bool_t   GetPH2dOn() const                                         { return fPH2dOn;                 }
121           Bool_t   GetCH2dOn() const                                         { return fCH2dOn;                 }
122           Bool_t   GetPRF2dOn() const                                        { return fPRF2dOn;                }
123           Bool_t   GetHisto2d() const                                        { return fHisto2d;                }
124           Bool_t   GetVector2d() const                                       { return fVector2d;               }
125           Bool_t   GetLinearFitterOn() const                                 { return fLinearFitterOn;         }
126           Bool_t   GetLinearFitterDebugOn() const                            { return fLinearFitterDebugOn;    }
127           Int_t    GetVersionGainUsed() const                                { return fVersionGainUsed;        }
128           Int_t    GetSubVersionGainUsed() const                             { return fSubVersionGainUsed;     }
129           Int_t    GetVersionVdriftUsed() const                              { return fVersionVdriftUsed;      }
130           Int_t    GetSubVersionVdriftUsed() const                           { return fSubVersionVdriftUsed;   }
131
132
133   // Get stuff that are filled
134   TH2I            *GetCH2d();
135   TProfile2D      *GetPH2d(Int_t nbtimebin=24, Float_t samplefrequency= 10.0);
136   TProfile2D      *GetPRF2d() const                                          { return fPRF2d;                  } 
137   TObjArray        GetLinearFitterArray() const                              { return fLinearFitterArray;      }
138   TLinearFitter   *GetLinearFitter(Int_t detector, Bool_t force=kFALSE);
139   AliTRDCalibraVdriftLinearFit *GetVdriftLinearFit() const                   { return fLinearVdriftFit; }
140   AliTRDCalibraExbAltFit *GetExbAltFit() const                               { return fExbAltFit; }
141   
142  
143   // How to fill the 2D
144           void     SetRelativeScale(Float_t relativeScale);                      
145           void     SetThresholdClusterPRF2(Float_t thresholdClusterPRF2)     { fThresholdClusterPRF2 = thresholdClusterPRF2; }
146           void     SetLimitChargeIntegration(Bool_t limitChargeIntegration)  { fLimitChargeIntegration = limitChargeIntegration; }
147           void     SetFillWithZero(Bool_t fillWithZero)                      { fFillWithZero = fillWithZero;   }
148           void     SetNormalizeNbOfCluster(Bool_t normalizeNbOfCluster)      { fNormalizeNbOfCluster = normalizeNbOfCluster; }
149           void     SetMaxCluster(Float_t maxCluster)                         { fMaxCluster = maxCluster; }
150           void     SetNbMaxCluster(Short_t nbMaxCluster)                     { fNbMaxCluster = nbMaxCluster; }
151           void     SetCutWithVdriftCalib(Bool_t cutWithVdriftCalib)          { fCutWithVdriftCalib = cutWithVdriftCalib; }
152           void     SetMinNbTRDtracklets(Int_t minNbTRDtracklets)             { fMinNbTRDtracklets = minNbTRDtracklets; }
153           void     SetMinTRDMomentum(Float_t minTRDMomentum)                 { fMinTRDMomentum = minTRDMomentum; }
154           void     SetNz(Int_t i, Short_t nz);
155           void     SetNrphi(Int_t i, Short_t nrphi);
156           void     SetAllTogether(Int_t i);
157           void     SetPerSuperModule(Int_t i);
158           void     SetProcent(Float_t procent)                               { fProcent              = procent;              }
159           void     SetDifference(Short_t difference)                         { fDifference           = difference;           }
160           void     SetNumberClusters(Short_t numberClusters)                 { if(numberClusters >= 0) fNumberClusters       = numberClusters;       }
161           void     SetNumberClustersf(Short_t numberClustersf)               { fNumberClustersf      = numberClustersf;      }
162           void     SetNumberClustersProcent(Float_t numberClustersProcent)   { fNumberClustersProcent = numberClustersProcent;                       }
163           void     SetThresholdClustersDAQ(Float_t thresholdClustersDAQ)     { fThresholdClustersDAQ = thresholdClustersDAQ;                         }
164           void     SetNumberRowDAQ(Short_t numberRowDAQ)                     { fNumberRowDAQ         = numberRowDAQ;         }
165           void     SetNumberColDAQ(Short_t numberColDAQ)                     { fNumberColDAQ         = numberColDAQ;         }
166           void     SetRangeHistoCharge(Float_t rangeHistoCharge)             { fRangeHistoCharge     = rangeHistoCharge;     }
167           void     SetNumberBinCharge(Short_t numberBinCharge)               { fNumberBinCharge      = numberBinCharge;      }
168           void     SetNumberBinPRF(Short_t numberBinPRF)                     { fNumberBinPRF         = numberBinPRF;         }
169           void     SetNumberGroupsPRF(Short_t numberGroupsPRF);
170   
171           Float_t  GetRelativeScale() const                                  { return fRelativeScale;          }
172           Float_t  GetThresholdClusterPRF2() const                           { return fThresholdClusterPRF2;   }
173           Bool_t   GetLimitChargeIntegration() const                         { return fLimitChargeIntegration; }
174           Bool_t   GetFillWithZero() const                                   { return fFillWithZero;           }
175           Bool_t   GetNormalizeNbOfCluster() const                           { return fNormalizeNbOfCluster;   }
176           Float_t  GetMaxCluster() const                                     { return fMaxCluster;             }
177           Short_t  GetNbMaxCluster() const                                   { return fNbMaxCluster;           }
178           Bool_t   GetCutWithVdriftCalib() const                             { return fCutWithVdriftCalib;     }
179           Float_t  GetProcent() const                                        { return fProcent;                }
180           Short_t  GetDifference() const                                     { return fDifference;             }
181           Short_t  GetNumberClusters() const                                 { return fNumberClusters;         }
182           Short_t  GetNumberClustersf() const                                { return fNumberClustersf;        }
183           Short_t  GetNumberBinCharge() const                                { return fNumberBinCharge;        }
184           Short_t  GetNumberBinPRF() const                                   { return fNumberBinPRF;           }
185           Short_t  GetNumberGroupsPRF() const                                { return fNgroupprf;              }
186           Int_t    *GetEntriesLinearFitter() const                           { return fEntriesLinearFitter;    }
187
188  // Debug
189           void     SetDebugLevel(Short_t level)                              { fDebugLevel = level;           }
190
191   // Vector method
192 AliTRDCalibraVector *GetCalibraVector() const                                { return fCalibraVector;          }   
193   
194  protected:
195
196   // Geometry
197   AliTRDgeometry  *fGeo;                    //! The TRD geometry
198   // calibration DB
199   AliTRDcalibDB   *fCalibDB;                //! The pointer to the TRDcalibDB instance
200
201   // Is HLT
202           Bool_t   fIsHLT;                  // Now if HLT, the per detector
203
204   // Choice to fill or not the 2D
205           Bool_t   fCH2dOn;                 // Chose to fill the 2D histos or vectors for the relative gain calibration 
206           Bool_t   fPH2dOn;                 // Chose to fill the 2D histos or vectors for the drift velocity and T0
207           Bool_t   fPRF2dOn;                // Chose to fill the 2D histos or vectors for the pad response function calibration
208           Bool_t   fHisto2d;                // Chose to fill the 2D histos
209           Bool_t   fVector2d;               // Chose to fill vectors
210           Bool_t   fLinearFitterOn;         // Method with linear fit for drift velocity
211           Bool_t   fLinearFitterDebugOn;    // Method with linear fit for drift velocity
212           Bool_t   fExbAltFitOn;            // Enable parabolic fit for exb
213           Bool_t   fScaleWithTPCSignal;     // Scale the gain with TPC signal (If use then ask at least 70 TPC clusters)
214
215   // How to fill the 2D
216           Float_t  fRelativeScale;          // Scale of the deposited charge
217           Float_t  fThresholdClusterPRF2;   // Threshold on cluster pad signals
218           Bool_t   fLimitChargeIntegration; // Integration range for the gain calibration
219           Bool_t   fFillWithZero;           // Fill with zero or not the average pulse height
220           Bool_t   fNormalizeNbOfCluster;   // Normalize with the number of cluster for the gain
221           Float_t  fMaxCluster;             // Max amplitude of one cluster
222           Short_t  fNbMaxCluster;           // Number of tb at the end
223           Bool_t   fCutWithVdriftCalib;     // CutWithVdriftCalib for the gain and PH
224           Int_t    fMinNbTRDtracklets;      // Min number of TRD tracklets
225           Float_t  fMinTRDMomentum;         // Min TRD momentum
226   // Back correction
227           Int_t    fFirstRunGain;           // FirstRunGain 
228           Int_t    fVersionGainUsed;        // VersionGainUsed 
229           Int_t    fSubVersionGainUsed;     // SubVersionGainUsed
230           Int_t    fFirstRunGainLocal;      // FirstRunGainLocal 
231           Int_t    fVersionGainLocalUsed;   // VersionGainUsed 
232           Int_t    fSubVersionGainLocalUsed;// SubVersionGainUsed
233           Int_t    fFirstRunVdrift;         // FirstRunVdrift 
234           Int_t    fVersionVdriftUsed;      // VersionVdriftUsed 
235           Int_t    fSubVersionVdriftUsed;   // SubVersionVdriftUsed
236           Int_t    fFirstRunExB;            // FirstRunExB 
237           Int_t    fVersionExBUsed;         // VersionExBUsed 
238           Int_t    fSubVersionExBUsed;      // SubVersionExBUsed
239   // Calibration mode
240           AliTRDCalibraMode *fCalibraMode;  // Calibration mode
241
242   //For debugging
243           TTreeSRedirector          *fDebugStreamer;                 //!Debug streamer
244           Short_t     fDebugLevel;                                   // Flag for debugging
245   //
246   // Internal variables
247   //
248
249   // Fill the 2D histos in the offline tracking
250           Int_t    fDetectorPreviousTrack;  // Change of detector
251           Int_t    fMCMPrevious;            // Change of MCM
252           Int_t    fROBPrevious;            // Change of ROB
253           Short_t  fNumberClusters;         // Minimum number of clusters in the tracklets
254           Short_t  fNumberClustersf;        // Maximum number of clusters in the tracklets
255           Float_t  fNumberClustersProcent;  // Procent of number of time bins for fNumberClusters
256           Float_t  fThresholdClustersDAQ;   // Threshold clusters for DAQ algorithm
257           Short_t  fNumberRowDAQ;           // Size of the spot for DAQ algorithm
258           Short_t  fNumberColDAQ;           // Size of the spot for DAQ algorithm
259           Float_t  fProcent;                // Limit to take the info of the most important calibration group if the track goes through 2 groups (CH)
260           Short_t  fDifference;             // Limit to take the info of the most important calibration group if the track goes through 2 groups (CH)
261           Int_t    fNumberTrack;            // How many tracks could be used (Debug for the moment)
262           Int_t    fNumberUsedCh[2];        // How many tracks have been really used for the gain (0, strict; 1 with fProcent)
263           Int_t    fNumberUsedPh[2];        // How many tracks have been really used for the drift velocity (0, strict; 1 with fDifference)
264           Int_t    fTimeMax;                // Number of time bins
265           Float_t  fSf;                     // Sampling frequence
266           Float_t  fRangeHistoCharge;       // Range of the histo for the charge
267           Short_t  fNumberBinCharge;        // Number of bins for the gain factor
268           Short_t  fNumberBinPRF;           // Number of bin for the PRF
269           Short_t  fNgroupprf;              // Number of groups in tnp bins for PRF /2.0
270
271   // Variables per tracklet
272           Float_t       *fAmpTotal;                  // Energy deposited in the calibration group by the track
273           Short_t       *fPHPlace;                   // Calibration group of PH
274           Float_t       *fPHValue;                   // PH
275           Bool_t         fGoodTracklet;              // Good tracklet
276           TLinearFitter *fLinearFitterTracklet;      // linear fitter tracklet  
277   //Statistics
278           Int_t         *fEntriesCH;                 // Number of entries CH
279           Int_t         *fEntriesLinearFitter;       // Number of entries LinearFitter
280
281
282   //
283   // Vector method
284   //
285           
286           AliTRDCalibraVector *fCalibraVector; // The vector object
287  
288  
289   // Histograms to store the info from the digits, from the tracklets or from the tracks
290           TProfile2D      *fPH2d;                         // 2D average pulse height
291           TProfile2D      *fPRF2d;                        // 2D PRF
292           TH2I            *fCH2d;                         // 2D deposited charge
293           TObjArray       fLinearFitterArray;             // TObjArray of Linear Fitters for the detectors 
294           AliTRDCalibraVdriftLinearFit *fLinearVdriftFit; // Info Linear Fit
295           AliTRDCalibraExbAltFit *fExbAltFit; // ExB parabolic fit (alternative to vdrift linear fit)
296           
297  // Current calib object: to correct for the database used
298           AliTRDCalDet *fCalDetGain;                      // Current calib object gain
299           AliTRDCalROC *fCalROCGain;                      // Current calib object gain
300            
301   //
302   // A lot of internal functions......
303   // Init
304           Bool_t   InitCalPad(Int_t detector);
305   //
306   // Create the 2D histo to be filled Online
307           void     CreateCH2d(Int_t nn);
308           void     CreatePH2d(Int_t nn);
309           void     CreatePRF2d(Int_t nn);
310   
311   // Calibration with AliTRDtrackV1
312           void     FillTheInfoOfTheTrackPH();
313           void     FillTheInfoOfTheTrackCH(Int_t nbclusters);
314           Bool_t   FindP1TrackPHtrackletV1(const AliTRDseedV1 *tracklet, Int_t nbclusters);
315           Bool_t   HandlePRFtrackletV1(const AliTRDseedV1 *tracklet, Int_t nbclusters);
316           void     ResetfVariablestracklet();
317           Float_t  StoreInfoCHPHtrack(const AliTRDcluster *cl,const Double_t dqdl,const Int_t *group,const Int_t row,const Int_t col,const AliTRDcluster *cls=0x0);
318           void     FillCH2d(Int_t x, Float_t y);
319
320   // Calibration on DAQ
321
322           Int_t    FillDAQ(Double_t phvalue[16][144][36]);
323           Bool_t   UpdateDAQ(Int_t det, Int_t /*row*/, Int_t /*col*/, Int_t timebin, Float_t signal, Int_t nbtimebins);
324           
325  // row col calibration groups stuff
326           Bool_t   LocalisationDetectorXbins(Int_t detector);
327           Int_t    CalculateTotalNumberOfBins(Int_t i);
328           void     CheckGoodTrackletV0(const Int_t detector,const Int_t row,const Int_t col);
329           void     CheckGoodTrackletV1(const AliTRDcluster *cl);
330           Int_t    CalculateCalibrationGroup(Int_t i, Int_t row, Int_t col) const;
331           
332   // Clear
333           void     ClearHistos();
334       
335   // Some basic geometry function
336   virtual Int_t    GetLayer(Int_t d) const;
337   virtual Int_t    GetStack(Int_t d) const;
338   virtual Int_t    GetSector(Int_t d) const;
339           
340           
341   // Instance of this class and so on
342   static  AliTRDCalibraFillHisto *fgInstance;                // Instance
343   static  Bool_t   fgTerminated;                             // If terminated
344
345  private:
346   
347   // This is a singleton, contructor is private!
348   AliTRDCalibraFillHisto();
349   virtual ~AliTRDCalibraFillHisto(); 
350     
351   ClassDef(AliTRDCalibraFillHisto,7)                         // TRD Calibration class
352
353 };
354   
355 #endif
356
357