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