adding flag for non-field data
[u/mrichter/AliRoot.git] / PWG0 / AliCorrection.cxx
1 /* $Id$ */
2
3 // ------------------------------------------------------
4 //
5 // Class to handle corrections.
6 //
7 // ------------------------------------------------------
8 //
9
10 #include <TFile.h>
11 #include <TCanvas.h>
12 #include <TH3F.h>
13 #include <TH2F.h>
14 #include <TMath.h>
15
16 #include <AliLog.h>
17 #include "AliCorrectionMatrix2D.h"
18 #include "AliCorrectionMatrix3D.h"
19
20 #include "AliCorrection.h"
21
22 //____________________________________________________________________
23 ClassImp(AliCorrection)
24
25 //____________________________________________________________________
26 AliCorrection::AliCorrection() : TNamed(),
27   fEventCorr(0),
28   fTrackCorr(0)
29 {
30   // default constructor
31 }
32
33 //____________________________________________________________________
34 AliCorrection::AliCorrection(const Char_t* name, const Char_t* title, AliPWG0Helper::AnalysisMode analysisMode) : TNamed(name, title),
35   fEventCorr(0),
36   fTrackCorr(0)
37 {
38   // constructor initializing tnamed
39
40   Float_t* binLimitsPt = 0;
41   Int_t nBinsPt = 0;
42
43   // different binnings, better solution could be anticipated...
44   if ((analysisMode & AliPWG0Helper::kTPC || analysisMode & AliPWG0Helper::kTPCITS) && (analysisMode & AliPWG0Helper::kFieldOn))
45   {
46     static Float_t binLimitsPtTmp[] = {0.0, 0.05, 0.1, 0.125, 0.15, 0.175, 0.2, 0.225, 0.25, 0.275, 0.3, 0.325, 0.35, 0.375, 0.4, 0.425, 0.45, 0.475, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.5, 2.0, 5.0, 10.0, 100.0};
47     binLimitsPt = (Float_t*) binLimitsPtTmp;
48     nBinsPt = 28;
49   }
50   else if (analysisMode & AliPWG0Helper::kSPD || !(analysisMode & AliPWG0Helper::kFieldOn))
51   {
52     static Float_t binLimitsPtTmp[] = {-0.5, 100.0};
53     binLimitsPt = (Float_t*) binLimitsPtTmp;
54     nBinsPt = 1;
55   }
56
57   if (!binLimitsPt)
58   {
59     Printf("FATAL: Invalid binning");
60     return;
61   }
62
63   // third axis for track histogram
64   Int_t nBinsN2 = 1;
65   Float_t binLimitsN2[]   = {-0.5, 1000};
66   const char* title3 = "Ntracks";
67   //Int_t nBinsN2 = 21;
68   //Float_t binLimitsN2[]   = {-0.5, 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5, 9.5, 10.5, 12.5, 14.5, 16.5, 18.5, 20.5, 25.5, 30.5, 40.5, 50.5, 100.5, 1000.5};
69   // phi
70   //Int_t nBinsN2 = 36;
71   //Float_t binLimitsN2[]   = {0.000, 0.175, 0.349, 0.524, 0.698, 0.873, 1.047, 1.222, 1.396, 1.571, 1.745, 1.920, 2.094, 2.269, 2.443, 2.618, 2.793, 2.967, 3.142, 3.316, 3.491, 3.665, 3.840, 4.014, 4.189, 4.363, 4.538, 4.712, 4.887, 5.061, 5.236, 5.411, 5.585, 5.760, 5.934, 6.109, TMath::Pi() * 2};
72   //const char* title3 = "#phi";
73
74   // mult axis for event histogram
75   Int_t nBinsN = 22;
76   Float_t binLimitsN[]   = {-0.5, 0.5, 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5, 9.5, 10.5, 12.5, 14.5, 16.5, 18.5, 20.5, 25.5, 30.5, 40.5, 50.5, 100.5, 300.5};
77   //Int_t nBinsN = 52;
78   //Float_t binLimitsN[]   = {-0.5, 0.5, 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5, 9.5, 10.5, 11.5, 12.5, 13.5, 14.5, 15.5, 16.5, 17.5, 18.5, 19.5, 20.5, 21.5, 22.5, 23.5, 24.5, 25.5, 26.5, 27.5, 28.5, 29.5, 30.5, 31.5, 32.5, 33.5, 34.5, 35.5, 36.5, 37.5, 38.5, 39.5, 40.5, 41.5, 42.5, 43.5, 44.5, 45.5, 46.5, 47.5, 48.5, 49.5, 50.5, 100.5, 300.5};
79
80   //Float_t binLimitsVtx[] = {-20,-15,-10,-6,-3,0,3,6,10,15,20};
81   //Float_t binLimitsVtx[] = {-20,-19,-18,-17,-16,-15,-14,-13,-12,-11,-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20};
82   Float_t binLimitsVtx[] = {-30,-25,-20,-15,-10,-8,-6,-4,-2,0,2,4,6,8,10,15,20,25,30};
83   /*Float_t binLimitsEta[] = {-3.0,-2.8,-2.6,-2.4,-2.2,
84                             -2.0,-1.8,-1.6,-1.4,-1.2,
85                             -1.0,-0.8,-0.6,-0.4,-0.2, 0.0,
86                              0.2, 0.4, 0.6, 0.8, 1.0,
87                              1.2, 1.4, 1.6, 1.8, 2.0,
88                              2.2, 2.4, 2.6, 2.8, 3.0};*/
89   Float_t binLimitsEta[] = { -3.0, -2.9, -2.8, -2.7, -2.6, -2.5, -2.4, -2.3, -2.2, -2.1, -2.0, -1.9, -1.8, -1.7, -1.6, -1.5, -1.4, -1.3, -1.2, -1.1, -1.0, -0.9, -0.8, -0.7, -0.6, -0.5, -0.4, -0.3, -0.2, -0.1, -0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0 };
90 //  Float_t binLimitsEta[] = {-2,-1.8,-1.6,-1.4,-1.2,-1.0,-0.8,-0.6,-0.4,-0.2,0.0,0.2,0.4,0.6,0.8,1.0,1.2,1.4,1.6,1.8,2.0};
91 //  Float_t binLimitsEta[] = {-2,-1.9,-1.8,-1.7,-1.6,-1.5,-1.4,-1.3,-1.2,-1.1,-1.0,-0.9,-0.8,-0.7,-0.6,-0.5,-0.4,-0.3,-0.2,-0.1,0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2.0};
92 //  Float_t binLimitsEta[] = { -7.0, -6.9, -6.8, -6.7, -6.6, -6.5, -6.4, -6.3, -6.2, -6.1, -6.0, -5.9, -5.8, -5.7, -5.6, -5.5, -5.4, -5.3, -5.2, -5.1, -5.0, -4.9, -4.8, -4.7, -4.6, -4.5, -4.4, -4.3, -4.2, -4.1, -4.0, -3.9, -3.8, -3.7, -3.6, -3.5, -3.4, -3.3, -3.2, -3.1, -3.0, -2.9, -2.8, -2.7, -2.6, -2.5, -2.4, -2.3, -2.2, -2.1, -2.0, -1.9, -1.8, -1.7, -1.6, -1.5, -1.4, -1.3, -1.2, -1.1, -1.0, -0.9, -0.8, -0.7, -0.6, -0.5, -0.4, -0.3, -0.2, -0.1, -0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0 };
93
94   fEventCorr = new AliCorrectionMatrix2D("EventCorrection", Form("%s EventCorrection", fTitle.Data()), 18, binLimitsVtx, nBinsN, binLimitsN);
95
96   if (analysisMode & AliPWG0Helper::kSPD)
97   {
98     TH3F* dummyBinning = new TH3F("dummyBinning","dummyBinning",18, binLimitsVtx, 60, binLimitsEta, nBinsN2, binLimitsN2);
99     fTrackCorr = new AliCorrectionMatrix3D("TrackCorrection", Form("%s TrackCorrection", fTitle.Data()), dummyBinning);
100     fTrackCorr->SetAxisTitles("vtx-z (cm)", "#eta", title3);
101     delete dummyBinning;
102   }
103   else
104   {
105     TH3F* dummyBinning = new TH3F("dummyBinning","dummyBinning",18, binLimitsVtx, 60, binLimitsEta , nBinsPt, binLimitsPt);
106     fTrackCorr = new AliCorrectionMatrix3D("TrackCorrection", Form("%s TrackCorrection", fTitle.Data()), dummyBinning);
107     fTrackCorr->SetAxisTitles("vtx-z (cm)", "#eta", "p_{T} (GeV/c)");
108     delete dummyBinning;
109   }
110
111
112   fEventCorr->SetAxisTitles("vtx-z (cm)", "Ntracks");
113 }
114
115 //____________________________________________________________________
116 AliCorrection::AliCorrection(const AliCorrection& c) : TNamed(c),
117   fEventCorr(0),
118   fTrackCorr(0)
119 {
120   // copy constructor
121   ((AliCorrection &)c).Copy(*this);
122 }
123
124 //____________________________________________________________________
125 AliCorrection::~AliCorrection()
126 {
127   //
128   // destructor
129   //
130
131   if (fEventCorr)
132   {
133     delete fEventCorr;
134     fEventCorr = 0;
135   }
136
137   if (fTrackCorr)
138   {
139     delete fTrackCorr;
140     fTrackCorr = 0;
141   }
142 }
143
144 //____________________________________________________________________
145 AliCorrection &AliCorrection::operator=(const AliCorrection &c)
146 {
147   // assigment operator
148
149   if (this != &c)
150     ((AliCorrection &) c).Copy(*this);
151
152   return *this;
153 }
154
155 //____________________________________________________________________
156 void AliCorrection::Copy(TObject& c) const
157 {
158   // copy function
159
160   AliCorrection& target = (AliCorrection &) c;
161
162   if (fEventCorr)
163     target.fEventCorr = dynamic_cast<AliCorrectionMatrix2D*> (fEventCorr->Clone());
164
165   if (fTrackCorr)
166     target.fTrackCorr = dynamic_cast<AliCorrectionMatrix3D*> (fTrackCorr->Clone());
167 }
168
169 //____________________________________________________________________
170 Long64_t AliCorrection::Merge(TCollection* list)
171 {
172   // Merge a list of AliCorrection objects with this (needed for
173   // PROOF). 
174   // Returns the number of merged objects (including this).
175
176   if (!list)
177     return 0;
178   
179   if (list->IsEmpty())
180     return 1;
181
182   TIterator* iter = list->MakeIterator();
183   TObject* obj;
184
185   // collections of measured and generated histograms
186   TList* collectionEvent = new TList;
187   TList* collectionTrack = new TList;
188   
189   Int_t count = 0;
190   while ((obj = iter->Next())) {
191     
192     AliCorrection* entry = dynamic_cast<AliCorrection*> (obj);
193     if (entry == 0) 
194       continue;
195
196     collectionEvent->Add(entry->fEventCorr);
197     collectionTrack->Add(entry->fTrackCorr);
198
199     count++;
200   }
201   fEventCorr->Merge(collectionEvent);
202   fTrackCorr->Merge(collectionTrack);
203
204   delete collectionEvent;
205   delete collectionTrack;
206
207   return count+1;
208 }
209
210 //____________________________________________________________________
211 void AliCorrection::Divide()
212 {
213   //
214   // divide the histograms to get the correction
215   //
216   
217   if (!fEventCorr || !fTrackCorr)
218     return;
219     
220   fEventCorr->Divide();
221   fTrackCorr->Divide();
222
223   Int_t emptyBins = fTrackCorr->CheckEmptyBins(-9.99, 9.99, -0.79, 0.79, 0.2, 4.9);
224   printf("INFO: In the central region the track correction of %s has %d empty bins\n", GetName(), emptyBins);
225 }
226
227 //____________________________________________________________________
228 void AliCorrection::Add(AliCorrection* aCorrectionToAdd, Float_t c)
229 {
230   //
231   // add to measured and generated the measured and generated of aCorrectionToAdd
232   // with the weight c
233
234   fEventCorr->Add(aCorrectionToAdd->GetEventCorrection(),c);
235   fTrackCorr->Add(aCorrectionToAdd->GetTrackCorrection(),c);
236 }
237
238
239 //____________________________________________________________________
240 Bool_t AliCorrection::LoadHistograms(const Char_t* dir)
241 {
242   //
243   // loads the histograms from a file
244   // if dir is empty a directory with the name of this object is taken (like in SaveHistogram)
245   //
246
247   if (!fEventCorr || !fTrackCorr)
248     return kFALSE;
249
250   if (!dir)
251     dir = GetName();
252
253   if (!gDirectory->cd(dir))
254     return kFALSE;
255
256   Bool_t success = fEventCorr->LoadHistograms();
257   success &= fTrackCorr->LoadHistograms();
258
259   gDirectory->cd("..");
260
261   return success;
262 }
263
264 //____________________________________________________________________
265 void AliCorrection::SaveHistograms()
266 {
267   //
268   // saves the histograms in a directory with the name of this object (GetName)
269   //
270   
271   gDirectory->mkdir(GetName());
272   gDirectory->cd(GetName());
273
274   if (fEventCorr)
275     fEventCorr->SaveHistograms();
276
277   if (fTrackCorr)
278     fTrackCorr->SaveHistograms();
279     
280   gDirectory->cd("..");
281 }
282
283 //____________________________________________________________________
284 void AliCorrection::ReduceInformation()
285 {
286   // this function deletes the measured and generated histograms to reduce the amount of data
287   // in memory
288
289   if (!fEventCorr || !fTrackCorr)
290     return;
291
292   fEventCorr->ReduceInformation();
293   fTrackCorr->ReduceInformation();
294 }
295
296 //____________________________________________________________________
297 void AliCorrection::Reset(Option_t* option)
298 {
299   // resets the histograms
300
301   if (fEventCorr)
302     fEventCorr->Reset(option);
303
304   if (fTrackCorr)
305     fTrackCorr->Reset(option);
306 }
307
308 //____________________________________________________________________
309 void AliCorrection::DrawHistograms(const Char_t* name)
310 {
311   // draws the corrections
312
313   if (!name)
314     name = GetName();
315
316   if (fEventCorr)
317     fEventCorr->DrawHistograms(Form("%s event", name));
318
319   if (fTrackCorr)
320     fTrackCorr->DrawHistograms(Form("%s track", name));
321 }
322
323 void AliCorrection::DrawOverview(const char* canvasName)
324 {
325   // draw projection of the corrections
326   //   to the 3 axis of fTrackCorr and 2 axis of fEventCorr
327
328   TString canvasNameTmp(GetName());
329   if (canvasName)
330     canvasNameTmp = canvasName;
331
332   TCanvas* canvas = new TCanvas(canvasNameTmp, canvasNameTmp, 1200, 1200);
333   canvas->Divide(3, 3);
334
335   if (fTrackCorr) {
336     canvas->cd(1);
337     fTrackCorr->Get2DCorrectionHistogram("xy", 0, 0)->DrawCopy("COLZ")->GetZaxis()->SetRangeUser(0, 10);
338     
339     canvas->cd(2);
340     fTrackCorr->Get2DCorrectionHistogram("yz", 0, 0)->DrawCopy("COLZ")->GetZaxis()->SetRangeUser(0, 10);
341     
342     canvas->cd(3);
343     fTrackCorr->Get2DCorrectionHistogram("zx", 0, 0)->DrawCopy("COLZ")->GetZaxis()->SetRangeUser(0, 10);
344     
345     canvas->cd(4);
346     fTrackCorr->Get1DCorrectionHistogram("x", 0.3, 5, -1, 1)->DrawCopy()->GetYaxis()->SetRangeUser(0, 10);
347
348     canvas->cd(5);
349     fTrackCorr->Get1DCorrectionHistogram("y", 0.3, 5, 0, 0)->DrawCopy()->GetYaxis()->SetRangeUser(0, 10);
350
351     canvas->cd(6);
352     fTrackCorr->Get1DCorrectionHistogram("z", 0, -1, -1, 1)->DrawCopy()->GetYaxis()->SetRangeUser(0, 10);
353   }
354
355   if (fEventCorr)
356   {
357     canvas->cd(7);
358     fEventCorr->GetCorrectionHistogram()->DrawCopy("COLZ")->GetYaxis()->SetRangeUser(0, 30);
359     
360     canvas->cd(8);
361     fEventCorr->Get1DCorrectionHistogram("x")->DrawCopy();
362
363     canvas->cd(9);
364     fEventCorr->Get1DCorrectionHistogram("y")->DrawCopy()->GetXaxis()->SetRangeUser(0, 30);
365   }
366 }
367
368 //____________________________________________________________________
369 void AliCorrection::SetCorrectionToUnity()
370 {
371   // set the corrections to unity
372
373   if (fEventCorr)
374     fEventCorr->SetCorrectionToUnity();
375
376   if (fTrackCorr)
377     fTrackCorr->SetCorrectionToUnity();
378 }
379
380 //____________________________________________________________________
381 void AliCorrection::Multiply()
382 {
383   // call Multiply
384
385   if (fEventCorr)
386   {
387     fEventCorr->Multiply();
388     // now we manually copy the overflow bin of the y axis (multiplicity) over. This is important to get the event count correct
389     TH2* hist = fEventCorr->GetMeasuredHistogram();
390     for (Int_t x = 1; x <= hist->GetNbinsX(); ++x)
391       fEventCorr->GetGeneratedHistogram()->SetBinContent(x, hist->GetNbinsY() + 1, hist->GetBinContent(x, hist->GetNbinsY() + 1));
392   }
393
394   if (fTrackCorr)
395     fTrackCorr->Multiply();
396 }
397
398 //____________________________________________________________________
399 void AliCorrection::Scale(Double_t factor)
400 {
401   // scales the two contained corrections
402
403   fEventCorr->Scale(factor);
404   fTrackCorr->Scale(factor);
405 }
406
407 //____________________________________________________________________
408 void AliCorrection::PrintStats(Float_t zRange, Float_t etaRange, Float_t ptCut)
409 {
410   // prints statistics and effective correction factors
411
412   Printf("AliCorrection::PrintInfo: Values in |eta| < %.2f, |vtx-z| < %.2f and pt > %.2f:", etaRange, zRange, ptCut);
413
414   // prevent to be on bin border
415   zRange -= 0.1;
416   etaRange -= 0.1;
417
418   TH3* measured = GetTrackCorrection()->GetMeasuredHistogram();
419   TH3* generated = GetTrackCorrection()->GetGeneratedHistogram();
420
421   TH2* measuredEvents = GetEventCorrection()->GetMeasuredHistogram();
422   TH2* generatedEvents = GetEventCorrection()->GetGeneratedHistogram();
423
424   Float_t tracksM = measured->Integral(measured->GetXaxis()->FindBin(-zRange), measured->GetXaxis()->FindBin(zRange), measured->GetYaxis()->FindBin(-etaRange), measured->GetYaxis()->FindBin(etaRange), measured->GetZaxis()->FindBin(ptCut), measured->GetZaxis()->GetNbins());
425   Float_t tracksG = generated->Integral(generated->GetXaxis()->FindBin(-zRange), generated->GetXaxis()->FindBin(zRange), generated->GetYaxis()->FindBin(-etaRange), generated->GetYaxis()->FindBin(etaRange), generated->GetZaxis()->FindBin(ptCut), generated->GetZaxis()->GetNbins());
426
427   Float_t eventsM = measuredEvents->Integral(measuredEvents->GetXaxis()->FindBin(-zRange), measuredEvents->GetXaxis()->FindBin(zRange), 1, measuredEvents->GetNbinsY());
428   Float_t eventsG = generatedEvents->Integral(generatedEvents->GetXaxis()->FindBin(-zRange), generatedEvents->GetXaxis()->FindBin(zRange), 1, generatedEvents->GetNbinsY());
429
430   Printf("tracks measured: %.1f tracks generated: %.1f, events measured: %.1f, events generated %.1f", tracksM, tracksG, eventsM, eventsG);
431
432   if (tracksM > 0)
433     Printf("Effective average correction factor for TRACKS: %.3f", tracksG / tracksM);
434   if (eventsM > 0)
435     Printf("Effective average correction factor for EVENTS: %.3f", eventsG / eventsM);
436
437   if (eventsM > 0 && eventsG > 0)
438   {
439     // normalize to number of events;
440     tracksM /= eventsM;
441     tracksG /= eventsG;
442
443     Printf("%.2f tracks/event measured, %.2f tracks/event after correction --> effective average correction factor is %.3f (pt cut %.2f GeV/c)", tracksM, tracksG, (tracksM > 0) ? (tracksG / tracksM) : -1, ptCut);
444   }
445 }
446
447 //____________________________________________________________________
448 void AliCorrection::PrintInfo(Float_t ptCut)
449 {
450   // prints some stats
451
452   TH3* measured = GetTrackCorrection()->GetMeasuredHistogram();
453   TH3* generated = GetTrackCorrection()->GetGeneratedHistogram();
454
455   TH2* measuredEvents = GetEventCorrection()->GetMeasuredHistogram();
456   TH2* generatedEvents = GetEventCorrection()->GetGeneratedHistogram();
457
458   Printf("AliCorrection::PrintInfo: Whole phasespace:");
459
460   Printf("tracks measured: %.1f tracks generated: %.1f, events measured: %.1f, events generated %.1f", measured->Integral(), generated->Integral(), measuredEvents->Integral(), generatedEvents->Integral());
461
462   Printf("Example centered bin: tracks measured: %.1f tracks generated: %.1f, events measured: %.1f, events generated %.1f", measured->GetBinContent(measured->GetNbinsX() / 2, measured->GetNbinsY() / 2, measured->GetNbinsZ() / 2), generated->GetBinContent(measured->GetNbinsX() / 2, measured->GetNbinsY() / 2, measured->GetNbinsZ() / 2), measuredEvents->GetBinContent(measuredEvents->GetNbinsX() / 2, measuredEvents->GetNbinsY() / 2), generatedEvents->GetBinContent(measuredEvents->GetNbinsX() / 2, measuredEvents->GetNbinsY() / 2));
463
464   PrintStats(10, 0.8, ptCut);
465   PrintStats(10, 1.5, ptCut);
466 }