1 #ifndef ALIPIDRESPONSE_H
2 #define ALIPIDRESPONSE_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * See cxx source for full Copyright notice */
6 //---------------------------------------------------------------//
7 // Base class for handling the pid response //
8 // functions of all detectors //
9 // and give access to the nsigmas //
11 // Origin: Jens Wiechula, Uni Tuebingen, jens.wiechula@cern.ch //
12 //---------------------------------------------------------------//
14 #include "AliVParticle.h"
15 #include "AliVTrack.h"
17 #include "AliITSPIDResponse.h"
18 #include "AliTPCPIDResponse.h"
19 #include "AliTRDPIDResponse.h"
20 #include "AliTOFPIDResponse.h"
21 #include "AliHMPIDPIDResponse.h"
22 #include "AliEMCALPIDResponse.h"
32 class AliTRDPIDResponseObject;
33 class AliTOFPIDParams;
34 class AliHMPIDPIDParams;
35 class AliOADBContainer;
37 class AliPIDResponse : public TNamed {
39 AliPIDResponse(Bool_t isMC=kFALSE);
40 virtual ~AliPIDResponse();
69 enum EStartTimeType_t {kFILL_T0,kTOF_T0, kT0_T0, kBest_T0};
71 enum ITSPIDmethod { kITSTruncMean, kITSLikelihood };
80 AliITSPIDResponse &GetITSResponse() {return fITSResponse;}
81 AliTPCPIDResponse &GetTPCResponse() {return fTPCResponse;}
82 AliTOFPIDResponse &GetTOFResponse() {return fTOFResponse;}
83 AliTRDPIDResponse &GetTRDResponse() {return fTRDResponse;}
84 AliEMCALPIDResponse &GetEMCALResponse() {return fEMCALResponse;}
86 // -----------------------------------------
91 EDetPidStatus NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Double_t &val) const;
93 Float_t NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
95 virtual Float_t NumberOfSigmasITS (const AliVParticle *track, AliPID::EParticleType type) const;
96 virtual Float_t NumberOfSigmasTPC (const AliVParticle *track, AliPID::EParticleType type) const;
97 virtual Float_t NumberOfSigmasTPC (const AliVParticle *track, AliPID::EParticleType type, AliTPCPIDResponse::ETPCdEdxSource dedxSource) const;
98 virtual Float_t NumberOfSigmasTRD (const AliVParticle *track, AliPID::EParticleType type) const;
99 virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
100 virtual Float_t NumberOfSigmasTOF (const AliVParticle *track, AliPID::EParticleType type) const;
101 virtual Float_t NumberOfSigmasTOF (const AliVParticle *track, AliPID::EParticleType type, Float_t /*timeZeroTOF*/) const { return NumberOfSigmasTOF(track,type); }
102 virtual Float_t NumberOfSigmasHMPID(const AliVParticle *track, AliPID::EParticleType type) const;
103 virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
105 Bool_t IdentifiedAsElectronTRD(const AliVTrack *track, Double_t efficiencyLevel,Double_t centrality=-1,AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
106 Bool_t IdentifiedAsElectronTRD(const AliVTrack *track, Int_t &ntracklets, Double_t efficiencyLevel,Double_t centrality=-1,AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
110 EDetPidStatus GetSignalDelta(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
111 Double_t GetSignalDelta(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Bool_t ratio=kFALSE) const;
114 EDetPidStatus ComputePIDProbability (EDetCode detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
115 EDetPidStatus ComputePIDProbability (EDetector detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
117 virtual EDetPidStatus ComputeITSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
118 virtual EDetPidStatus ComputeTPCProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
119 virtual EDetPidStatus ComputeTOFProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
120 virtual EDetPidStatus ComputeTRDProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
121 virtual EDetPidStatus ComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
122 virtual EDetPidStatus ComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
123 virtual EDetPidStatus ComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
125 virtual EDetPidStatus ComputeTRDProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod) const;
128 EDetPidStatus CheckPIDStatus(EDetector detCode, const AliVTrack *track) const;
130 AliTOFPIDParams *GetTOFPIDParams() const {return fTOFPIDParams;}
131 Float_t GetTOFMismatchProbability(const AliVTrack *track = NULL) const; // if empty argument return the value stored during TOF probability computation
133 void SetITSPIDmethod(ITSPIDmethod pmeth) { fITSPIDmethod = pmeth; }
135 void SetOADBPath(const char* path) {fOADBPath=path;}
136 const char *GetOADBPath() const {return fOADBPath.Data();}
138 void SetCustomTPCpidResponse(const char* tpcpid) { fCustomTPCpidResponse = tpcpid; }
139 const char* GetCustomTPCpidResponse() const { return fCustomTPCpidResponse.Data(); }
141 void InitialiseEvent(AliVEvent *event, Int_t pass, Int_t run=-1);
142 void SetCurrentFile(const char* file) { fCurrentFile=file; }
144 void SetCurrentAliRootRev(Int_t alirootRev) { fCurrentAliRootRev = alirootRev; }
145 Int_t GetCurrentAliRootRev() const { return fCurrentAliRootRev; }
147 // cache PID in the track
148 void SetCachePID(Bool_t cache) { fCachePID=cache; }
149 Bool_t GetCachePID() const { return fCachePID; }
150 void FillTrackDetectorPID(const AliVTrack *track, EDetector detector) const;
151 void FillTrackDetectorPID();
153 AliVEvent * GetCurrentEvent() const {return fCurrentEvent;}
155 // User settings for the MC period and reco pass
156 void SetMCperiod(const char *mcPeriod) {fMCperiodUser=mcPeriod;}
157 void SetRecoPass(Int_t recoPass) {fRecoPassUser=recoPass;}
160 Float_t GetCurrentCentrality() const {return fCurrCentrality;};
161 void SetCurrentCentrality(Float_t centrality) {fCurrCentrality=centrality;fEMCALResponse.SetCentrality(fCurrCentrality);};
163 void SetUseTPCEtaCorrection(Bool_t useEtaCorrection = kTRUE) { fUseTPCEtaCorrection = useEtaCorrection; };
164 Bool_t UseTPCEtaCorrection() const { return fUseTPCEtaCorrection; };
166 void SetUseTPCMultiplicityCorrection(Bool_t useMultiplicityCorrection = kTRUE) { fUseTPCMultiplicityCorrection = useMultiplicityCorrection; };
167 Bool_t UseTPCMultiplicityCorrection() const { return fUseTPCMultiplicityCorrection; };
170 void SetTOFtail(Float_t tail=0.9){if(tail > 0) fTOFtail=tail; else printf("TOF tail should be greater than 0 (nothing done)\n");};
171 void SetTOFResponse(AliVEvent *vevent,EStartTimeType_t option);
173 virtual Float_t GetTPCsignalTunedOnData(const AliVTrack *t) const {return t->GetTPCsignal();};
174 virtual Float_t GetTOFsignalTunedOnData(const AliVTrack *t) const {return t->GetTOFsignal();};
175 Bool_t IsTunedOnData() const {return fTuneMConData;};
176 void SetTunedOnData(Bool_t flag=kTRUE,Int_t recoPass=0){fTuneMConData = flag; if(recoPass>0) fRecoPassUser = recoPass;};
177 Int_t GetTunedOnDataMask() const {return fTuneMConDataMask;};
178 void SetTunedOnDataMask(Int_t detMask) {fTuneMConDataMask = detMask;}
181 TString GetChecksum(const TObject* obj) const;
183 AliPIDResponse(const AliPIDResponse &other);
184 AliPIDResponse& operator=(const AliPIDResponse &other);
188 AliITSPIDResponse fITSResponse; //PID response function of the ITS
189 AliTPCPIDResponse fTPCResponse; //PID response function of the TPC
190 AliTRDPIDResponse fTRDResponse; //PID response function of the TRD
191 AliTOFPIDResponse fTOFResponse; //PID response function of the TOF
192 AliHMPIDPIDResponse fHMPIDResponse; //PID response function of the HMPID
193 AliEMCALPIDResponse fEMCALResponse; //PID response function of the EMCAL
195 Float_t fRange; // nSigma max in likelihood
196 ITSPIDmethod fITSPIDmethod; // 0 = trunc mean; 1 = likelihood
198 //unbuffered PID calculation
199 virtual Float_t GetNumberOfSigmasTOFold (const AliVParticle */*track*/, AliPID::EParticleType /*type*/) const {return 0;}
200 virtual Float_t GetSignalDeltaTOFold(const AliVParticle */*track*/, AliPID::EParticleType /*type*/, Bool_t /*ratio*/=kFALSE) const {return -9999.;}
202 Int_t CalculateTRDResponse(const AliVTrack *track, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod) const;
203 EDetPidStatus GetComputeTRDProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
204 EDetPidStatus GetTOFPIDStatus(const AliVTrack *track) const;
206 Bool_t fTuneMConData; // switch to force the MC to be similar to data
207 Int_t fTuneMConDataMask; // select for which detectors enable MC tuning on data
211 static Float_t fgTOFmismatchProb; // TOF mismatch probability (Bayesian)
213 Bool_t fIsMC; // If we run on MC data
216 TString fOADBPath; // OADB path to use
217 TString fCustomTPCpidResponse; // Custom TPC Pid Response file for debugging purposes
219 TString fBeamType; //! beam type (PP) or (PBPB)
220 TString fLHCperiod; //! LHC period
221 TString fMCperiodTPC; //! corresponding MC period to use for the TPC splines
222 TString fMCperiodUser; // MC prodution requested by the user
223 TString fCurrentFile; //! name of currently processed file
224 Int_t fCurrentAliRootRev; //! Aliroot rev. used to reconstruct the data
225 Int_t fRecoPass; //! reconstruction pass
226 Int_t fRecoPassUser; // reconstruction pass explicitly set by the user
227 Int_t fRun; //! current run number
228 Int_t fOldRun; //! current run number
229 Float_t fResT0A; //! T0A resolution in current run
230 Float_t fResT0C; //! T0C resolution in current run
231 Float_t fResT0AC; //! T0A.and.T0C resolution in current run
233 TObjArray *fArrPidResponseMaster; //! TPC pid splines
234 TF1 *fResolutionCorrection; //! TPC resolution correction
235 AliOADBContainer* fOADBvoltageMaps; //! container with the voltage maps
236 Bool_t fUseTPCEtaCorrection; // Use TPC eta correction
237 Bool_t fUseTPCMultiplicityCorrection; // Use TPC multiplicity correction
239 AliTRDPIDResponseObject *fTRDPIDResponseObject; //! TRD PID Response Object
241 Float_t fTOFtail; //! TOF tail effect used in TOF probability
242 AliTOFPIDParams *fTOFPIDParams; //! TOF PID Params - period depending (OADB loaded)
244 AliHMPIDPIDParams *fHMPIDPIDParams; //! HMPID PID Params (OADB loaded)
246 TObjArray *fEMCALPIDParams; //! EMCAL PID Params
248 AliVEvent *fCurrentEvent; //! event currently being processed
250 Float_t fCurrCentrality; //! current centrality
252 EBeamType fBeamTypeNum; //! beam type enum
257 //setup parametrisations
261 void SetITSParametrisation();
264 void SetTPCEtaMaps(Double_t refineFactorMapX = 6.0, Double_t refineFactorMapY = 6.0, Double_t refineFactorSigmaMapX = 6.0,
265 Double_t refineFactorSigmaMapY = 6.0);
266 void SetTPCPidResponseMaster();
267 void SetTPCParametrisation();
268 Double_t GetTPCMultiplicityBin(const AliVEvent * const event);
270 // TPC helpers for the eta maps
271 void AddPointToHyperplane(TH2D* h, TLinearFitter* linExtrapolation, Int_t binX, Int_t binY);
272 TH2D* RefineHistoViaLinearInterpolation(TH2D* h, Double_t refineFactorX = 6.0, Double_t refineFactorY = 6.0);
275 void SetTRDPidResponseMaster();
276 void InitializeTRDResponse();
277 void SetTRDSlices(UInt_t TRDslicesForPID[2],AliTRDPIDResponse::ETRDPIDMethod method) const;
280 void SetTOFPidResponseMaster();
281 void InitializeTOFResponse();
284 void SetHMPIDPidResponseMaster();
285 void InitializeHMPIDResponse();
288 void SetEMCALPidResponseMaster();
289 void InitializeEMCALResponse();
294 //-------------------------------------------------
295 //unbuffered PID calculation
299 Float_t GetNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
300 Float_t GetNumberOfSigmasITS (const AliVParticle *track, AliPID::EParticleType type) const;
301 Float_t GetNumberOfSigmasTPC (const AliVParticle *track, AliPID::EParticleType type) const;
302 Float_t GetNumberOfSigmasTRD (const AliVParticle *track, AliPID::EParticleType type) const;
303 Float_t GetNumberOfSigmasTOF (const AliVParticle *track, AliPID::EParticleType type) const;
304 Float_t GetNumberOfSigmasHMPID(const AliVParticle *track, AliPID::EParticleType type) const;
305 Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
306 Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
308 Float_t GetBufferedNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
311 EDetPidStatus GetSignalDeltaITS(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
312 EDetPidStatus GetSignalDeltaTPC(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
313 EDetPidStatus GetSignalDeltaTRD(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
314 EDetPidStatus GetSignalDeltaTOF(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
315 EDetPidStatus GetSignalDeltaHMPID(const AliVParticle *vtrack, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
318 EDetPidStatus GetComputePIDProbability (EDetector detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
319 EDetPidStatus GetComputeITSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
320 EDetPidStatus GetComputeTPCProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
321 EDetPidStatus GetComputeTOFProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
322 EDetPidStatus GetComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
323 EDetPidStatus GetComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
324 EDetPidStatus GetComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
327 EDetPidStatus GetPIDStatus(EDetector det, const AliVTrack *track) const;
328 EDetPidStatus GetITSPIDStatus(const AliVTrack *track) const;
329 EDetPidStatus GetTPCPIDStatus(const AliVTrack *track) const;
330 EDetPidStatus GetTRDPIDStatus(const AliVTrack *track) const;
331 EDetPidStatus GetHMPIDPIDStatus(const AliVTrack *track) const;
332 EDetPidStatus GetPHOSPIDStatus(const AliVTrack *track) const;
333 EDetPidStatus GetEMCALPIDStatus(const AliVTrack *track) const;
335 ClassDef(AliPIDResponse, 13); //PID response handling