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