Detector plane. More...

#include <DetPlane.h>

Inheritance diagram for genfit::DetPlane:

Collaboration diagram for genfit::DetPlane:

[legend]

Public Member Functions
	DetPlane (AbsFinitePlane *finite=NULL)

	DetPlane (const TVector3 &o, const TVector3 &u, const TVector3 &v, AbsFinitePlane *finite=NULL)

	DetPlane (const TVector3 &o, const TVector3 &n, AbsFinitePlane *finite=NULL)

virtual	~DetPlane ()

	DetPlane (const DetPlane &)

DetPlane &	operator= (DetPlane)

void	swap (DetPlane &other)

const TVector3 &	getO () const

const TVector3 &	getU () const

const TVector3 &	getV () const

void	set (const TVector3 &o, const TVector3 &u, const TVector3 &v)

void	setO (const TVector3 &o)

void	setO (double, double, double)

void	setU (const TVector3 &u)

void	setU (double, double, double)

void	setV (const TVector3 &v)

void	setV (double, double, double)

void	setUV (const TVector3 &u, const TVector3 &v)

void	setON (const TVector3 &o, const TVector3 &n)

void	setFinitePlane (AbsFinitePlane *finite)

TVector3	getNormal () const

void	setNormal (const TVector3 &n)

void	setNormal (double, double, double)

void	setNormal (const double &theta, const double &phi)

TVector2	project (const TVector3 &x) const
	projecting a direction onto the plane:

TVector2	LabToPlane (const TVector3 &x) const
	transform from Lab system into plane

TVector3	toLab (const TVector2 &x) const
	transform from plane coordinates to lab system

TVector3	dist (const TVector3 &point) const

TVector2	straightLineToPlane (const TVector3 &point, const TVector3 &dir) const
	gives u,v coordinates of the intersection point of a straight line with plane

void	straightLineToPlane (const double &posX, const double &posY, const double &posZ, const double &dirX, const double &dirY, const double &dirZ, double &u, double &v) const
	gives u,v coordinates of the intersection point of a straight line with plane

void	Print (const Option_t *="") const

double	distance (const TVector3 &point) const
	absolute distance from a point to the plane

double	distance (double, double, double) const

bool	isInActive (const TVector3 &point, const TVector3 &dir) const
	intersect in the active area? C.f. AbsFinitePlane

bool	isInActive (const double &posX, const double &posY, const double &posZ, const double &dirX, const double &dirY, const double &dirZ) const
	intersect in the active area? C.f. AbsFinitePlane

bool	isInActive (double u, double v) const
	isInActive methods refer to finite plane. C.f. AbsFinitePlane

bool	isInActive (const TVector2 &v) const
	isInActive methods refer to finite plane. C.f. AbsFinitePlane

bool	isFinite () const

void	rotate (double angle)
	rotate u and v around normal. Angle is in rad. More for debugging than for actual use.

void	reset ()
	delete finitePlane_ and set O, U, V to default values

Private Member Functions
void	sane ()
	ensures orthonormal coordinates

Private Attributes
TVector3	o_

TVector3	u_

TVector3	v_

boost::scoped_ptr< AbsFinitePlane >	finitePlane_

Friends
bool	operator== (const DetPlane &lhs, const DetPlane &rhs)
	Checks equality of planes by comparing the 9 double values that define them.

bool	operator!= (const DetPlane &lhs, const DetPlane &rhs)
	returns NOT ==

Detailed Description

Detector plane.

A detector plane is the principle object to define coordinate systems for track fitting in genfit. Since a particle trajectory is a one-dimensional object (regardless of any specific parameterization) positions with respect to the track are always measured in a plane.

Which plane is chosen depends on the type of detector. Fixed plane detectors have their detector plane defined by their mechanical setup. While wire chambers or time projection chambers might want to define a detector plane more flexibly.

This class parameterizes a plane in terms of an origin vector o and two plane-spanning directions u and v.

Definition at line 61 of file DetPlane.h.

Constructor & Destructor Documentation

◆ DetPlane() [1/4]

genfit::DetPlane::DetPlane ( AbsFinitePlane * finite = NULL )

Definition at line 33 of file DetPlane.cc.

  :finitePlane_(finite)
{
  // default constructor
  o_.SetXYZ(0.,0.,0.);
  u_.SetXYZ(1.,0.,0.);
  v_.SetXYZ(0.,1.,0.);
  // sane() not needed here
}

