[u/mrichter/AliRoot.git] / TPC / AliTPCCorrection.h

#ifndef ALI_TPC_CORRECTION_H
#define ALI_TPC_CORRECTION_H

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

////////////////////////////////////////////////////////////////////////////////
//                                                                            //
// AliTPCCorrection class                                                     //
//                                                                            //
// This class provides a general framework to deal with space point           //
// distortions. An correction class which inherits from here is for example   //
// AliTPCExBBShape or AliTPCExBTwist                                          //
//                                                                            //
// General functions are (for example):                                       //
//   CorrectPoint(x,roc) where x is the vector of inital positions in         //
//   cartesian coordinates and roc represents the Read Out chamber number     //
//   according to the offline naming convention. The vector x is overwritten  //
//   with the corrected coordinates.                                          //
//                                                                            //
// An alternative usage would be CorrectPoint(x,roc,dx), which leaves the     //
//   vector x untouched, put returns the distortions via the vector dx        //
//                                                                            //
// The class allows "effective Omega Tau" corrections to be shifted to the    //
// single distortion classes.                                                 //
//                                                                            //
// Note: This class is normally used via the class AliTPCComposedCorrection   //
//                                                                            //
// date: 27/04/2010                                                           //
// Authors: Magnus Mager, Stefan Rossegger, Jim Thomas                        //
////////////////////////////////////////////////////////////////////////////////


#include <TNamed.h>
#include "TMatrixD.h"
class TH2F;
class TTimeStamp;
class TCollection;
class TTreeSRedirector;
class AliExternalTrackParam;
class TTree;
class THnSparse;
class AliESDVertex;


class AliTPCCorrection : public TNamed {
public:
  enum CompositionType {kParallel,kQueue};

  AliTPCCorrection();
  AliTPCCorrection(const char *name,const char *title);
  virtual ~AliTPCCorrection();
  

  // functions to correct a space point
          void CorrectPoint (      Float_t x[],const Short_t roc);
          void CorrectPoint (const Float_t x[],const Short_t roc,Float_t xp[]);
  virtual void GetCorrection(const Float_t x[],const Short_t roc,Float_t dx[]);

  // functions to distort a space point
          void DistortPoint (      Float_t x[],const Short_t roc);
          void DistortPoint (const Float_t x[],const Short_t roc,Float_t xp[]);
  virtual void GetDistortion(const Float_t x[],const Short_t roc,Float_t dx[]);

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

  // convenience functions
  virtual void Print(Option_t* option="") const;
 
  TH2F* CreateHistoDRinXY   (Float_t z=10.,Int_t nx=100,Int_t ny=100);
  TH2F* CreateHistoDRPhiinXY(Float_t z=10.,Int_t nx=100,Int_t nphi=100);
  TH2F* CreateHistoDRinZR   (Float_t phi=0.,Int_t nZ=100,Int_t nR=100);
  TH2F* CreateHistoDRPhiinZR(Float_t phi=0.,Int_t nZ=100,Int_t nR=100);
  TTree* CreateDistortionTree(Double_t step=5);
  static void  MakeDistortionMap(THnSparse * his0, TTreeSRedirector *pcstream, const char* hname, Int_t run);
  // normally called directly in the correction classes which inherit from this class
  virtual void SetOmegaTauT1T2(Float_t omegaTau,Float_t t1,Float_t t2);
  AliExternalTrackParam * FitDistortedTrack(AliExternalTrackParam & trackIn, Double_t refX, Int_t dir,TTreeSRedirector *pcstream);
  void StoreInOCDB(Int_t startRun, Int_t endRun, const char *comment=0);
  static void MakeTrackDistortionTree(TTree *tinput, Int_t dtype, Int_t ptype, const TObjArray * corrArray, Int_t step=1, Bool_t debug=0);
  static void MakeLaserDistortionTree(TTree* tree, TObjArray *corrArray, Int_t itype);
  void  FastSimDistortedVertex(Double_t orgVertex[3], Int_t nTracks, AliESDVertex &aV, AliESDVertex &avOrg, AliESDVertex &cV, AliESDVertex &cvOrg, TTreeSRedirector * const pcstream);

protected:
  TH2F* CreateTH2F(const char *name,const char *title,
		   const char *xlabel,const char *ylabel,const char *zlabel,
		   Int_t nbinsx,Double_t xlow,Double_t xup,
		   Int_t nbinsy,Double_t ylow,Double_t yup);
 
  static const Double_t fgkTPCZ0;      // nominal gating grid position 
  static const Double_t fgkIFCRadius;   // Mean Radius of the Inner Field Cage ( 82.43 min,  83.70 max) (cm)
  static const Double_t fgkOFCRadius;   // Mean Radius of the Outer Field Cage (252.55 min, 256.45 max) (cm)
  static const Double_t fgkZOffSet;     // Offset from CE: calculate all distortions closer to CE as if at this point
  static const Double_t fgkCathodeV;    // Cathode Voltage (volts)
  static const Double_t fgkGG;          // Gating Grid voltage (volts)

