STEER/STEERBase/AliPIDResponse.h

   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                               */
   5
   6 //---------------------------------------------------------------//
   7 //        Base class for handling the pid response               //
   8 //        functions of all detectors                             //
   9 //        and give access to the nsigmas                         //
  10 //                                                               //
  11 //   Origin: Jens Wiechula, Uni Tuebingen, jens.wiechula@cern.ch //
  12 //---------------------------------------------------------------//
  13
  14 #include "AliVParticle.h"
  15 #include "AliVTrack.h"
  16
  17 #include "AliITSPIDResponse.h"
  18 #include "AliTPCPIDResponse.h"
  19 #include "AliTRDPIDResponse.h"
  20 #include "AliTOFPIDResponse.h"
  21 #include "AliHMPIDPIDResponse.h"
  22 #include "AliEMCALPIDResponse.h"
  23 #include "AliPID.h"
  24
  25 #include "TNamed.h"
  26
  27 class TF1;
  28 class TObjArray;
  29 class TLinearFitter;
  30
  31 class AliVEvent;
  32 class AliTRDPIDResponseObject;
  33 class AliTRDdEdxParams;
  34 class AliTOFPIDParams;
  35 class AliHMPIDPIDParams;
  36 class AliOADBContainer;
  37
  38 class AliPIDResponse : public TNamed {
  39 public:
  40   AliPIDResponse(Bool_t isMC=kFALSE);
  41   virtual ~AliPIDResponse();
  42
  43   enum EDetector {
  44     kITS=0,
  45     kTPC=1,
  46     kTRD=2,
  47     kTOF=3,
  48     kHMPID=4,
  49     kEMCAL=5,
  50     kPHOS=6,
  51     kNdetectors=7
  52   };
  53
  54   enum EDetCode {
  55     kDetITS = 0x1,
  56     kDetTPC = 0x2,
  57     kDetTRD = 0x4,
  58     kDetTOF = 0x8,
  59     kDetHMPID = 0x10,
  60     kDetEMCAL = 0x20,
  61     kDetPHOS = 0x40
  62   };
  63
  64   enum EBeamType {
  65     kPP = 0,
  66     kPPB,
  67     kPBPB
  68   };
  69
  70   enum EStartTimeType_t {kFILL_T0,kTOF_T0, kT0_T0, kBest_T0};
  71
  72   enum ITSPIDmethod { kITSTruncMean, kITSLikelihood };
  73
  74   enum EDetPidStatus {
  75     kDetNoSignal=0,
  76     kDetPidOk=1,
  77     kDetMismatch=2,
  78     kDetNoParams=3
  79   };
  80
  81   AliITSPIDResponse &GetITSResponse() {return fITSResponse;}
  82   AliTPCPIDResponse &GetTPCResponse() {return fTPCResponse;}
  83   AliTOFPIDResponse &GetTOFResponse() {return fTOFResponse;}
  84   AliTRDPIDResponse &GetTRDResponse() {return fTRDResponse;}
  85   AliEMCALPIDResponse &GetEMCALResponse() {return fEMCALResponse;}
  86
  87   // -----------------------------------------
  88   // buffered getters
  89   //
  90
  91   // Number of sigmas
  92   EDetPidStatus NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Double_t &val) const;
  93
  94   Float_t NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
  95
  96   virtual Float_t NumberOfSigmasITS  (const AliVParticle *track, AliPID::EParticleType type) const;
  97   virtual Float_t NumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type) const;
  98   virtual Float_t NumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type, AliTPCPIDResponse::ETPCdEdxSource dedxSource) const;
  99   virtual Float_t NumberOfSigmasTRD  (const AliVParticle *track, AliPID::EParticleType type) const;
 100   virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
 101   virtual Float_t NumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type) const;
 102   virtual Float_t NumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type, Float_t /*timeZeroTOF*/) const { return NumberOfSigmasTOF(track,type); }
 103   virtual Float_t NumberOfSigmasHMPID(const AliVParticle *track, AliPID::EParticleType type) const;
 104   virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
 105
 106   Bool_t IdentifiedAsElectronTRD(const AliVTrack *track, Double_t efficiencyLevel,Double_t centrality=-1,AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
 107   Bool_t IdentifiedAsElectronTRD(const AliVTrack *track, Int_t &ntracklets, Double_t efficiencyLevel,Double_t centrality=-1,AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
 108
 109
 110   // Signal delta
 111   EDetPidStatus GetSignalDelta(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 112   Double_t GetSignalDelta(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Bool_t ratio=kFALSE) const;
 113
 114   // Probabilities
 115   EDetPidStatus ComputePIDProbability  (EDetCode  detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 116   EDetPidStatus ComputePIDProbability  (EDetector detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 117
 118   virtual EDetPidStatus ComputeITSProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 119   virtual EDetPidStatus ComputeTPCProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 120   virtual EDetPidStatus ComputeTOFProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 121   virtual EDetPidStatus ComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 122   virtual EDetPidStatus ComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 123   virtual EDetPidStatus ComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 124   virtual EDetPidStatus ComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 125
 126   virtual EDetPidStatus ComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod) const;
 127
 128   // pid status
 129   EDetPidStatus CheckPIDStatus(EDetector detCode, const AliVTrack *track)  const;
 130
 131   AliTOFPIDParams *GetTOFPIDParams() const {return fTOFPIDParams;}
 132   Float_t GetTOFMismatchProbability(const AliVTrack *track = NULL) const; // if empty argument return the value stored during TOF probability computation
 133
 134   void SetITSPIDmethod(ITSPIDmethod pmeth) { fITSPIDmethod = pmeth; }
 135
 136   void SetOADBPath(const char* path) {fOADBPath=path;}
 137   const char *GetOADBPath() const {return fOADBPath.Data();}
 138
 139   void SetCustomTPCpidResponse(const char* tpcpid) { fCustomTPCpidResponse = tpcpid; }
 140   const char* GetCustomTPCpidResponse() const { return fCustomTPCpidResponse.Data(); }
 141
 142   void InitialiseEvent(AliVEvent *event, Int_t pass, Int_t run=-1);
 143   void SetCurrentFile(const char* file) { fCurrentFile=file; }
 144
 145   void SetCurrentAliRootRev(Int_t alirootRev) { fCurrentAliRootRev = alirootRev; }
 146   Int_t GetCurrentAliRootRev() const { return fCurrentAliRootRev; }
 147
 148   // cache PID in the track
 149   void SetCachePID(Bool_t cache)    { fCachePID=cache;  }
 150   Bool_t GetCachePID() const { return fCachePID; }
 151   void FillTrackDetectorPID(const AliVTrack *track, EDetector detector) const;
 152   void FillTrackDetectorPID();
 153
 154   AliVEvent * GetCurrentEvent() const {return fCurrentEvent;}
 155
 156   // User settings for the MC period and reco pass
 157   void SetMCperiod(const char *mcPeriod) {fMCperiodUser=mcPeriod;}
 158   void SetRecoPass(Int_t recoPass)       {fRecoPassUser=recoPass;}
 159
 160   // event info
 161   Float_t GetCurrentCentrality() const {return fCurrCentrality;};
 162   void SetCurrentCentrality(Float_t centrality) {fCurrCentrality=centrality;fEMCALResponse.SetCentrality(fCurrCentrality);};
 163   // TPC setting
 164   void SetUseTPCEtaCorrection(Bool_t useEtaCorrection = kTRUE) { fUseTPCEtaCorrection = useEtaCorrection; };
 165   Bool_t UseTPCEtaCorrection() const { return fUseTPCEtaCorrection; };
 166
 167   void SetUseTPCMultiplicityCorrection(Bool_t useMultiplicityCorrection = kTRUE) { fUseTPCMultiplicityCorrection = useMultiplicityCorrection; };
 168   Bool_t UseTPCMultiplicityCorrection() const { return fUseTPCMultiplicityCorrection; };
 169
 170   // TOF setting
 171   void SetTOFtail(Float_t tail=0.9){if(tail > 0) fTOFtail=tail; else printf("TOF tail should be greater than 0 (nothing done)\n");};
 172   void SetTOFResponse(AliVEvent *vevent,EStartTimeType_t option);
 173
 174   virtual Float_t GetTPCsignalTunedOnData(const AliVTrack *t) const {return t->GetTPCsignal();};
 175   virtual Float_t GetTOFsignalTunedOnData(const AliVTrack *t) const {return t->GetTOFsignal();};
 176   Bool_t IsTunedOnData() const {return fTuneMConData;};
 177   void SetTunedOnData(Bool_t flag=kTRUE,Int_t recoPass=0){fTuneMConData = flag; if(recoPass>0) fRecoPassUser = recoPass;};
 178   Int_t GetTunedOnDataMask() const {return fTuneMConDataMask;};
 179   void SetTunedOnDataMask(Int_t detMask) {fTuneMConDataMask = detMask;}
 180
 181   // Utilities
 182   TString GetChecksum(const TObject* obj) const;
 183
 184   AliPIDResponse(const AliPIDResponse &other);
 185   AliPIDResponse& operator=(const AliPIDResponse &other);
 186
 187
 188 protected:
 189   AliITSPIDResponse   fITSResponse;    //PID response function of the ITS
 190   AliTPCPIDResponse   fTPCResponse;    //PID response function of the TPC
 191   AliTRDPIDResponse   fTRDResponse;    //PID response function of the TRD
 192   AliTOFPIDResponse   fTOFResponse;    //PID response function of the TOF
 193   AliHMPIDPIDResponse fHMPIDResponse;  //PID response function of the HMPID
 194   AliEMCALPIDResponse fEMCALResponse;  //PID response function of the EMCAL
 195
 196   Float_t           fRange;          // nSigma max in likelihood
 197   ITSPIDmethod      fITSPIDmethod;   // 0 = trunc mean; 1 = likelihood
 198
 199   //unbuffered PID calculation
 200   virtual Float_t GetNumberOfSigmasTOFold  (const AliVParticle */*track*/, AliPID::EParticleType /*type*/) const {return 0;}
 201   virtual Float_t GetSignalDeltaTOFold(const AliVParticle */*track*/, AliPID::EParticleType /*type*/, Bool_t /*ratio*/=kFALSE) const {return -9999.;}
 202
 203   Int_t CalculateTRDResponse(const AliVTrack *track, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod) const;
 204   EDetPidStatus GetComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
 205   EDetPidStatus GetTOFPIDStatus(const AliVTrack *track) const;
 206
 207   Bool_t fTuneMConData;                // switch to force the MC to be similar to data
 208   Int_t fTuneMConDataMask;             // select for which detectors enable MC tuning on data
 209
 210
 211 private:
 212   static Float_t fgTOFmismatchProb;    // TOF mismatch probability (Bayesian)
 213
 214   Bool_t fIsMC;                        //  If we run on MC data
 215   Bool_t fCachePID;
 216
 217   TString fOADBPath;                   // OADB path to use
 218   TString fCustomTPCpidResponse;       // Custom TPC Pid Response file for debugging purposes
 219
 220   TString fBeamType;                   //! beam type (PP) or (PBPB)
 221   TString fLHCperiod;                  //! LHC period
 222   TString fMCperiodTPC;                //! corresponding MC period to use for the TPC splines
 223   TString fMCperiodUser;               //  MC prodution requested by the user
 224   TString fCurrentFile;                //! name of currently processed file
 225   Int_t   fCurrentAliRootRev;          //! Aliroot rev. used to reconstruct the data
 226   Int_t   fRecoPass;                   //! reconstruction pass
 227   Int_t   fRecoPassUser;               //  reconstruction pass explicitly set by the user
 228   Int_t   fRun;                        //! current run number
 229   Int_t   fOldRun;                     //! current run number
 230   Float_t fResT0A;                     //! T0A resolution in current run
 231   Float_t fResT0C;                     //! T0C resolution in current run
 232   Float_t fResT0AC;                    //! T0A.and.T0C resolution in current run
 233
 234   TObjArray *fArrPidResponseMaster;     //!  TPC pid splines
 235   TF1       *fResolutionCorrection;     //! TPC resolution correction
 236   AliOADBContainer* fOADBvoltageMaps;   //! container with the voltage maps
 237   Bool_t fUseTPCEtaCorrection;          // Use TPC eta correction
 238   Bool_t fUseTPCMultiplicityCorrection; // Use TPC multiplicity correction
 239
 240   AliTRDPIDResponseObject *fTRDPIDResponseObject; //! TRD PID Response Object
 241   AliTRDdEdxParams * fTRDdEdxParams; //! TRD dEdx Response for truncated mean signal
 242
 243   Float_t fTOFtail;                    //! TOF tail effect used in TOF probability
 244   AliTOFPIDParams *fTOFPIDParams;      //! TOF PID Params - period depending (OADB loaded)
 245
 246   AliHMPIDPIDParams *fHMPIDPIDParams;  //! HMPID PID Params (OADB loaded)
 247
 248   TObjArray *fEMCALPIDParams;             //! EMCAL PID Params
 249
 250   AliVEvent *fCurrentEvent;            //! event currently being processed
 251
 252   Float_t fCurrCentrality;             //! current centrality
 253
 254   EBeamType fBeamTypeNum;              //! beam type enum
 255
 256   void ExecNewRun();
 257
 258   //
 259   //setup parametrisations
 260   //
 261
 262   //ITS
 263   void SetITSParametrisation();
 264
 265   //TPC
 266   void SetTPCEtaMaps(Double_t refineFactorMapX = 6.0, Double_t refineFactorMapY = 6.0, Double_t refineFactorSigmaMapX = 6.0,
 267                      Double_t refineFactorSigmaMapY = 6.0);
 268   void SetTPCPidResponseMaster();
 269   void SetTPCParametrisation();
 270   Double_t GetTPCMultiplicityBin(const AliVEvent * const event);
 271
 272   // TPC helpers for the eta maps
 273   void AddPointToHyperplane(TH2D* h, TLinearFitter* linExtrapolation, Int_t binX, Int_t binY);
 274   TH2D* RefineHistoViaLinearInterpolation(TH2D* h, Double_t refineFactorX = 6.0, Double_t refineFactorY = 6.0);
 275
 276   //TRD
 277   void SetTRDPidResponseMaster();
 278   void InitializeTRDResponse();
 279   void SetTRDSlices(UInt_t TRDslicesForPID[2],AliTRDPIDResponse::ETRDPIDMethod method) const;
 280   void SetTRDdEdxParams();
 281
 282   //TOF
 283   void SetTOFPidResponseMaster();
 284   void InitializeTOFResponse();
 285
 286   //HMPID
 287   void SetHMPIDPidResponseMaster();
 288   void InitializeHMPIDResponse();
 289
 290   //EMCAL
 291   void SetEMCALPidResponseMaster();
 292   void InitializeEMCALResponse();
 293
 294   //
 295   void SetRecoInfo();
 296
 297   //-------------------------------------------------
 298   //unbuffered PID calculation
 299   //
 300
 301   // Number of sigmas
 302   Float_t GetNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
 303   Float_t GetNumberOfSigmasITS  (const AliVParticle *track, AliPID::EParticleType type) const;
 304   Float_t GetNumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type) const;
 305   Float_t GetNumberOfSigmasTRD  (const AliVParticle *track, AliPID::EParticleType type) const;
 306   Float_t GetNumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type) const;
 307   Float_t GetNumberOfSigmasHMPID(const AliVParticle *track, AliPID::EParticleType type) const;
 308   Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
 309   Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
 310
 311   Float_t GetBufferedNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
 312
 313   // Signal deltas
 314   EDetPidStatus GetSignalDeltaITS(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 315   EDetPidStatus GetSignalDeltaTPC(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 316   EDetPidStatus GetSignalDeltaTRD(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 317   EDetPidStatus GetSignalDeltaTOF(const AliVParticle *track, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 318   EDetPidStatus GetSignalDeltaHMPID(const AliVParticle *vtrack, AliPID::EParticleType type, Double_t &val, Bool_t ratio=kFALSE) const;
 319
 320   // Probabilities
 321   EDetPidStatus GetComputePIDProbability  (EDetector detCode,  const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 322   EDetPidStatus GetComputeITSProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 323   EDetPidStatus GetComputeTPCProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 324   EDetPidStatus GetComputeTOFProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 325   EDetPidStatus GetComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 326   EDetPidStatus GetComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 327   EDetPidStatus GetComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 328
 329   // pid status
 330   EDetPidStatus GetPIDStatus(EDetector det, const AliVTrack *track) const;
 331   EDetPidStatus GetITSPIDStatus(const AliVTrack *track) const;
 332   EDetPidStatus GetTPCPIDStatus(const AliVTrack *track) const;
 333   EDetPidStatus GetTRDPIDStatus(const AliVTrack *track) const;
 334   EDetPidStatus GetHMPIDPIDStatus(const AliVTrack *track) const;
 335   EDetPidStatus GetPHOSPIDStatus(const AliVTrack *track) const;
 336   EDetPidStatus GetEMCALPIDStatus(const AliVTrack *track) const;
 337
 338   ClassDef(AliPIDResponse, 13);  //PID response handling
 339 };
 340
 341 #endif