◆ DetPlane() [2/4]

genfit::DetPlane::DetPlane	(	const TVector3 &	o,
		const TVector3 &	u,
		const TVector3 &	v,
		AbsFinitePlane *	finite = `NULL`
	)

Definition at line 44 of file DetPlane.cc.

  :o_(o), u_(u), v_(v), finitePlane_(finite)
{
  sane();
}

◆ DetPlane() [3/4]

genfit::DetPlane::DetPlane	(	const TVector3 &	o,
		const TVector3 &	n,
		AbsFinitePlane *	finite = `NULL`
	)

Definition at line 53 of file DetPlane.cc.

  :o_(o), finitePlane_(finite)
{
  setNormal(n);
}

◆ ~DetPlane()

genfit::DetPlane::~DetPlane ( )

virtual

Definition at line 62 of file DetPlane.cc.

                   {
  ;
}

◆ DetPlane() [4/4]

genfit::DetPlane::DetPlane ( const DetPlane & rhs )

Definition at line 67 of file DetPlane.cc.

                                      :
  TObject(rhs),
  o_(rhs.o_),
  u_(rhs.u_),
  v_(rhs.v_)
{
  if(rhs.finitePlane_)
    finitePlane_.reset(rhs.finitePlane_->clone());
  else finitePlane_.reset();
}

Member Function Documentation

◆ dist()

TVector3 genfit::DetPlane::dist ( const TVector3 & point ) const

Definition at line 199 of file DetPlane.cc.

{
  return toLab(LabToPlane(x)) - x;
}

◆ distance() [1/2]

double genfit::DetPlane::distance ( const TVector3 & point ) const

absolute distance from a point to the plane

Definition at line 268 of file DetPlane.cc.

                                                     {
  // |(point - o_)*(u_ x v_)|
  return fabs( (point.X()-o_.X()) * (u_.Y()*v_.Z() - u_.Z()*v_.Y()) +
               (point.Y()-o_.Y()) * (u_.Z()*v_.X() - u_.X()*v_.Z()) +
               (point.Z()-o_.Z()) * (u_.X()*v_.Y() - u_.Y()*v_.X()));
}

◆ distance() [2/2]

double genfit::DetPlane::distance	(	double	x,
		double	y,
		double	z
	)		const

Definition at line 275 of file DetPlane.cc.

                                                            {
  // |(point - o_)*(u_ x v_)|
  return fabs( (x-o_.X()) * (u_.Y()*v_.Z() - u_.Z()*v_.Y()) +
               (y-o_.Y()) * (u_.Z()*v_.X() - u_.X()*v_.Z()) +
               (z-o_.Z()) * (u_.X()*v_.Y() - u_.Y()*v_.X()));
}

◆ getNormal()

TVector3 genfit::DetPlane::getNormal ( ) const

Definition at line 157 of file DetPlane.cc.

{
  return u_.Cross(v_);
}

◆ getO()

const TVector3 & genfit::DetPlane::getO ( ) const

inline

Definition at line 85 of file DetPlane.h.

85{return o_;}

◆ getU()

const TVector3 & genfit::DetPlane::getU ( ) const

inline

Definition at line 86 of file DetPlane.h.

86{return u_;}

◆ getV()

const TVector3 & genfit::DetPlane::getV ( ) const

inline

Definition at line 87 of file DetPlane.h.

87{return v_;}

◆ isFinite()

bool genfit::DetPlane::isFinite ( ) const

inline

Definition at line 171 of file DetPlane.h.

                        {
    return (finitePlane_.get() != NULL);
  }

◆ isInActive() [1/4]

bool genfit::DetPlane::isInActive	(	const double &	posX,
		const double &	posY,
		const double &	posZ,
		const double &	dirX,
		const double &	dirY,
		const double &	dirZ
	)		const

inline

intersect in the active area? C.f. AbsFinitePlane

Definition at line 152 of file DetPlane.h.

                                                                                    {
    if(finitePlane_.get() == NULL) return true;
    double u, v;
    this->straightLineToPlane(posX, posY, posZ, dirX, dirY, dirZ, u, v);
    return this->isInActive(u, v);
  }

◆ isInActive() [2/4]

bool genfit::DetPlane::isInActive ( const TVector2 & v ) const

inline

isInActive methods refer to finite plane. C.f. AbsFinitePlane

Definition at line 167 of file DetPlane.h.

                                          {
    return isInActive(v.X(),v.Y());
  }

