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