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 "AliITSPIDResponse.h"
  15 #include "AliTPCPIDResponse.h"
  16 #include "AliTRDPIDResponse.h"
  17 #include "AliTOFPIDResponse.h"
  18 #include "AliEMCALPIDResponse.h"
  19
  20
  21 #include "AliVParticle.h"
  22 #include "AliVTrack.h"
  23
  24 #include "TNamed.h"
  25
  26 class TF1;
  27 class TObjArray;
  28 class TLinearFitter;
  29
  30 class AliVEvent;
  31 class AliTRDPIDResponseObject;
  32 class AliTOFPIDParams;
  33 class AliOADBContainer;
  34
  35 class AliPIDResponse : public TNamed {
  36 public:
  37   AliPIDResponse(Bool_t isMC=kFALSE);
  38   virtual ~AliPIDResponse();
  39
  40   enum EDetector {
  41     kITS=0,
  42     kTPC=1,
  43     kTRD=2,
  44     kTOF=3,
  45     kHMPID=4,
  46     kEMCAL=5,
  47     kPHOS=6,
  48     kNdetectors=7
  49   };
  50
  51   enum EDetCode {
  52     kDetITS = 0x1,
  53     kDetTPC = 0x2,
  54     kDetTRD = 0x4,
  55     kDetTOF = 0x8,
  56     kDetHMPID = 0x10,
  57     kDetEMCAL = 0x20,
  58     kDetPHOS = 0x40
  59   };
  60
  61   enum EStartTimeType_t {kFILL_T0,kTOF_T0, kT0_T0, kBest_T0};
  62
  63   enum ITSPIDmethod { kITSTruncMean, kITSLikelihood };
  64
  65   enum EDetPidStatus {
  66     kDetNoSignal=0,
  67     kDetPidOk=1,
  68     kDetMismatch=2,
  69     kDetNoParams=3
  70   };
  71
  72   AliITSPIDResponse &GetITSResponse() {return fITSResponse;}
  73   AliTPCPIDResponse &GetTPCResponse() {return fTPCResponse;}
  74   AliTOFPIDResponse &GetTOFResponse() {return fTOFResponse;}
  75   AliTRDPIDResponse &GetTRDResponse() {return fTRDResponse;}
  76   AliEMCALPIDResponse &GetEMCALResponse() {return fEMCALResponse;}
  77
  78   // -----------------------------------------
  79   // buffered getters
  80   //
  81
  82   // Number of sigmas
  83   EDetPidStatus NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type, Double_t &val) const;
  84
  85   Float_t NumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
  86
  87   virtual Float_t NumberOfSigmasITS  (const AliVParticle *track, AliPID::EParticleType type) const;
  88   virtual Float_t NumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type) const;
  89   virtual Float_t NumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type, AliTPCPIDResponse::ETPCdEdxSource dedxSource) const;
  90   virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
  91   virtual Float_t NumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type) const;
  92   virtual Float_t NumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type, const Float_t /*timeZeroTOF*/) const { return NumberOfSigmasTOF(track,type); }
  93   virtual Float_t NumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
  94
  95   Bool_t IdentifiedAsElectronTRD(const AliVTrack *track, Double_t efficiencyLevel,Double_t centrality=-1,AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
  96
  97   // Probabilities
  98   EDetPidStatus ComputePIDProbability  (EDetCode  detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
  99   EDetPidStatus ComputePIDProbability  (EDetector detCode, const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 100
 101   virtual EDetPidStatus ComputeITSProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 102   virtual EDetPidStatus ComputeTPCProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 103   virtual EDetPidStatus ComputeTOFProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 104   virtual EDetPidStatus ComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 105   virtual EDetPidStatus ComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 106   virtual EDetPidStatus ComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 107   virtual EDetPidStatus ComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 108
 109   virtual EDetPidStatus ComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod) const;
 110
 111   // pid status
 112   EDetPidStatus CheckPIDStatus(EDetector detCode, const AliVTrack *track)  const;
 113
 114   void SetITSPIDmethod(ITSPIDmethod pmeth) { fITSPIDmethod = pmeth; }
 115
 116   void SetOADBPath(const char* path) {fOADBPath=path;}
 117   const char *GetOADBPath() const {return fOADBPath.Data();}
 118
 119   void SetCustomTPCpidResponse(const char* tpcpid) { fCustomTPCpidResponse = tpcpid; }
 120   const char* GetCustomTPCpidResponse() const { return fCustomTPCpidResponse.Data(); }
 121
 122   void InitialiseEvent(AliVEvent *event, Int_t pass, Int_t run=-1);
 123   void SetCurrentFile(const char* file) { fCurrentFile=file; }
 124
 125   // cache PID in the track
 126   void SetCachePID(Bool_t cache)    { fCachePID=cache;  }
 127   Bool_t GetCachePID() const { return fCachePID; }
 128   void FillTrackDetectorPID(const AliVTrack *track, EDetector detector) const;
 129   void FillTrackDetectorPID();
 130
 131   AliVEvent * GetCurrentEvent() const {return fCurrentEvent;}
 132
 133   // User settings for the MC period and reco pass
 134   void SetMCperiod(const char *mcPeriod) {fMCperiodUser=mcPeriod;}
 135   void SetRecoPass(Int_t recoPass)       {fRecoPassUser=recoPass;}
 136
 137   // event info
 138   Float_t GetCurrentCentrality() const {return fCurrCentrality;};
 139
 140   // TPC setting
 141   void SetUseTPCEtaCorrection(Bool_t useEtaCorrection = kTRUE) { fUseTPCEtaCorrection = useEtaCorrection; };
 142   Bool_t UseTPCEtaCorrection() const { return fUseTPCEtaCorrection; };
 143
 144   // TOF setting
 145   void SetTOFtail(Float_t tail=1.1){if(tail > 0) fTOFtail=tail; else printf("TOF tail should be greater than 0 (nothing done)\n");};
 146   void SetTOFResponse(AliVEvent *vevent,EStartTimeType_t option);
 147
 148   virtual Float_t GetTPCsignalTunedOnData(const AliVTrack *t) const {return t->GetTPCsignal();};
 149   Bool_t IsTunedOnData() const {return fTuneMConData;};
 150   void SetTunedOnData(Bool_t flag=kTRUE,Int_t recoPass=0){fTuneMConData = flag; if(recoPass>0) fRecoPassUser = recoPass;};
 151
 152   AliPIDResponse(const AliPIDResponse &other);
 153   AliPIDResponse& operator=(const AliPIDResponse &other);
 154
 155
 156 protected:
 157   AliITSPIDResponse fITSResponse;    //PID response function of the ITS
 158   AliTPCPIDResponse fTPCResponse;    //PID response function of the TPC
 159   AliTRDPIDResponse fTRDResponse;    //PID response function of the TRD
 160   AliTOFPIDResponse fTOFResponse;    //PID response function of the TOF
 161   AliEMCALPIDResponse fEMCALResponse;  //PID response function of the EMCAL
 162
 163   Float_t           fRange;          // nSigma max in likelihood
 164   ITSPIDmethod      fITSPIDmethod;   // 0 = trunc mean; 1 = likelihood
 165
 166   //unbuffered PID calculation
 167   virtual Float_t GetNumberOfSigmasTOFold  (const AliVParticle */*track*/, AliPID::EParticleType /*type*/) const {return 0;}
 168   EDetPidStatus GetComputeTRDProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[],AliTRDPIDResponse::ETRDPIDMethod PIDmethod=AliTRDPIDResponse::kLQ1D) const;
 169   EDetPidStatus GetTOFPIDStatus(const AliVTrack *track) const;
 170   Float_t GetTOFMismatchProbability(const AliVTrack *track) const;
 171
 172 private:
 173   Bool_t fIsMC;                        //  If we run on MC data
 174   Bool_t fCachePID;
 175
 176   TString fOADBPath;                   // OADB path to use
 177   TString fCustomTPCpidResponse;       // Custom TPC Pid Response file for debugging purposes
 178
 179   TString fBeamType;                   //! beam type (PP) or (PBPB)
 180   TString fLHCperiod;                  //! LHC period
 181   TString fMCperiodTPC;                //! corresponding MC period to use for the TPC splines
 182   TString fMCperiodUser;               //  MC prodution requested by the user
 183   TString fCurrentFile;                //! name of currently processed file
 184   Int_t   fRecoPass;                   //! reconstruction pass
 185   Int_t   fRecoPassUser;               //  reconstruction pass explicitly set by the user
 186   Int_t   fRun;                        //! current run number
 187   Int_t   fOldRun;                     //! current run number
 188   Float_t fResT0A;                     //! T0A resolution in current run
 189   Float_t fResT0C;                     //! T0C resolution in current run
 190   Float_t fResT0AC;                    //! T0A.and.T0C resolution in current run
 191
 192   TObjArray *fArrPidResponseMaster;    //!  TPC pid splines
 193   TF1       *fResolutionCorrection;    //! TPC resolution correction
 194   AliOADBContainer* fOADBvoltageMaps;  //! container with the voltage maps
 195   Bool_t fUseTPCEtaCorrection;         // Use TPC eta correction
 196
 197   AliTRDPIDResponseObject *fTRDPIDResponseObject; //! TRD PID Response Object
 198
 199   Float_t fTOFtail;                    //! TOF tail effect used in TOF probability
 200   AliTOFPIDParams *fTOFPIDParams;      //! TOF PID Params - period depending (OADB loaded)
 201
 202   TObjArray *fEMCALPIDParams;             //! EMCAL PID Params
 203
 204   AliVEvent *fCurrentEvent;            //! event currently being processed
 205
 206   Float_t fCurrCentrality;             //! current centrality
 207
 208   Bool_t fTuneMConData;                // switch to force the MC to be similar to data (dE/dx)
 209
 210   void ExecNewRun();
 211
 212   //
 213   //setup parametrisations
 214   //
 215
 216   //ITS
 217   void SetITSParametrisation();
 218
 219   //TPC
 220   void SetTPCEtaMaps(Double_t refineFactorMapX = 6.0, Double_t refineFactorMapY = 6.0, Double_t refineFactorSigmaMapX = 6.0,
 221                      Double_t refineFactorSigmaMapY = 6.0);
 222   void SetTPCPidResponseMaster();
 223   void SetTPCParametrisation();
 224   Double_t GetTPCMultiplicityBin(const AliVEvent * const event);
 225
 226   // TPC helpers for the eta maps
 227   void AddPointToHyperplane(TH2D* h, TLinearFitter* linExtrapolation, Int_t binX, Int_t binY);
 228   TH2D* RefineHistoViaLinearInterpolation(TH2D* h, Double_t refineFactorX = 6.0, Double_t refineFactorY = 6.0);
 229
 230   //TRD
 231   void SetTRDPidResponseMaster();
 232   void InitializeTRDResponse();
 233   void SetTRDSlices(UInt_t TRDslicesForPID[2],AliTRDPIDResponse::ETRDPIDMethod method) const;
 234
 235   //TOF
 236   void SetTOFPidResponseMaster();
 237   void InitializeTOFResponse();
 238
 239   //EMCAL
 240   void SetEMCALPidResponseMaster();
 241   void InitializeEMCALResponse();
 242
 243   //
 244   void SetRecoInfo();
 245
 246   //-------------------------------------------------
 247   //unbuffered PID calculation
 248   //
 249
 250   // Number of sigmas
 251   Float_t GetNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
 252   Float_t GetNumberOfSigmasITS  (const AliVParticle *track, AliPID::EParticleType type) const;
 253   Float_t GetNumberOfSigmasTPC  (const AliVParticle *track, AliPID::EParticleType type) const;
 254   Float_t GetNumberOfSigmasTOF  (const AliVParticle *track, AliPID::EParticleType type) const;
 255   Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type, Double_t &eop, Double_t showershape[4]) const;
 256   Float_t GetNumberOfSigmasEMCAL(const AliVParticle *track, AliPID::EParticleType type) const;
 257
 258   Float_t GetBufferedNumberOfSigmas(EDetector detCode, const AliVParticle *track, AliPID::EParticleType type) const;
 259
 260   // Probabilities
 261   EDetPidStatus GetComputePIDProbability  (EDetector detCode,  const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 262   EDetPidStatus GetComputeITSProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 263   EDetPidStatus GetComputeTPCProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 264   EDetPidStatus GetComputeTOFProbability  (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 265   EDetPidStatus GetComputeEMCALProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 266   EDetPidStatus GetComputePHOSProbability (const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 267   EDetPidStatus GetComputeHMPIDProbability(const AliVTrack *track, Int_t nSpecies, Double_t p[]) const;
 268
 269   // pid status
 270   EDetPidStatus GetPIDStatus(EDetector det, const AliVTrack *track) const;
 271   EDetPidStatus GetITSPIDStatus(const AliVTrack *track) const;
 272   EDetPidStatus GetTPCPIDStatus(const AliVTrack *track) const;
 273   EDetPidStatus GetTRDPIDStatus(const AliVTrack *track) const;
 274   EDetPidStatus GetHMPIDPIDStatus(const AliVTrack *track) const;
 275   EDetPidStatus GetPHOSPIDStatus(const AliVTrack *track) const;
 276   EDetPidStatus GetEMCALPIDStatus(const AliVTrack *track) const;
 277
 278   ClassDef(AliPIDResponse, 11);  //PID response handling
 279 };
 280
 281 #endif