◆ isInActive() [3/4]

bool genfit::DetPlane::isInActive	(	const TVector3 &	point,
		const TVector3 &	dir
	)		const

inline

intersect in the active area? C.f. AbsFinitePlane

Definition at line 146 of file DetPlane.h.

                                                                    {
    if(finitePlane_.get() == NULL) return true;
    return this->isInActive( this->straightLineToPlane(point,dir));
  }

◆ isInActive() [4/4]

bool genfit::DetPlane::isInActive	(	double	u,
		double	v
	)		const

inline

isInActive methods refer to finite plane. C.f. AbsFinitePlane

Definition at line 161 of file DetPlane.h.

                                           {
    if(finitePlane_.get() == NULL) return true;
    return finitePlane_->isInActive(u,v);
  }

◆ LabToPlane()

TVector2 genfit::DetPlane::LabToPlane ( const TVector3 & x ) const

transform from Lab system into plane

Definition at line 184 of file DetPlane.cc.

{
  return project(x-o_);
}

◆ operator=()

DetPlane & genfit::DetPlane::operator= ( DetPlane other )

Definition at line 79 of file DetPlane.cc.

                                            {
  swap(other);
  return *this;
}

◆ Print()

void genfit::DetPlane::Print ( const Option_t * option = "" ) const

Definition at line 220 of file DetPlane.cc.

{
  std::cout<<"DetPlane: "
     <<"O("<<o_.X()<<", "<<o_.Y()<<", "<<o_.Z()<<") "
     <<"u("<<u_.X()<<", "<<u_.Y()<<", "<<u_.Z()<<") "
     <<"v("<<v_.X()<<", "<<v_.Y()<<", "<<v_.Z()<<") "
     <<"n("<<getNormal().X()<<", "<<getNormal().Y()<<", "<<getNormal().Z()<<") "
       <<std::endl;
  if(finitePlane_ != NULL) {
    finitePlane_->Print(option);
  }
 
}

◆ project()

TVector2 genfit::DetPlane::project ( const TVector3 & x ) const

projecting a direction onto the plane:

Definition at line 178 of file DetPlane.cc.

{
  return TVector2(u_*x, v_*x);
}

◆ reset()

void genfit::DetPlane::reset ( )

delete finitePlane_ and set O, U, V to default values

Definition at line 329 of file DetPlane.cc.

                     {
  o_.SetXYZ(0.,0.,0.);
  u_.SetXYZ(1.,0.,0.);
  v_.SetXYZ(0.,1.,0.);
  finitePlane_.reset();
}

◆ rotate()

void genfit::DetPlane::rotate ( double angle )

rotate u and v around normal. Angle is in rad. More for debugging than for actual use.

Definition at line 320 of file DetPlane.cc.

                                  {
  TVector3 normal = getNormal();
  u_.Rotate(angle, normal);
  v_.Rotate(angle, normal);
 
  sane();
}

◆ sane()

void genfit::DetPlane::sane ( )

private

ensures orthonormal coordinates

Definition at line 205 of file DetPlane.cc.

                   {
  assert(u_!=v_);
 
  // ensure unit vectors
  u_.SetMag(1.);
  v_.SetMag(1.);
 
  // check if already orthogonal
  if (u_.Dot(v_) < 1.E-5) return;
 
  // ensure orthogonal system
  v_ = getNormal().Cross(u_);
}

◆ set()

void genfit::DetPlane::set	(	const TVector3 &	o,
		const TVector3 &	u,
		const TVector3 &	v
	)

Definition at line 95 of file DetPlane.cc.

{
  o_ = o;
  u_ = u;
  v_ = v;
  sane();
}

◆ setFinitePlane()

void genfit::DetPlane::setFinitePlane ( AbsFinitePlane * finite )

inline

Optionally, set the finite plane definition. This is most important for avoiding fake intersection points in fitting of curlers. This should be implemented for silicon detectors most importantly.

Definition at line 105 of file DetPlane.h.

105{finitePlane_.reset(finite);}

◆ setNormal() [1/3]

void genfit::DetPlane::setNormal	(	const double &	theta,
		const double &	phi
	)

Definition at line 173 of file DetPlane.cc.

                                                              {
  setNormal( TVector3(TMath::Sin(theta)*TMath::Cos(phi),TMath::Sin(theta)*TMath::Sin(phi),TMath::Cos(theta)) );
}

◆ setNormal() [2/3]