  enum {kNR=   92};              // Number of R points in the table for interpolating distortion data
  enum {kNZ=  270};              // Number of Z points in the table for interpolating distortion data
  static const Double_t fgkRList[kNR]; // points in the radial direction (for the lookup table)
  static const Double_t fgkZList[kNZ]; // points in the z direction (for the lookup table)

  // Simple Interpolation functions: e.g. with tricubic interpolation (not yet in TH3)
  Int_t fJLow;         // variable to help in the interpolation 
  Int_t fKLow;         // variable to help in the interpolation 
  void Interpolate2DEdistortion( const Int_t order, const Double_t r, const Double_t z, 
				 const Double_t er[kNZ][kNR], Double_t &erValue );
  Double_t Interpolate( const Double_t xArray[], const Double_t yArray[], 
			const Int_t order, const Double_t x );
  void Search( const Int_t n, const Double_t xArray[], const Double_t x, Int_t &low );
  virtual Int_t IsPowerOfTwo ( Int_t i ) const  ;
    
  // Algorithms to solve the laplace or possion equation 
  void PoissonRelaxation2D(TMatrixD &arrayV, const TMatrixD &chargeDensity, TMatrixD &arrayErOverEz, const Int_t rows, const Int_t columns, const Int_t iterations );


protected:
  Double_t fT1;         // tensor term of wt - T1
  Double_t fT2;         // tensor term of wt - T2
private:
  ClassDef(AliTPCCorrection,2);
};

#endif
Commit	Line	Data
0116859c	1	#ifndef ALI_TPC_CORRECTION_H
	2	#define ALI_TPC_CORRECTION_H
	3
	4	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	5	* See cxx source for full Copyright notice */
	6
	7	////////////////////////////////////////////////////////////////////////////////
	8	// //
	9	// AliTPCCorrection class //
	10	// //
	11	// This class provides a general framework to deal with space point //
	12	// distortions. An correction class which inherits from here is for example //
	13	// AliTPCExBBShape or AliTPCExBTwist //
	14	// //
	15	// General functions are (for example): //
	16	// CorrectPoint(x,roc) where x is the vector of inital positions in //
	17	// cartesian coordinates and roc represents the Read Out chamber number //
	18	// according to the offline naming convention. The vector x is overwritten //
	19	// with the corrected coordinates. //
	20	// //
	21	// An alternative usage would be CorrectPoint(x,roc,dx), which leaves the //
	22	// vector x untouched, put returns the distortions via the vector dx //
	23	// //
	24	// The class allows "effective Omega Tau" corrections to be shifted to the //
	25	// single distortion classes. //
	26	// //
	27	// Note: This class is normally used via the class AliTPCComposedCorrection //
	28	// //
	29	// date: 27/04/2010 //
	30	// Authors: Magnus Mager, Stefan Rossegger, Jim Thomas //
	31	////////////////////////////////////////////////////////////////////////////////
	32
	33
	34	#include <TNamed.h>
