Important bug fixes
[u/mrichter/AliRoot.git] / STEER / STEERBase / AliTRDPIDResponse.cxx
1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3 *                                                                        *
4 * Author: The ALICE Off-line Project.                                    *
5 * Contributors are mentioned in the code where appropriate.              *
6 *                                                                        *
7 * Permission to use, copy, modify and distribute this software and its   *
8 * documentation strictly for non-commercial purposes is hereby granted   *
9 * without fee, provided that the above copyright notice appears in all   *
10 * copies and that both the copyright notice and this permission notice   *
11 * appear in the supporting documentation. The authors make no claims     *
12 * about the suitability of this software for any purpose. It is          *
13 * provided "as is" without express or implied warranty.                  *
14 **************************************************************************/
15 //
16 // PID Response class for the TRD detector
17 // Based on 1D Likelihood approach
18 // Calculation of probabilities using Bayesian approach
19 // Attention: This method is only used to separate electrons from pions
20 //
21 // Authors:
22 //  Markus Fasel <M.Fasel@gsi.de>
23 //  Anton Andronic <A.Andronic@gsi.de>
24 //
25 #include <TAxis.h>
26 #include <TClass.h>
27 #include <TDirectory.h>
28 #include <TFile.h>
29 #include <TH1.h>
30 #include <TKey.h>
31 #include <TMath.h>
32 #include <TObjArray.h>
33 #include <TROOT.h> 
34 #include <TString.h>
35 #include <TSystem.h>
36
37 #include "AliLog.h"
38
39 #include "AliTRDPIDResponseObject.h"
40 #include "AliTRDPIDResponse.h"
41 #include "AliTRDTKDInterpolator.h"
42
43 ClassImp(AliTRDPIDResponse)
44
45 //____________________________________________________________
46 AliTRDPIDResponse::AliTRDPIDResponse():
47   TObject()
48   ,fkPIDResponseObject(NULL)
49   ,fGainNormalisationFactor(1.)
50   ,fPIDmethod(kLQ1D)
51 {
52   //
53   // Default constructor
54   //
55 }
56
57 //____________________________________________________________
58 AliTRDPIDResponse::AliTRDPIDResponse(const AliTRDPIDResponse &ref):
59   TObject(ref)
60   ,fkPIDResponseObject(NULL)
61   ,fGainNormalisationFactor(ref.fGainNormalisationFactor)
62   ,fPIDmethod(ref.fPIDmethod)
63 {
64   //
65   // Copy constructor
66   //
67 }
68
69 //____________________________________________________________
70 AliTRDPIDResponse &AliTRDPIDResponse::operator=(const AliTRDPIDResponse &ref){
71   //
72   // Assignment operator
73   //
74   if(this == &ref) return *this;
75   
76   // Make copy
77   TObject::operator=(ref);
78   fGainNormalisationFactor = ref.fGainNormalisationFactor;
79   fkPIDResponseObject = ref.fkPIDResponseObject;
80   fPIDmethod = ref.fPIDmethod;
81   
82   return *this;
83 }
84
85 //____________________________________________________________
86 AliTRDPIDResponse::~AliTRDPIDResponse(){
87   //
88   // Destructor
89   //
90     if(IsOwner()) delete fkPIDResponseObject;
91 }
92
93 //____________________________________________________________
94 Bool_t AliTRDPIDResponse::Load(const Char_t * filename){
95   //
96   // Load References into the toolkit
97   //
98   AliDebug(1, "Loading reference histos from root file");
99   TDirectory *owd = gDirectory;// store old working directory
100   
101   if(!filename)
102     filename = Form("%s/STEER/LQ1dRef_v1.root",gSystem->ExpandPathName("$ALICE_ROOT"));
103   TFile *in = TFile::Open(filename);
104   if(!in){
105     AliError("Ref file not available.");
106     return kFALSE;
107   }
108   
109   gROOT->cd();
110   fkPIDResponseObject = dynamic_cast<const AliTRDPIDResponseObject *>(in->Get("TRDPIDResponse")->Clone());
111   in->Close(); delete in;
112   owd->cd();
113   SetBit(kIsOwner, kTRUE);
114   AliDebug(2, Form("Successfully loaded References for %d Momentum bins", fkPIDResponseObject->GetNumberOfMomentumBins()));
115   return kTRUE;
116 }
117
118 //____________________________________________________________
119 Bool_t AliTRDPIDResponse::GetResponse(Int_t n, const Double_t * const dedx, const Float_t * const p, Double_t prob[AliPID::kSPECIES], Bool_t kNorm) const
120 {
121   //
122   // Calculate TRD likelihood values for the track based on dedx and 
123   // momentum values. The likelihoods are calculated by query the 
124   // reference data depending on the PID method selected
125   //
126   // Input parameter :
127   //   n - number of dedx slices/chamber
128   //   dedx - array of dedx slices organized layer wise
129   //   p - array of momentum measurements organized layer wise
130   // 
131   // Return parameters
132   //   prob - probabilities allocated by TRD for particle specis
133   //   kNorm - switch to normalize probabilities to 1. By default true. If false return not normalized prob.
134   // 
135   // Return value
136   //   true if calculation success
137   // 
138
139     if(!fkPIDResponseObject){
140         AliWarning("Missing reference data. PID calculation not possible.");
141         return kFALSE;
142     }
143
144     for(Int_t is(AliPID::kSPECIES); is--;) prob[is]=.2;
145     Double_t prLayer[AliPID::kSPECIES];
146     Double_t dE[10], s(0.);
147     for(Int_t il(kNlayer); il--;){
148         memset(prLayer, 0, AliPID::kSPECIES*sizeof(Double_t));
149         if(!CookdEdx(n, &dedx[il*n], &dE[0])) continue;
150
151         s=0.;
152         Bool_t filled=kTRUE;
153         for(Int_t is(AliPID::kSPECIES); is--;){
154             if((fPIDmethod==kLQ2D)&&(!(is==0||is==2)))continue;
155             if((dE[0] > 0.) && (p[il] > 0.)) prLayer[is] = GetProbabilitySingleLayer(is, p[il], &dE[0]);
156             AliDebug(3, Form("Probability for Species %d in Layer %d: %e", is, il, prLayer[is]));
157             if(prLayer[is]<1.e-30){
158                 AliDebug(2, Form("Null for species %d species prob layer[%d].",is,il));
159                 filled=kFALSE;
160                 break;
161             }
162             s+=prLayer[is];
163         }
164         if(!filled){
165             continue;
166         }
167         if(s<1.e-30){
168             AliDebug(2, Form("Null all species prob layer[%d].", il));
169             continue;
170         }
171         for(Int_t is(AliPID::kSPECIES); is--;){
172             if(kNorm) prLayer[is] /= s;
173             prob[is] *= prLayer[is];
174         }
175     }
176     if(!kNorm) return kTRUE;
177
178     s=0.;
179     for(Int_t is(AliPID::kSPECIES); is--;) s+=prob[is];
180     if(s<1.e-30){
181         AliDebug(2, "Null total prob.");
182         return kFALSE;
183     }
184     for(Int_t is(AliPID::kSPECIES); is--;) prob[is]/=s;
185     return kTRUE;
186 }
187
188 //____________________________________________________________
189 Double_t AliTRDPIDResponse::GetProbabilitySingleLayer(Int_t species, Double_t plocal, Double_t *dEdx) const {
190   //
191   // Get the non-normalized probability for a certain particle species as coming
192   // from the reference histogram
193   // Interpolation between momentum bins
194   //
195   AliDebug(1, Form("Make Probability for Species %d with Momentum %f", species, plocal));
196
197   Double_t probLayer = 0.;
198   Float_t pLower, pUpper;
199         
200   switch(fPIDmethod){
201   case kNN: // NN
202       break;
203   case kLQ2D: // 2D LQ
204       {
205           if(species==0||species==2){ // references only for electrons and pions
206               Double_t error;
207               Double_t point[kNslicesLQ2D];
208               for(Int_t idim=0;idim<kNslicesLQ2D;idim++){point[idim]=dEdx[idim];}
209
210               AliTRDTKDInterpolator *refLower = dynamic_cast<AliTRDTKDInterpolator*>(fkPIDResponseObject->GetLowerReference((AliPID::EParticleType)species, plocal, pLower,kLQ2D));
211
212               if(refLower){
213                   refLower->Eval(point,probLayer,error);
214               }
215               else {
216                   AliError("No references available");
217               }
218               AliDebug(2,Form("Eval 2D Q0 %f Q1 %f P %e Err %e",point[0],point[1],probLayer,error));
219           }
220       }
221       break;
222   case kLQ1D: // 1D LQ
223       {
224           TH1 *refUpper = dynamic_cast<TH1 *>(fkPIDResponseObject->GetUpperReference((AliPID::EParticleType)species, plocal, pUpper,kLQ1D)),
225               *refLower = dynamic_cast<TH1 *>(fkPIDResponseObject->GetLowerReference((AliPID::EParticleType)species, plocal, pLower,kLQ1D));
226           // Do Interpolation exept for underflow and overflow
227           if(refLower && refUpper){
228               Double_t probLower = refLower->GetBinContent(refLower->GetXaxis()->FindBin(dEdx[0]));
229               Double_t probUpper = refUpper->GetBinContent(refUpper->GetXaxis()->FindBin(dEdx[0]));
230
231               probLayer = probLower + (probUpper - probLower)/(pUpper-pLower) * (plocal - pLower);
232           } else if(refLower){
233               // underflow
234               probLayer = refLower->GetBinContent(refLower->GetXaxis()->FindBin(dEdx[0]));
235           } else if(refUpper){
236               // overflow
237               probLayer = refUpper->GetBinContent(refUpper->GetXaxis()->FindBin(dEdx[0]));
238           } else {
239               AliError("No references available");
240           }
241           AliDebug(1, Form("Eval 1D dEdx %f Probability %e", dEdx[0],probLayer));
242       }
243       break;
244   default:
245       break;
246   }
247   return probLayer;
248 }
249
250 //____________________________________________________________
251 void AliTRDPIDResponse::SetOwner(){
252   //
253   // Make Deep Copy of the Reference Histograms
254   //
255     if(!fkPIDResponseObject || IsOwner()) return;
256     const AliTRDPIDResponseObject *tmp = fkPIDResponseObject;
257     fkPIDResponseObject = dynamic_cast<const AliTRDPIDResponseObject *>(tmp->Clone());
258     SetBit(kIsOwner, kTRUE);
259 }
260
261 //____________________________________________________________
262 Bool_t AliTRDPIDResponse::CookdEdx(Int_t nSlice, const Double_t * const in, Double_t *out) const
263 {
264     //
265     // Recalculate dE/dx
266     //
267   switch(fPIDmethod){
268   case kNN: // NN 
269       break;
270   case kLQ2D: // 2D LQ
271       out[0]=0;
272       out[1]=0;
273       for(Int_t islice = 0; islice < nSlice; islice++){
274           if(islice<fkPIDResponseObject->GetNSlicesQ0())out[0]+= in[islice];
275           else out[1]+= in[islice];
276       }
277       if(out[0] < 1e-6) return kFALSE;
278       AliDebug(3,Form("CookdEdx Q0 %f Q1 %f",out[0],out[1]));
279       break;
280   case kLQ1D: // 1D LQ
281       out[0]= 0.;
282       for(Int_t islice = 0; islice < nSlice; islice++)
283           if(in[islice] > 0) out[0] += in[islice] * fGainNormalisationFactor;   // Protect against negative values for slices having no dE/dx information
284       if(out[0] < 1e-6) return kFALSE;
285       AliDebug(3,Form("CookdEdx dEdx %f",out[0]));
286       break;
287
288   default:
289       return kFALSE;
290   }
291   return kTRUE;
292 }
293
294 //____________________________________________________________
295 Bool_t AliTRDPIDResponse::IdentifiedAsElectron(Int_t nTracklets, const Double_t *like, Double_t p, Double_t level) const {
296     //
297     // Check whether particle is identified as electron assuming a certain electron efficiency level
298     // Only electron and pion hypothesis is taken into account
299     //
300     // Inputs:
301     //         Number of tracklets
302     //         Likelihood values
303     //         Momentum
304     //         Electron efficiency level
305     //
306     // If the function fails when the params are not accessible, the function returns true
307     //
308   if(!fkPIDResponseObject){
309     AliError("No PID Param object available");
310     return kTRUE;
311   } 
312   Double_t probEle = like[AliPID::kElectron]/(like[AliPID::kElectron] + like[AliPID::kPion]);
313   Double_t params[4];
314   if(!fkPIDResponseObject->GetThresholdParameters(nTracklets, level, params,fPIDmethod)){
315     AliError("No Params found for the given configuration");
316     return kTRUE;
317   }
318   Double_t threshold = 1. - params[0] - params[1] * p - params[2] * TMath::Exp(-params[3] * p);
319   if(probEle > TMath::Max(TMath::Min(threshold, 0.99), 0.2)) return kTRUE; // truncate the threshold upperwards to 0.999 and lowerwards to 0.2 and exclude unphysical values
320   return kFALSE;
321 }
322
323 //____________________________________________________________
324 Bool_t AliTRDPIDResponse::SetPIDResponseObject(const AliTRDPIDResponseObject * obj){
325
326     fkPIDResponseObject = obj;
327     if((AliLog::GetDebugLevel("",IsA()->GetName()))>0)fkPIDResponseObject->Print("");
328     return kTRUE;
329 }