14-jun-2001 NvE Memberfunction GetRapidity() introduced for AliTrack and AliJet
[u/mrichter/AliRoot.git] / RALICE / Ali3Vector.cxx
index 403f252ab545c7dda2a60136ca6bfe4d57e329bf..a4cbdcb0160ffd8f4cd57b886b027c118f73c35d 100644 (file)
@@ -1,3 +1,81 @@
+/**************************************************************************
+ * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ *                                                                        *
+ * Author: The ALICE Off-line Project.                                    *
+ * Contributors are mentioned in the code where appropriate.              *
+ *                                                                        *
+ * Permission to use, copy, modify and distribute this software and its   *
+ * documentation strictly for non-commercial purposes is hereby granted   *
+ * without fee, provided that the above copyright notice appears in all   *
+ * copies and that both the copyright notice and this permission notice   *
+ * appear in the supporting documentation. The authors make no claims     *
+ * about the suitability of this software for any purpose. It is          *
+ * provided "as is" without express or implied warranty.                  *
+ **************************************************************************/
+
+// $Id$
+
+///////////////////////////////////////////////////////////////////////////
+// Class Ali3Vector
+// Handling of 3-vectors in various reference frames.
+//
+// This class is meant to serve as a base class for ALICE objects
+// that have 3-dimensional vector characteristics.
+// Error propagation is performed automatically. 
+//
+// Note :
+// ------
+// Vectors (v), Errors (e) and reference frames (f) are specified via
+// SetVector(Float_t* v,TString f)
+// SetErrors(Float_t* e,TString f)
+// under the following conventions :
+//
+// f="car" ==> v in Cartesian coordinates   (x,y,z)
+// f="sph" ==> v in Spherical coordinates   (r,theta,phi)
+// f="cyl" ==> v in Cylindrical coordinates (rho,phi,z)
+//
+// All angles are in radians.
+//
+// Example :
+// ---------
+//
+// Ali3Vector a;
+// Float_t v[3]={-1,25,7};
+// Float_t e[3]={0.03,0.5,0.21};
+// a.SetVector(v,"car");
+// a.SetErrors(e,"car");
+// a.Info();
+//
+// Float_t vec[3];
+// Float_t err[3];
+// a.GetVector(vec,"sph");
+// a.GetErrors(vec,"sph");
+//
+// Ali3Vector b;
+// Float_t v2[3]={6,-18,33};
+// Float_t e2[3]={0.19,0.45,0.93};
+// b.SetVector(v2,"car");
+// b.SetErrors(e2,"car");
+//
+// Float_t dotpro=a.Dot(b);
+// Float_t doterror=a.GetResultError();
+//
+// Ali3Vector c=a.Cross(b);
+// c.Info("sph");
+// c.GetVector(vec,"cyl");
+// c.GetErrors(err,"cyl");
+//
+// Float_t norm=c.GetNorm();
+// Float_t normerror=c.GetResultError();
+//
+// c=a+b;
+// c=a-b;
+// c=a*5;
+//
+//--- Author: Nick van Eijndhoven 30-mar-1999 UU-SAP Utrecht
+//- Modified: NvE $Date$ UU-SAP Utrecht
+///////////////////////////////////////////////////////////////////////////
+
 #include "Ali3Vector.h"
  
 ClassImp(Ali3Vector) // Class implementation to enable ROOT I/O
@@ -5,9 +83,14 @@ ClassImp(Ali3Vector) // Class implementation to enable ROOT I/O
 Ali3Vector::Ali3Vector()
 {
 // Creation of an Ali3Vector object and initialisation of parameters
+// All attributes initialised to 0
  fV=0;
  fTheta=0;
  fPhi=0;
+ fDx=0;
+ fDy=0;
+ fDz=0;
+ fDresult=0;
 }
 ///////////////////////////////////////////////////////////////////////////
 Ali3Vector::~Ali3Vector()
