Merge branch 'TPCdev' of https://git.cern.ch/reps/AliRoot into TPCdev

[u/mrichter/AliRoot.git] / TPC / Base / AliTPCSpaceCharge3D.h

#ifndef ALITPCSPACECHARGE3D_H
#define ALITPCSPACECHARGE3D_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

////////////////////////////////////////////////////////////////////////////
// AliTPCSpaceCharge3D class                                              //
// Authors: Stefan Rossegger                                              //
////////////////////////////////////////////////////////////////////////////

#include "AliTPCCorrection.h"
class TH3F;
class TH3;

class AliTPCSpaceCharge3D : public AliTPCCorrection {
public:
  AliTPCSpaceCharge3D();
  virtual ~AliTPCSpaceCharge3D();

  // initialization and update functions
  virtual void Init();
  virtual void Update(const TTimeStamp &timeStamp);

  // common setters and getters for tangled ExB effect
  virtual void SetOmegaTauT1T2(Float_t omegaTau,Float_t t1,Float_t t2) {
    fT1=t1; fT2=t2;
    const Double_t wt0=t2*omegaTau;     fC0=1./(1.+wt0*wt0);
    const Double_t wt1=t1*omegaTau;     fC1=wt1/(1.+wt1*wt1);
  };
  void SetC0C1(Float_t c0,Float_t c1) {fC0=c0;fC1=c1;} // CAUTION: USE WITH CARE
  Float_t GetC0() const {return fC0;}
  Float_t GetC1() const {return fC1;}

  // setters and getters
  void SetCorrectionFactor(Float_t correctionFactor) {fCorrectionFactor=correctionFactor;}
  Float_t GetCorrectionFactor() const {return fCorrectionFactor;}

  void  SetSCDataFileName(TString fname);
  const char* GetSCDataFileName() { return fSCDataFileName.Data(); }

  void InitSpaceCharge3DDistortion();       // faster model and more accurate ;-)
  void InitSpaceCharge3DDistortionCourse(); // real 3D but not accurate enough
  void ForceInitSpaceCharge3DDistortion() { fInitLookUp=kFALSE; InitSpaceCharge3DDistortion(); }

  void  InitSpaceCharge3DPoisson(Int_t kRows, Int_t kColumns, Int_t kPhiSlices, Int_t kIterations);
  void ForceInitSpaceCharge3DPoisson(Int_t kRows, Int_t kColumns, Int_t kPhiSlices, Int_t kIterations) { fInitLookUp=kFALSE; InitSpaceCharge3DPoisson(kRows,kColumns,kPhiSlices,kIterations); }
  Float_t GetSpaceChargeDensity(Float_t r, Float_t phi, Float_t z, Int_t mode);
  TH2F* CreateHistoSCinXY(Float_t z, Int_t nx=100, Int_t ny=100, Int_t mode=0);
  TH2F* CreateHistoSCinZR(Float_t phi, Int_t nz=100, Int_t nr=100, Int_t mode=0);


  void WriteChargeDistributionToFile(const char* fname = "SC-Alice.root");

  virtual void Print(const Option_t* option="") const;
  // MI - Add the "real" 3D histogram as an optional input (26.06.2013)
  //
  void    SetInputSpaceCharge(TH3 * hisSpaceCharge3D, TH2 * hisRPhi, TH2* hisRZ, Double_t norm);
  void    SetInputSpaceCharge3D(TH3 * hisSpaceCharge3D){fSpaceChargeHistogram3D= hisSpaceCharge3D;}

  const TH3 *   GetInputSpaceCharge3D(){return fSpaceChargeHistogram3D;}       // MI add 
  const TH2 *   GetInputSpaceChargeRPhi(){return fSpaceChargeHistogramRPhi;}       // MI add 
  const TH2 *   GetInputSpaceChargeRZ(){return fSpaceChargeHistogramRZ;}       // MI add 

  virtual void GetCorrection(const Float_t x[],const Short_t roc,Float_t dx[]);

  static AliTPCSpaceCharge3D *MakeCorrection22D(const char * filename = "SpaceChargeMap.root", Double_t multiplicity = 950., Double_t intRate = 5e4, Double_t epsIROC = 10., Double_t epsOROC=10,
						Double_t gasfactor = 1., 
						Double_t radialScaling = 1.5);
private:

  // maximum sizes of lookup tables
  enum {kNRows= 90 };       // the maximum on row-slices so far ~ 2cm slicing    
  enum {kNPhiSlices= 144 }; // the maximum of phi-slices so far = (8 per sector) 
  enum {kNColumns= 130 };   // the maximum on column-slices so  ~ 2cm slicing    

  AliTPCSpaceCharge3D(const AliTPCSpaceCharge3D &);               // not implemented
  AliTPCSpaceCharge3D &operator=(const AliTPCSpaceCharge3D &);    // not implemented

  Float_t fC0; // coefficient C0                 (compare Jim Thomas's notes for definitions)
  Float_t fC1; // coefficient C1                 (compare Jim Thomas's notes for definitions)
  Float_t fCorrectionFactor;       // Space Charge Correction factor in comparison to initialized
                                   // look up table which was created for M_mb = 900 and IR = 3000
                                   // compare Internal Note Nr: ???

  Bool_t fInitLookUp;                 // flag to check if the Look Up table was created

  TMatrixF *fLookUpErOverEz[kNPhi];   // Array to store electric field integral (int Er/Ez)
  TMatrixF *fLookUpEphiOverEz[kNPhi]; // Array to store electric field integral (int Er/Ez)
  TMatrixF *fLookUpDeltaEz[kNPhi];    // Array to store electric field integral (int Er/Ez)

  TString fSCDataFileName;          // file which contains the space charge distribution
  TString fSCLookUpPOCsFileName3D;  // filename of the precalculated lookup tables (for individual voxels)
  TString fSCLookUpPOCsFileNameRZ;  // filename of the precalculated lookup tables (for individual voxels)
  TString fSCLookUpPOCsFileNameRPhi;  // filename of the precalculated lookup tables (for individual voxels)


  TMatrixF *fSCdensityDistribution[kNPhi]; // 3D space charge distribution
  TMatrixD *fSCdensityInRZ;       // (r,z) space charge distribution
  TMatrixD *fSCdensityInRPhiA;     // (r,phi) space charge distribution
  TMatrixD *fSCdensityInRPhiC;     // (r,phi) space charge distribution
  TH3 *    fSpaceChargeHistogram3D;      // Histogram with the input space charge histogram - used as an optional input 
  TH2 *    fSpaceChargeHistogramRPhi;      // Histogram with the input space charge histogram - used as an optional input 
  TH2 *    fSpaceChargeHistogramRZ;      // Histogram with the input space charge histogram - used as an optional input 
  ClassDef(AliTPCSpaceCharge3D,2); 
};

#endif