1b923461	35	#include "TMatrixD.h"
0116859c	36	class TH2F;
e527a1b9	37	class TTimeStamp;
0116859c	38	class TCollection;
cf5b0aa0	39	class TTreeSRedirector;
cf5b0aa0	40	class AliExternalTrackParam;
ffab0c37	41	class TTree;
8b63d99c	42	class THnSparse;
ca58ed4e	43	class AliESDVertex;
1b923461	44
1b923461	45
0116859c	46	class AliTPCCorrection : public TNamed {
	47	public:
	48	enum CompositionType {kParallel,kQueue};
	49
	50	AliTPCCorrection();
	51	AliTPCCorrection(const char name,const char title);
	52	virtual ~AliTPCCorrection();
	53
	54
	55	// functions to correct a space point
	56	void CorrectPoint ( Float_t x[],const Short_t roc);
	57	void CorrectPoint (const Float_t x[],const Short_t roc,Float_t xp[]);
	58	virtual void GetCorrection(const Float_t x[],const Short_t roc,Float_t dx[]);
	59
	60	// functions to distort a space point
	61	void DistortPoint ( Float_t x[],const Short_t roc);
	62	void DistortPoint (const Float_t x[],const Short_t roc,Float_t xp[]);
	63	virtual void GetDistortion(const Float_t x[],const Short_t roc,Float_t dx[]);
	64
e527a1b9	65	// initialization and update functions
0116859c	66	virtual void Init();
e527a1b9	67	virtual void Update(const TTimeStamp &timeStamp);
0116859c	68
	69	// convenience functions
	70	virtual void Print(Option_t* option="") const;
	71
	72	TH2F* CreateHistoDRinXY (Float_t z=10.,Int_t nx=100,Int_t ny=100);
	73	TH2F* CreateHistoDRPhiinXY(Float_t z=10.,Int_t nx=100,Int_t nphi=100);
	74	TH2F* CreateHistoDRinZR (Float_t phi=0.,Int_t nZ=100,Int_t nR=100);
	75	TH2F* CreateHistoDRPhiinZR(Float_t phi=0.,Int_t nZ=100,Int_t nR=100);
ffab0c37	76	TTree* CreateDistortionTree(Double_t step=5);
8b63d99c	77	static void MakeDistortionMap(THnSparse * his0, TTreeSRedirector pcstream, const char hname, Int_t run);
0116859c	78	// normally called directly in the correction classes which inherit from this class
0116859c	79	virtual void SetOmegaTauT1T2(Float_t omegaTau,Float_t t1,Float_t t2);
be67055b	80	AliExternalTrackParam * FitDistortedTrack(AliExternalTrackParam & trackIn, Double_t refX, Int_t dir,TTreeSRedirector *pcstream);
ffab0c37	81	void StoreInOCDB(Int_t startRun, Int_t endRun, const char *comment=0);
b1f0a2a5	82	static void MakeTrackDistortionTree(TTree tinput, Int_t dtype, Int_t ptype, const TObjArray corrArray, Int_t step=1, Bool_t debug=0);
7f4cb119	83	static void MakeLaserDistortionTree(TTree* tree, TObjArray *corrArray, Int_t itype);
ca58ed4e	84	void FastSimDistortedVertex(Double_t orgVertex[3], Int_t nTracks, AliESDVertex &aV, AliESDVertex &avOrg, AliESDVertex &cV, AliESDVertex &cvOrg, TTreeSRedirector * const pcstream);
ca58ed4e	85
0116859c	86	protected:
	87	TH2F* CreateTH2F(const char name,const char title,
	88	const char xlabel,const char ylabel,const char *zlabel,
	89	Int_t nbinsx,Double_t xlow,Double_t xup,
	90	Int_t nbinsy,Double_t ylow,Double_t yup);
	91
b1f0a2a5	92	static const Double_t fgkTPCZ0; // nominal gating grid position
0116859c	93	static const Double_t fgkIFCRadius; // Mean Radius of the Inner Field Cage ( 82.43 min, 83.70 max) (cm)
	94	static const Double_t fgkOFCRadius; // Mean Radius of the Outer Field Cage (252.55 min, 256.45 max) (cm)
	95	static const Double_t fgkZOffSet; // Offset from CE: calculate all distortions closer to CE as if at this point
	96	static const Double_t fgkCathodeV; // Cathode Voltage (volts)
	97	static const Double_t fgkGG; // Gating Grid voltage (volts)
	98
	99	enum {kNR= 92}; // Number of R points in the table for interpolating distortion data
	100	enum {kNZ= 270}; // Number of Z points in the table for interpolating distortion data
b1f0a2a5	101	static const Double_t fgkRList[kNR]; // points in the radial direction (for the lookup table)
b1f0a2a5	102	static const Double_t fgkZList[kNZ]; // points in the z direction (for the lookup table)
0116859c	103
0116859c	104	// Simple Interpolation functions: e.g. with tricubic interpolation (not yet in TH3)
b1f0a2a5	105	Int_t fJLow; // variable to help in the interpolation
b1f0a2a5	106	Int_t fKLow; // variable to help in the interpolation
0116859c	107	void Interpolate2DEdistortion( const Int_t order, const Double_t r, const Double_t z,
b1f0a2a5	108	const Double_t er[kNZ][kNR], Double_t &erValue );
0116859c	109	Double_t Interpolate( const Double_t xArray[], const Double_t yArray[],
	110	const Int_t order, const Double_t x );
	111	void Search( const Int_t n, const Double_t xArray[], const Double_t x, Int_t &low );
710bda39	112	virtual Int_t IsPowerOfTwo ( Int_t i ) const ;
1b923461	113
	114	// Algorithms to solve the laplace or possion equation
	115	void PoissonRelaxation2D(TMatrixD &arrayV, const TMatrixD &chargeDensity, TMatrixD &arrayErOverEz, const Int_t rows, const Int_t columns, const Int_t iterations );
	116
	117
534fd34a	118	protected:
	119	Double_t fT1; // tensor term of wt - T1
	120	Double_t fT2; // tensor term of wt - T2
7f4cb119	121	private:
534fd34a	122	ClassDef(AliTPCCorrection,2);
0116859c	123	};
	124
	125	#endif