@@ -18,7 +101,14 @@ Ali3Vector::~Ali3Vector()
 void Ali3Vector::SetVector(Double_t* v,TString f)
 {
 // Store vector according to reference frame f
+// All errors will be reset to 0
+ fDx=0;
+ fDy=0;
+ fDz=0;
+ fDresult=0;
+
  Double_t pi=acos(-1.);
+
  Int_t frame=0;
  if (f == "car") frame=1;
  if (f == "sph") frame=2;
@@ -125,6 +215,7 @@ void Ali3Vector::GetVector(Double_t* v,TString f)
 void Ali3Vector::SetVector(Float_t* v,TString f)
 {
 // Store vector according to reference frame f
+// All errors will be reset to 0
  Double_t vec[3];
  for (Int_t i=0; i<3; i++)
  {
@@ -144,15 +235,191 @@ void Ali3Vector::GetVector(Float_t* v,TString f)
  }
 }
 ///////////////////////////////////////////////////////////////////////////
+void Ali3Vector::SetErrors(Double_t* e,TString f)
+{
+// Store errors according to reference frame f
+// The error on scalar results is reset to 0
+ fDresult=0;
+
+ Int_t frame=0;
+ if (f == "car") frame=1;
+ if (f == "sph") frame=2;
+ if (f == "cyl") frame=3;
+
+ Double_t dx2,dy2,dz2,rho;
+
+ switch (frame)
+ {
+  case 1: // Cartesian coordinates
+   fDx=fabs(e[0]);
+   fDy=fabs(e[1]);
+   fDz=fabs(e[2]);
+   break;
+
+  case 2: // Spherical coordinates
+   dx2=pow((cos(fPhi)*sin(fTheta)*e[0]),2)+pow((fV*cos(fTheta)*cos(fPhi)*e[1]),2)
+       +pow((fV*sin(fTheta)*sin(fPhi)*e[2]),2);
+   dy2=pow((sin(fPhi)*sin(fTheta)*e[0]),2)+pow((fV*cos(fTheta)*sin(fPhi)*e[1]),2)
+       +pow((fV*sin(fTheta)*cos(fPhi)*e[2]),2);
+   dz2=pow((cos(fTheta)*e[0]),2)+pow((fV*sin(fTheta)*e[1]),2);
+   fDx=sqrt(dx2);
+   fDy=sqrt(dy2);
+   fDz=sqrt(dz2);
+   break;
+
+  case 3: // Cylindrical coordinates
+   rho=fV*sin(fTheta);
+   dx2=pow((cos(fPhi)*e[0]),2)+pow((rho*sin(fPhi)*e[1]),2);
+   dy2=pow((sin(fPhi)*e[0]),2)+pow((rho*cos(fPhi)*e[1]),2);
+   fDx=sqrt(dx2);
+   fDy=sqrt(dy2);
+   fDz=fabs(e[2]);
+   break;
+
+  default: // Unsupported reference frame
+   cout << "*Ali3Vector::SetErrors* Unsupported frame : " << f << endl
+        << " Possible frames are 'car', 'sph' and 'cyl'." << endl; 
+   fDx=0;
+   fDy=0;
+   fDz=0;
+   break;
+ }
+}
+///////////////////////////////////////////////////////////////////////////
+void Ali3Vector::GetErrors(Double_t* e,TString f)
+{
+// Provide errors according to reference frame f
+ Int_t frame=0;
+ if (f == "car") frame=1;
+ if (f == "sph") frame=2;
+ if (f == "cyl") frame=3;
+
+ Double_t pi=acos(-1.);
+
+ Double_t dr2,dtheta2,dphi2,rho,drho2;
+ Double_t v[3]; 
+ Double_t rxy2; // Shorthand for (x*x+y*y)
+
+ switch (frame)
+ {
+  case 1: // Cartesian coordinates
+   e[0]=fDx;
+   e[1]=fDy;
+   e[2]=fDz;
+   break;
+
+  case 2: // Spherical coordinates
+   GetVector(v,"car");
+   rxy2=pow(v[0],2)+pow(v[1],2);
+   if (sqrt(rxy2)<(fV*1e-10)) rxy2=0;
+   if (fV) 
+   {
+    dr2=(pow((v[0]*fDx),2)+pow((v[1]*fDy),2)+pow((v[2]*fDz),2))/(fV*fV);
+   }
+   else
+   {
+    dr2=0;
+   }
+   if (fV)
+   {
+    dtheta2=rxy2*pow(fDz,2)/pow(fV,4);
+    if (v[2] && rxy2)
+    {
+     dtheta2+=rxy2*pow(v[2],2)*(pow((v[0]*fDx),2)+pow((v[1]*fDy),2)) /
+              pow(((pow(v[3],2)*rxy2)+pow(rxy2,2)),2);
+    }
+   }
+   else
+   {
+    dtheta2=0;
+   }
+   if (rxy2)
+   {
+    dphi2=(pow((v[1]*fDx),2)+pow((v[0]*fDy),2))/(pow(rxy2,2));
+   }
+   else
+   {
+    dphi2=0;
+   }
+   e[0]=sqrt(dr2);
+   e[1]=sqrt(dtheta2);
+   if (e[1]>pi) e[1]=pi;
+   e[2]=sqrt(dphi2);
+   if (e[2]>(2.*pi)) e[2]=2.*pi;
+   break;
+
+  case 3: // Cylindrical coordinates
+   GetVector(v,"car");
+   rho=fabs(fV*sin(fTheta));
+   if (rho<(fV*1e-10)) rho=0;
+   if (rho) 
+   {
+    drho2=(pow((v[0]*fDx),2)+pow((v[1]*fDy),2))/(rho*rho);
+   }
+   else
+   {
+    drho2=0;
+   }
+   if (rho)
+   {
+    dphi2=(pow((v[1]*fDx),2)+pow((v[0]*fDy),2))/(pow(rho,4));
+   }
+   else
+   {
+    dphi2=0;
+   }
+   e[0]=sqrt(drho2);
+   e[1]=sqrt(dphi2);
+   if (e[1]>(2.*pi)) e[1]=2.*pi;
+   e[2]=fDz;
+   break;
+
+  default: // Unsupported reference frame
+   cout << "*Ali3Vector::GetErrors* Unsupported frame : " << f << endl
+        << " Possible frames are 'car', 'sph' and 'cyl'." << endl; 
+   for (Int_t i=0; i<3; i++)
+   {
+    e[i]=0;
+   }
+   break;
+ }
+}
+///////////////////////////////////////////////////////////////////////////
+void Ali3Vector::SetErrors(Float_t* e,TString f)
+{
+// Store errors according to reference frame f
+// The error on scalar results is reset to 0
+ Double_t vec[3];
+ for (Int_t i=0; i<3; i++)
+ {
+  vec[i]=e[i];
+ }
+ SetErrors(vec,f);
+}
+///////////////////////////////////////////////////////////////////////////
+void Ali3Vector::GetErrors(Float_t* e,TString f)
+{
+// Provide errors according to reference frame f
+ Double_t vec[3];
+ GetErrors(vec,f);
+ for (Int_t i=0; i<3; i++)
+ {
+  e[i]=vec[i];
+ }
+}
+///////////////////////////////////////////////////////////////////////////
 void Ali3Vector::Info(TString f)
 {
 // Print vector components according to reference frame f
  if (f=="car" || f=="sph" || f=="cyl")
  {
-  Double_t vec[3];
+  Double_t vec[3],err[3];
   GetVector(vec,f);
+  GetErrors(err,f);
   cout << " Vector in " << f << " coordinates : "
        << vec[0] << " " << vec[1] << " " << vec[2] << endl; 
+  cout << "   Err. in " << f << " coordinates : "
+       << err[0] << " " << err[1] << " " << err[2] << endl; 
  }
  else
  {
@@ -163,39 +430,108 @@ void Ali3Vector::Info(TString f)
 ///////////////////////////////////////////////////////////////////////////
 Double_t Ali3Vector::GetNorm()
 {
+// Provide the norm of the current vector
+// The error on the scalar result (norm) is updated accordingly
+ Double_t e[3];
+ GetErrors(e,"sph");
+ fDresult=e[0]; 
  return fV;
 }
 ///////////////////////////////////////////////////////////////////////////
+Double_t Ali3Vector::GetPseudoRapidity()
+{
+// Provide the pseudo-rapidity w.r.t. the z-axis.
+// In other words : eta=-log(tan(theta/2))
+// The error on the scalar result (pseudo-rap.) is updated accordingly
+ Double_t pi=acos(-1.);
+ Double_t v[3];
+ GetVector(v,"sph");
+ Double_t thetahalf=v[1]/2.;
+ Double_t arg=0;
+ if (v[1]<pi) arg=tan(thetahalf);
+ Double_t eta=9999;
+ if (arg>0) eta=-log(arg);
+ Double_t e[3];
+ GetErrors(e,"sph");
+ Double_t prod=cos(thetahalf)*sin(thetahalf);
+ fDresult=0;
+ if (prod) fDresult=fabs(e[1]/2.*prod);
+ return eta;
+}
+///////////////////////////////////////////////////////////////////////////
 Double_t Ali3Vector::Dot(Ali3Vector& q)
 {
 // Provide the dot product of the current vector with vector q
- Double_t a[3],b[3];
+// The error on the scalar result (dotproduct) is updated accordingly
+
  Double_t dotpro=0;
 
- GetVector(a,"car");
- q.GetVector(b,"car");
- for (Int_t i=0; i<3; i++)
+ if ((this) == &q) // Check for special case v.Dot(v)
  {
-  dotpro+=a[i]*b[i];
+  Double_t norm=GetNorm();
+  Double_t dnorm=GetResultError();
+  dotpro=pow(norm,2);
+  fDresult=2.*norm*dnorm;
  }
+ else
+ {
+  Double_t a[3],b[3];
+  Double_t ea[3],eb[3];
+  Double_t d2=0;
+
+  GetVector(a,"car");
+  GetErrors(ea,"car");
+  q.GetVector(b,"car");
+  q.GetErrors(eb,"car");
+  for (Int_t i=0; i<3; i++)
+  {
+   dotpro+=a[i]*b[i];
+   d2+=pow(b[i]*ea[i],2)+pow(a[i]*eb[i],2);
+  }
+  fDresult=sqrt(d2);
+ }
+
  return dotpro;
 }
 ///////////////////////////////////////////////////////////////////////////
+Double_t Ali3Vector::GetResultError()
+{
+// Provide the error on the result of an operation yielding a scalar
+// E.g. GetNorm() or Dot()
+ return fDresult;
+}
+///////////////////////////////////////////////////////////////////////////
 Ali3Vector Ali3Vector::Cross(Ali3Vector& q)
 {
 // Provide the cross product of the current vector with vector q
+// Error propagation is performed automatically
  Double_t a[3],b[3],c[3];
+ Double_t ea[3],eb[3],ec[3],d2;
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
  q.GetVector(b,"car");
+ q.GetErrors(eb,"car");
 
  c[0]=a[1]*b[2]-a[2]*b[1];
  c[1]=a[2]*b[0]-a[0]*b[2];
  c[2]=a[0]*b[1]-a[1]*b[0];
 
+ d2=pow(b[2]*ea[1],2)+pow(a[1]*eb[2],2)
+   +pow(b[1]*ea[2],2)+pow(a[2]*eb[1],2);
+ ec[0]=sqrt(d2);
+
+ d2=pow(b[0]*ea[2],2)+pow(a[2]*eb[0],2)
+   +pow(b[2]*ea[0],2)+pow(a[0]*eb[2],2);
+ ec[1]=sqrt(d2);
+
+ d2=pow(b[1]*ea[0],2)+pow(a[0]*eb[1],2)
+   +pow(b[0]*ea[1],2)+pow(a[1]*eb[0],2);
+ ec[2]=sqrt(d2);
+
  Ali3Vector v;
  v.SetVector(c,"car");
+ v.SetErrors(ec,"car");
   
  return v;
 }
@@ -203,18 +539,23 @@ Ali3Vector Ali3Vector::Cross(Ali3Vector& q)
 Ali3Vector Ali3Vector::operator+(Ali3Vector& q)
 {
 // Add vector q to the current vector
- Double_t a[3],b[3];
+// Error propagation is performed automatically
+ Double_t a[3],b[3],ea[3],eb[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
  q.GetVector(b,"car");
+ q.GetErrors(eb,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]+=b[i];
+  ea[i]=sqrt(pow(ea[i],2)+pow(eb[i],2));
  }
 
  Ali3Vector v;
  v.SetVector(a,"car");
+ v.SetErrors(ea,"car");
   
  return v;
 }
@@ -222,36 +563,45 @@ Ali3Vector Ali3Vector::operator+(Ali3Vector& q)
 Ali3Vector Ali3Vector::operator-(Ali3Vector& q)
 {
 // Subtract vector q from the current vector
- Double_t a[3],b[3];
+// Error propagation is performed automatically
+ Double_t a[3],b[3],ea[3],eb[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
  q.GetVector(b,"car");
+ q.GetErrors(eb,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]-=b[i];
+  ea[i]=sqrt(pow(ea[i],2)+pow(eb[i],2));
  }
 
  Ali3Vector v;
  v.SetVector(a,"car");
+ v.SetErrors(ea,"car");
   
  return v;
 }
 ///////////////////////////////////////////////////////////////////////////
 Ali3Vector Ali3Vector::operator*(Double_t s)
 {
-// Multiply the current vector with a scalar s
- Double_t a[3];
+// Multiply the current vector with a scalar s.
+// Error propagation is performed automatically.
+ Double_t a[3],ea[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]*=s;
+  ea[i]*=s;
  }
 
  Ali3Vector v;
  v.SetVector(a,"car");
+ v.SetErrors(ea,"car");
   
  return v;
 }
@@ -259,6 +609,7 @@ Ali3Vector Ali3Vector::operator*(Double_t s)
 Ali3Vector Ali3Vector::operator/(Double_t s)
 {
 // Divide the current vector by a scalar s
+// Error propagation is performed automatically
 
  if (fabs(s)<1.e-20) // Protect against division by 0
  {
@@ -267,17 +618,20 @@ Ali3Vector Ali3Vector::operator/(Double_t s)
  }
  else
  {
-  Double_t a[3];
+  Double_t a[3],ea[3];
 
   GetVector(a,"car");
+  GetErrors(ea,"car");
 
   for (Int_t i=0; i<3; i++)
   {
    a[i]/=s;
+   ea[i]/=s;
   }
 
   Ali3Vector v;
   v.SetVector(a,"car");
+  v.SetErrors(ea,"car");
   
   return v;
  }
@@ -286,17 +640,22 @@ Ali3Vector Ali3Vector::operator/(Double_t s)
 Ali3Vector& Ali3Vector::operator+=(Ali3Vector& q)
 {
 // Add vector q to the current vector
- Double_t a[3],b[3];
+// Error propagation is performed automatically
+ Double_t a[3],b[3],ea[3],eb[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
  q.GetVector(b,"car");
+ q.GetErrors(eb,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]+=b[i];
+  ea[i]=sqrt(pow(ea[i],2)+pow(eb[i],2));
  }
 
  SetVector(a,"car");
+ SetErrors(ea,"car");
   
  return *this;
 }
@@ -304,17 +663,22 @@ Ali3Vector& Ali3Vector::operator+=(Ali3Vector& q)
 Ali3Vector& Ali3Vector::operator-=(Ali3Vector& q)
 {
 // Subtract vector q from the current vector
- Double_t a[3],b[3];
+// Error propagation is performed automatically
+ Double_t a[3],b[3],ea[3],eb[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
  q.GetVector(b,"car");
+ q.GetErrors(eb,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]-=b[i];
+  ea[i]=sqrt(pow(ea[i],2)+pow(eb[i],2));
  }
 
  SetVector(a,"car");
+ SetErrors(ea,"car");
   
  return *this;
 }
@@ -322,16 +686,20 @@ Ali3Vector& Ali3Vector::operator-=(Ali3Vector& q)
 Ali3Vector& Ali3Vector::operator*=(Double_t s)
 {
 // Multiply the current vector with a scalar s
- Double_t a[3];
+// Error propagation is performed automatically
+ Double_t a[3],ea[3];
 
  GetVector(a,"car");
+ GetErrors(ea,"car");
 
  for (Int_t i=0; i<3; i++)
  {
   a[i]*=s;
+  ea[i]*=s;
  }
 
  SetVector(a,"car");
+ SetErrors(ea,"car");
   
  return *this;
 }
@@ -339,6 +707,7 @@ Ali3Vector& Ali3Vector::operator*=(Double_t s)
 Ali3Vector& Ali3Vector::operator/=(Double_t s)
 {
 // Divide the current vector by a scalar s
+// Error propagation is performed automatically
 
  if (fabs(s)<1.e-20) // Protect against division by 0
  {
@@ -347,18 +716,78 @@ Ali3Vector& Ali3Vector::operator/=(Double_t s)
  }
  else
  {
-  Double_t a[3];
+  Double_t a[3],ea[3];
 
   GetVector(a,"car");
+  GetErrors(ea,"car");
 
   for (Int_t i=0; i<3; i++)
   {
    a[i]/=s;
+   ea[i]/=s;
   }
 
   SetVector(a,"car");
+  SetErrors(ea,"car");
   
   return *this;
  }
 }
 ///////////////////////////////////////////////////////////////////////////
+Ali3Vector Ali3Vector::GetVecTrans()
+{
+// Provide the transverse vector w.r.t. z-axis.
+// Error propagation is performed automatically
+ Double_t pi=acos(-1.);
+ Double_t a[3],ea[3];
+
+ GetVector(a,"sph");
+ GetErrors(ea,"sph");
+
+ Double_t vt,dvt2;
+ vt=a[0]*sin(a[1]);
+ dvt2=pow((sin(a[1])*ea[0]),2)+pow((a[0]*cos(a[1])*ea[1]),2);
+
+ a[0]=fabs(vt);
+ a[1]=pi/2.;
+
+ ea[0]=sqrt(dvt2);
+ ea[1]=0;
+
+ Ali3Vector v;
+ v.SetVector(a,"sph");
+ v.SetErrors(ea,"sph");
+  
+ return v;
+}
+///////////////////////////////////////////////////////////////////////////
+Ali3Vector Ali3Vector::GetVecLong()
+{
+// Provide the longitudinal vector w.r.t. z-axis.
+// Error propagation is performed automatically
+ Double_t pi=acos(-1.);
+ Double_t a[3],ea[3];
+
+ GetVector(a,"sph");
+ GetErrors(ea,"sph");
+
+ Double_t vl,dvl2;
+ vl=a[0]*cos(a[1]);
+ dvl2=pow((cos(a[1])*ea[0]),2)+pow((a[0]*sin(a[1])*ea[1]),2);
+
+ a[0]=fabs(vl);
+ a[1]=0;
+ if (vl<0) a[1]=pi;
+ a[2]=0;
+
+ ea[0]=sqrt(dvl2);
+ ea[1]=0;
+ ea[2]=0;
+
+ Ali3Vector v;
+ v.SetVector(a,"sph");
+ v.SetErrors(ea,"sph");
+  
+ return v;
+}
+///////////////////////////////////////////////////////////////////////////