void genfit::DetPlane::setNormal ( const TVector3 & n )

Definition at line 166 of file DetPlane.cc.

                                         {
  u_ = n.Orthogonal();
  v_ = n.Cross(u_);
  u_.SetMag(1.);
  v_.SetMag(1.);
}

◆ setNormal() [3/3]

void genfit::DetPlane::setNormal	(	double	X,
		double	Y,
		double	Z
	)

Definition at line 162 of file DetPlane.cc.

                                                  {
  setNormal( TVector3(X,Y,Z) );
}

◆ setO() [1/2]

void genfit::DetPlane::setO ( const TVector3 & o )

Definition at line 106 of file DetPlane.cc.

{
  o_ = o;
}

◆ setO() [2/2]

void genfit::DetPlane::setO	(	double	X,
		double	Y,
		double	Z
	)

Definition at line 111 of file DetPlane.cc.

{
  o_.SetXYZ(X,Y,Z);
}

◆ setON()

void genfit::DetPlane::setON	(	const TVector3 &	o,
		const TVector3 &	n
	)

Definition at line 151 of file DetPlane.cc.

                                                       {
  o_ = o;
  setNormal(n);
}

◆ setU() [1/2]

void genfit::DetPlane::setU ( const TVector3 & u )

Definition at line 116 of file DetPlane.cc.

{
  u_ = u;
  sane(); // sets v_ perpendicular to u_
}

◆ setU() [2/2]

void genfit::DetPlane::setU	(	double	X,
		double	Y,
		double	Z
	)

Definition at line 122 of file DetPlane.cc.

{
  u_.SetXYZ(X,Y,Z);
  sane(); // sets v_ perpendicular to u_
}

◆ setUV()

void genfit::DetPlane::setUV	(	const TVector3 &	u,
		const TVector3 &	v
	)

Definition at line 144 of file DetPlane.cc.

{
  u_ = u;
  v_ = v;
  sane();
}

◆ setV() [1/2]

void genfit::DetPlane::setV ( const TVector3 & v )

Definition at line 128 of file DetPlane.cc.

{
  v_ = v;
  u_ = getNormal().Cross(v_);
  u_ *= -1.;
  sane();
}

◆ setV() [2/2]

void genfit::DetPlane::setV	(	double	X,
		double	Y,
		double	Z
	)

Definition at line 136 of file DetPlane.cc.

{
  v_.SetXYZ(X,Y,Z);
  u_ = getNormal().Cross(v_);
  u_ *= -1.;
  sane();
}

◆ straightLineToPlane() [1/2]

void genfit::DetPlane::straightLineToPlane	(	const double &	posX,
		const double &	posY,
		const double &	posZ,
		const double &	dirX,
		const double &	dirY,
		const double &	dirZ,
		double &	u,
		double &	v
	)		const

gives u,v coordinates of the intersection point of a straight line with plane

Definition at line 296 of file DetPlane.cc.

                                                               {
 
  TVector3 W = getNormal();
  double dirTimesN = dirX*W.X() + dirY*W.Y() + dirZ*W.Z();
  if(fabs(dirTimesN)<1.E-6){//straight line is parallel to plane, so return infinity
    u = 1.E100;
    v = 1.E100;
    return;
  }
  double t = 1./dirTimesN * ((o_.X()-posX)*W.X() +
                             (o_.Y()-posY)*W.Y() +
                             (o_.Z()-posZ)*W.Z());
 
  double posOnPlaneX = posX-o_.X() + t*dirX;
  double posOnPlaneY = posY-o_.Y() + t*dirY;
  double posOnPlaneZ = posZ-o_.Z() + t*dirZ;
 
  u = u_.X()*posOnPlaneX + u_.Y()*posOnPlaneY + u_.Z()*posOnPlaneZ;
  v = v_.X()*posOnPlaneX + v_.Y()*posOnPlaneY + v_.Z()*posOnPlaneZ;
}

◆ straightLineToPlane() [2/2]

TVector2 genfit::DetPlane::straightLineToPlane	(	const TVector3 &	point,
		const TVector3 &	dir
	)		const

gives u,v coordinates of the intersection point of a straight line with plane

Definition at line 283 of file DetPlane.cc.

                                                                                        {
  TVector3 dirNorm(dir.Unit());
  TVector3 normal = getNormal();
  double dirTimesN = dirNorm*normal;
  if(fabs(dirTimesN)<1.E-6){//straight line is parallel to plane, so return infinity
    return TVector2(1.E100,1.E100);
  }
  double t = 1./dirTimesN * ((o_-point)*normal);
  return project(point - o_ + t * dirNorm);
}

◆ swap()

void genfit::DetPlane::swap ( DetPlane & other )

Definition at line 85 of file DetPlane.cc.

                                   {
  // by swapping the members of two classes,
  // the two classes are effectively swapped
  std::swap(this->o_, other.o_);
  std::swap(this->u_, other.u_);
  std::swap(this->v_, other.v_);
  this->finitePlane_.swap(other.finitePlane_);
}

◆ toLab()

TVector3 genfit::DetPlane::toLab ( const TVector2 & x ) const

transform from plane coordinates to lab system

Definition at line 190 of file DetPlane.cc.

{
  TVector3 d(o_);
  d += x.X()*u_;
  d += x.Y()*v_;
  return d;
}

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const DetPlane &	lhs,
		const DetPlane &	rhs
	)

friend

returns NOT ==

Definition at line 263 of file DetPlane.cc.

                                                          {
  return !(lhs==rhs);
}

◆ operator==

bool operator==	(	const DetPlane &	lhs,
		const DetPlane &	rhs
	)

friend

Checks equality of planes by comparing the 9 double values that define them.

Definition at line 241 of file DetPlane.cc.

                                                          {
  if (&lhs == &rhs)
    return true;
  static const double detplaneEpsilon = 1.E-5;
  if(
     fabs( (lhs.o_.X()-rhs.o_.X()) ) > detplaneEpsilon  ||
     fabs( (lhs.o_.Y()-rhs.o_.Y()) ) > detplaneEpsilon  ||
     fabs( (lhs.o_.Z()-rhs.o_.Z()) ) > detplaneEpsilon
     ) return false;
  else if(
    fabs( (lhs.u_.X()-rhs.u_.X()) ) > detplaneEpsilon  ||
    fabs( (lhs.u_.Y()-rhs.u_.Y()) ) > detplaneEpsilon  ||
    fabs( (lhs.u_.Z()-rhs.u_.Z()) ) > detplaneEpsilon
    ) return false;
  else if(
    fabs( (lhs.v_.X()-rhs.v_.X()) ) > detplaneEpsilon  ||
    fabs( (lhs.v_.Y()-rhs.v_.Y()) ) > detplaneEpsilon  ||
    fabs( (lhs.v_.Z()-rhs.v_.Z()) ) > detplaneEpsilon
    ) return false;
  return true;
}

Member Data Documentation

◆ finitePlane_

boost::scoped_ptr<AbsFinitePlane> genfit::DetPlane::finitePlane_

private

Definition at line 191 of file DetPlane.h.

◆ o_

TVector3 genfit::DetPlane::o_

private

Definition at line 186 of file DetPlane.h.

◆ u_

TVector3 genfit::DetPlane::u_

private

Definition at line 187 of file DetPlane.h.

◆ v_

TVector3 genfit::DetPlane::v_

private

Definition at line 188 of file DetPlane.h.

The documentation for this class was generated from the following files:

genfit/core/include/DetPlane.h
genfit/core/src/DetPlane.cc

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DetPlane() [1/4]

◆ DetPlane() [2/4]

◆ DetPlane() [3/4]

◆ ~DetPlane()

◆ DetPlane() [4/4]

Member Function Documentation

◆ dist()

◆ distance() [1/2]

◆ distance() [2/2]

◆ getNormal()

◆ getO()

◆ getU()

◆ getV()

◆ isFinite()

◆ isInActive() [1/4]

◆ isInActive() [2/4]

◆ isInActive() [3/4]

◆ isInActive() [4/4]

◆ LabToPlane()

◆ operator=()

◆ Print()

◆ project()

◆ reset()

◆ rotate()

◆ sane()

◆ set()

◆ setFinitePlane()

◆ setNormal() [1/3]

◆ setNormal() [2/3]

◆ setNormal() [3/3]

◆ setO() [1/2]

◆ setO() [2/2]

◆ setON()

◆ setU() [1/2]

◆ setU() [2/2]

◆ setUV()

◆ setV() [1/2]

◆ setV() [2/2]

◆ straightLineToPlane() [1/2]

◆ straightLineToPlane() [2/2]

◆ swap()

◆ toLab()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ finitePlane_

◆ o_

◆ u_

◆ v_