Vector3D Class Reference

A three dimensional vector. More...

#include <Vector3D.h>

Collaboration diagram for Vector3D:

Public Member Functions
	Vector3D ()=default
	Default constructor for ROOT compatibility.
	Vector3D (const TVector3 &tVector3)
	Constructor translating from a TVector3 instance.
	Vector3D (const B2Vector3D &b2Vector3)
	Constructor translating from a B2Vector3 instance.
	Vector3D (const ROOT::Math::XYZVector &xyzVector)
	Constructor translating from a ROOT::Math::XYZVector instance.
	Vector3D (double x, double y, double z)
	Constructor from three coordinates.
	Vector3D (const Vector2D &xy)
	Constructor augmeting a Vector2D to a Vector3D setting z to zero.
	Vector3D (const Vector2D &xy, double z)
	Constructor augmeting a Vector2D to a Vector3D setting z explicitly.
Vector3D &	operator= (const TVector3 &tVector3)
	Assignment translating from a TVector3 instance.
Vector3D &	operator= (const B2Vector3D &b2Vector3)
	Assignment translating from a B2Vector3 instance.
Vector3D &	operator= (const ROOT::Math::XYZVector &xyzVector)
	Assignment translating from a ROOT::Math::XYZVector instance.
	operator const TVector3 () const
	Casting the back to TVector3 seamlessly.
	operator const B2Vector3D () const
	Casting the back to B2Vector3 seamlessly.
	operator const ROOT::Math::XYZVector () const
	Casting the back to ROOT::Math::XYZVector seamlessly.
bool	operator== (const Vector3D &rhs) const
	Equality comparison with all three coordinates.
bool	operator< (const Vector3D &rhs) const
	Total ordering based on cylindrical radius first the z component second and azimuth angle third.
bool	isNull () const
	Checks if the vector is the null vector.
bool	hasNAN () const
	Checks if one of the coordinates is NAN.
std::string	__str__ () const
	Output operator for python.
double	dot (const Vector3D &rhs) const
	Calculates the three dimensional dot product.
double	Dot (const Vector3D &rhs) const
	Calculates the three dimensional dot product, ROOT::Math compatible.
double	dotXY (const Vector3D &rhs) const
	Calculates the two dimensional dot product in xy projection.
Vector3D	cross (const Vector3D &rhs) const
	Calculated the three dimensional cross product.
double	crossXY (const Vector3D &rhs) const
	Calculates the two dimensional cross product in xy projection.
double	crossXY (const Vector2D &rhs) const
	Calculates the two dimensional cross product in xy projection.
double	normSquared () const
	Calculates the squared length of the vector.
double	Mag2 () const
	Alias for normSquared.
double	norm () const
	Calculates the length of the vector.
double	distance (const Vector3D &rhs=Vector3D(0.0, 0.0, 0.0)) const
	Calculates the distance of this point to the rhs.
Vector3D &	scale (const double factor)
	Scales the vector in place by the given factor.
Vector3D &	operator*= (const double factor)
	Same as scale()
Vector3D	scaled (const double factor) const
	Returns a scaled copy of the vector.
Vector3D	operator* (const double factor) const
	Same as scaled()
Vector3D &	divide (const double denominator)
	Divides all coordinates by a common denominator in place.
Vector3D &	operator/= (const double denominator)
	Same as divide()
Vector3D	divided (const double denominator) const
	Returns a copy where all coordinates got divided by a common denominator.
Vector3D	operator/ (const double denominator) const
	Same as divided()
Vector3D &	add (const Vector3D &rhs)
	Adds a vector to this in place.
Vector3D &	add (const Vector2D &rhs)
	Adds a two dimensional vector to this in place taking z of the given vector as zero.
Vector3D &	operator+= (const Vector3D &rhs)
	Same as add()
Vector3D &	operator+= (const Vector2D &rhs)
	Same as add()
Vector3D &	subtract (const Vector3D &rhs)
	Subtracts a vector to this in place.
Vector3D &	subtract (const Vector2D &rhs)
	Subtracts a two dimensional vector from this in place taking z of the given vector as zero.
Vector3D &	operator-= (const Vector3D &rhs)
	Same as subtract()
Vector3D &	operator-= (const Vector2D &rhs)
	Same as subtract()
Vector3D	unit () const
	Returns a unit vector colaligned with this.
double	normalize ()
	Normalizes the vector to unit length.
double	normalizeTo (const double toLength)
	Normalizes the vector to the given length.
Vector3D &	reverse ()
	Reverses the direction of the vector in place.
Vector3D	reversed () const
	Returns a vector pointing in the opposite direction.
Vector3D	operator- () const
	Same as reversed()
Vector3D	operator+ (const Vector3D &rhs) const
	Returns a new vector as sum of this and rhs.
Vector3D	operator- (const Vector3D &rhs) const
	Returns a new vector as difference of this and rhs.
double	parallelComp (const Vector3D &relativTo) const
	Calculates the component parallel to the given vector.
double	unnormalizedParallelComp (const Vector3D &relativTo) const
	Same as parallelComp() but assumes the given vector to be of unit length.
double	orthogonalComp (const Vector3D &relativTo) const
	Calculates the component orthogonal to the given vector.
Vector3D	orthogonalVector (const Vector3D &relativTo) const
	Calculates the part of this vector that is orthogonal to the given vector.
double	unnormalizedOrthogonalComp (const Vector3D &relativTo) const
	Same as orthogonalComp() but assumes the given vector to be of unit length.
void	passiveMoveBy (const Vector3D &by)
	Passively moves the vector inplace by the given vector.
Vector3D	passiveMovedBy (const Vector3D &by)
	Passively moves the vector inplace by the given vector.
double	x () const
	Getter for the x coordinate.
void	setX (const double x)
	Setter for the x coordinate.
double	y () const
	Getter for the y coordinate.
void	setY (const double y)
	Setter for the y coordinate.
double	z () const
	Getter for the z coordinate.
void	setZ (const double z)
	Setter for the z coordinate.
const Vector2D &	xy () const
	Getter for the xy projected vector ( reference ! )
void	setXY (const Vector2D &xy)
	Setter for the xy projected vector.
void	set (const double first, const double second, const double third)
	Setter for all three coordinates.
double	cylindricalRSquared () const
	Getter for the squared cylindrical radius ( xy projected squared norm )
double	cylindricalR () const
	Getter for the cylindrical radius ( xy projected norm )
double	phi () const
	Getter for the azimuth angle.
double	theta () const
	Getter for the polar angle.
double	lambda () const
	Getter for lambda.
double	cotTheta () const
	Getter for the cotangent of the polar angle.
double	tanLambda () const
	Getter for the tangent of lambda equivalent to cotTheta()
Angle functions
These functions measure the angle between two vectors from this to rhs. Because the three dimensional space does not have a unique orientation available, the sign of the angle is not well defined. Therefore angles between three dimensional vectors are always positive and so is the sine of the angle. The angle is bound by M_PI.
double	cosWith (const Vector3D &rhs) const
double	sinWith (const Vector3D &rhs) const
	Sine of the angle between this and rhs.
double	angleWith (const Vector3D &rhs) const
	The angle between this and rhs.

Static Public Member Functions
static Vector3D	average (const Vector3D &one, const Vector3D &two)
	Constructs the average of two vectors.
static Vector3D	average (const Vector3D &one, const Vector3D &two, const Vector3D &three)
	Constructs the average of three vectors.
static Vector3D	getLowest ()
	Getter for the lowest possible vector.

Private Attributes
Vector2D	m_xy {0.0, 0.0}
	Memory for the first and second coordinate available as a vector.
double	m_z = 0.0
	Memory for the third coordinate.

Detailed Description

A three dimensional vector.

A three dimensional vector which is equipped with the expected vector methods.
Also this vector can be passed to functions where a TVector3 is expected syntactically.

Definition at line 34 of file Vector3D.h.

Constructor & Destructor Documentation

Vector3D() [1/6]

Vector3D ( const TVector3 & tVector3 )

explicit

Constructor translating from a TVector3 instance.

Definition at line 20 of file Vector3D.cc.

  : m_xy(tVector3.X(), tVector3.Y())
  , m_z(tVector3.Z())
{
}

Vector3D() [2/6]

Vector3D ( const B2Vector3D & b2Vector3 )

explicit

Constructor translating from a B2Vector3 instance.

Definition at line 26 of file Vector3D.cc.

  : m_xy(b2Vector3.X(), b2Vector3.Y())
  , m_z(b2Vector3.Z())
{
}

Vector3D() [3/6]

Vector3D

(

const ROOT::Math::XYZVector &

xyzVector

)

Constructor translating from a ROOT::Math::XYZVector instance.

Definition at line 32 of file Vector3D.cc.

  : m_xy(xyzVector.X(), xyzVector.Y())
  , m_z(xyzVector.Z())
{
}

Vector3D() [4/6]

Vector3D ( double x, double y, double z )

inline

Constructor from three coordinates.

Definition at line 50 of file Vector3D.h.

        : m_xy(x, y)
        , m_z(z)
      {
      }

Vector3D() [5/6]

Vector3D ( const Vector2D & xy )

inlineexplicit

Constructor augmeting a Vector2D to a Vector3D setting z to zero.

Definition at line 57 of file Vector3D.h.

        : m_xy(xy)
        , m_z(0.0)
      {
      }

Vector3D() [6/6]

Vector3D ( const Vector2D & xy, double z )

inline

Constructor augmeting a Vector2D to a Vector3D setting z explicitly.

Definition at line 64 of file Vector3D.h.

        : m_xy(xy)
        , m_z(z)
      {
      }

Member Function Documentation

__str__()

std::string __str__

(

)

const

Output operator for python.

Definition at line 82 of file Vector3D.cc.

{
  std::stringstream sstream;
  sstream << *this;
  return sstream.str();
}

add() [1/2]

Vector3D & add ( const Vector2D & rhs )

inline

Adds a two dimensional vector to this in place taking z of the given vector as zero.

Definition at line 320 of file Vector3D.h.

      {
        m_xy.add(rhs);
        return *this;
      }

add() [2/2]

Vector3D & add ( const Vector3D & rhs )

inline

Adds a vector to this in place.

Definition at line 312 of file Vector3D.h.

      {
        m_xy.add(rhs.xy());
        m_z += rhs.z();
        return *this;
      }

angleWith()

double angleWith ( const Vector3D & rhs ) const

inline

The angle between this and rhs.

Definition at line 244 of file Vector3D.h.

      {
        return atan2(sinWith(rhs), cosWith(rhs));
      }

average() [1/2]

static Vector3D average ( const Vector3D & one, const Vector3D & two )

inlinestatic

Constructs the average of two vectors.

Computes the average of two vectors. If one vector contains NAN the average is the other vector, since the former is not considered a valid value.

Definition at line 84 of file Vector3D.h.

      {
        if (one.hasNAN()) {
          return two;
        } else if (two.hasNAN()) {
          return one;
        } else {
          return Vector3D((one.x() + two.x()) / 2.0,
                          (one.y() + two.y()) / 2.0,
                          (one.z() + two.z()) / 2.0);
        }
      }

average() [2/2]

static Vector3D average ( const Vector3D & one, const Vector3D & two, const Vector3D & three )

inlinestatic

Constructs the average of three vectors.

Computes the average of three vectors. In case one of the three dimensional vectors contains an NAN, it is not considered a valid value for the average and is therefore left out. The average() of the other two vectors is then returned.

Definition at line 103 of file Vector3D.h.

      {
 
        if (one.hasNAN()) {
          return average(two, three);
        } else if (two.hasNAN()) {
          return average(one, three);
        } else if (three.hasNAN()) {
          return average(one, two);
        } else {
          return Vector3D((one.x() + two.x() + three.x()) / 3.0,
                          (one.y() + two.y() + three.y()) / 3.0,
                          (one.z() + two.z() + three.z()) / 3.0);
        }
      }

cosWith()

double cosWith ( const Vector3D & rhs ) const

inline

Cosine of the angle between this and rhs

Definition at line 232 of file Vector3D.h.

      {
        return dot(rhs) / (norm() * rhs.norm());
      }

cotTheta()

double cotTheta ( ) const

inline

Getter for the cotangent of the polar angle.

Definition at line 559 of file Vector3D.h.

      {
        return z() / cylindricalR();
      }

cross()

Vector3D cross ( const Vector3D & rhs ) const

inline

Calculated the three dimensional cross product.

Definition at line 188 of file Vector3D.h.

      {
        return Vector3D(y() * rhs.z() - z() * rhs.y(),
                        z() * rhs.x() - x() * rhs.z(),
                        x() * rhs.y() - y() * rhs.x());
      }

crossXY() [1/2]

double crossXY ( const Vector2D & rhs ) const

inline

Calculates the two dimensional cross product in xy projection.

Definition at line 202 of file Vector3D.h.

      {
        return xy().cross(rhs);
      }

crossXY() [2/2]

double crossXY ( const Vector3D & rhs ) const

inline

Calculates the two dimensional cross product in xy projection.

Definition at line 196 of file Vector3D.h.

      {
        return xy().cross(rhs.xy());
      }

cylindricalR()

double cylindricalR ( ) const

inline

Getter for the cylindrical radius ( xy projected norm )

Definition at line 535 of file Vector3D.h.

      {
        return xy().norm();
      }

cylindricalRSquared()

double cylindricalRSquared ( ) const

inline

Getter for the squared cylindrical radius ( xy projected squared norm )

Definition at line 529 of file Vector3D.h.

      {
        return xy().normSquared();
      }

distance()

double distance ( const Vector3D & rhs = Vector3D(0.0, 0.0, 0.0) ) const

inline

Calculates the distance of this point to the rhs.

Definition at line 251 of file Vector3D.h.

      {
        double deltaX = x() - rhs.x();
        double deltaY = y() - rhs.y();
        double deltaZ = z() - rhs.z();
        return hypot3(deltaX, deltaY, deltaZ);
      }

divide()

Vector3D & divide ( const double denominator )

inline

Divides all coordinates by a common denominator in place.

Definition at line 286 of file Vector3D.h.

      {
        m_xy.divide(denominator);
        m_z /= denominator;
        return *this;
      }

divided()

Vector3D divided ( const double denominator ) const

inline

Returns a copy where all coordinates got divided by a common denominator.

Definition at line 300 of file Vector3D.h.

      {
        return Vector3D(xy().divided(denominator), z() / denominator);
      }

Dot()

double Dot ( const Vector3D & rhs ) const

inline

Calculates the three dimensional dot product, ROOT::Math compatible.

Definition at line 176 of file Vector3D.h.

      {
        return dot(rhs);
      }

dot()

double dot ( const Vector3D & rhs ) const

inline

Calculates the three dimensional dot product.

Definition at line 171 of file Vector3D.h.

      {
        return x() * rhs.x() + y() * rhs.y() + z() * rhs.z();
      }

dotXY()

double dotXY ( const Vector3D & rhs ) const

inline

Calculates the two dimensional dot product in xy projection.

Definition at line 182 of file Vector3D.h.

      {
        return x() * rhs.x() + y() * rhs.y();
      }

getLowest()

static Vector3D getLowest ( )

inlinestatic

Getter for the lowest possible vector.

The lowest possible vector according to the comparison is the null vector

Definition at line 150 of file Vector3D.h.

      {
        return Vector3D(0.0, 0.0, 0.0);
      }

hasNAN()

bool hasNAN ( ) const

inline

Checks if one of the coordinates is NAN.

Definition at line 162 of file Vector3D.h.

      {
        return std::isnan(x()) or std::isnan(y()) or std::isnan(z());
      }

isNull()

bool isNull ( ) const

inline

Checks if the vector is the null vector.

Definition at line 156 of file Vector3D.h.

      {
        return x() == 0.0 and y() == 0.0 and z() == 0.0;
      }

lambda()

double lambda ( ) const

inline

Getter for lambda.

Definition at line 553 of file Vector3D.h.

      {
        return atan2(z(), cylindricalR());
      }

Mag2()

double Mag2 ( ) const

inline

Alias for normSquared.

Definition at line 213 of file Vector3D.h.

      {
        return normSquared();
      }

norm()

double norm ( ) const

inline

Calculates the length of the vector.

Definition at line 219 of file Vector3D.h.

      {
        return hypot3(x(), y(), z());
      }

normalize()

double normalize ( )

inline

Normalizes the vector to unit length.

Normalizes the vector to unit length and returns the length the vector had before.
The null vector is not transformed.

Definition at line 374 of file Vector3D.h.

      {
        double result = norm();
        if (result != 0.0) divide(result);
        return result;
      }

normalizeTo()

double normalizeTo ( const double toLength )

inline

Normalizes the vector to the given length.

Normalizes the vector to the given length and returns the length the vector had before.
The null vector is not transformed.

Definition at line 384 of file Vector3D.h.

      {
        double result = norm();
        if (result != 0.0) scale(toLength / result);
        return result;
      }

normSquared()

double normSquared ( ) const

inline

Calculates the squared length of the vector.

Definition at line 208 of file Vector3D.h.

      {
        return x() * x() + y() * y() + z() * z();
      }

operator const B2Vector3D()

operator const B2Vector3D

(

)

const

Casting the back to B2Vector3 seamlessly.

Definition at line 67 of file Vector3D.cc.

{
  return B2Vector3D(x(), y(), z());
}

operator const ROOT::Math::XYZVector()

operator const ROOT::Math::XYZVector

(

)

const

Casting the back to ROOT::Math::XYZVector seamlessly.

Definition at line 72 of file Vector3D.cc.

{
  return ROOT::Math::XYZVector(x(), y(), z());
}

operator const TVector3()

operator const TVector3

(

)

const

Casting the back to TVector3 seamlessly.

Definition at line 62 of file Vector3D.cc.

{
  return TVector3(x(), y(), z());
}

operator*()

Vector3D operator* ( const double factor ) const

inline

Same as scaled()

Definition at line 280 of file Vector3D.h.

      {
        return scaled(factor);
      }

operator*=()

Vector3D & operator*= ( const double factor )

inline

Same as scale()

Definition at line 268 of file Vector3D.h.

      {
        return scale(factor);
      }

operator+()

Vector3D operator+ ( const Vector3D & rhs ) const

inline

Returns a new vector as sum of this and rhs.

Definition at line 411 of file Vector3D.h.

      {
        return Vector3D(xy() + rhs.xy(), z() + rhs.z());
      }

operator+=() [1/2]

Vector3D & operator+= ( const Vector2D & rhs )

inline

Same as add()

Definition at line 333 of file Vector3D.h.

      {
        return add(rhs);
      }

operator+=() [2/2]

Vector3D & operator+= ( const Vector3D & rhs )

inline

Same as add()

Definition at line 327 of file Vector3D.h.

      {
        return add(rhs);
      }

operator-() [1/2]

Vector3D operator- ( ) const

inline

Same as reversed()

Definition at line 405 of file Vector3D.h.

      {
        return reversed();
      }

operator-() [2/2]

Vector3D operator- ( const Vector3D & rhs ) const

inline

Returns a new vector as difference of this and rhs.

Definition at line 417 of file Vector3D.h.

      {
        return Vector3D(xy() - rhs.xy(), z() - rhs.z());
      }

operator-=() [1/2]

Vector3D & operator-= ( const Vector2D & rhs )

inline

Same as subtract()

Definition at line 360 of file Vector3D.h.

      {
        return subtract(rhs);
      }

operator-=() [2/2]

Vector3D & operator-= ( const Vector3D & rhs )

inline

Same as subtract()

Definition at line 354 of file Vector3D.h.

      {
        return subtract(rhs);
      }

operator/()

Vector3D operator/ ( const double denominator ) const

inline

Same as divided()

Definition at line 306 of file Vector3D.h.

      {
        return divided(denominator);
      }

operator/=()

Vector3D & operator/= ( const double denominator )

inline

Same as divide()

Definition at line 294 of file Vector3D.h.

      {
        return divide(denominator);
      }

operator<()

bool operator< ( const Vector3D & rhs ) const

inline

Total ordering based on cylindrical radius first the z component second and azimuth angle third.

Total order achieving a lower bound Vector3D(0.0, 0.0, 0.0). By first taking the norm
for comparison the null vector is smaller than all other possible
vectors. Secondly the polar angle theta ( equivalently z ) and finally the azimuth
angle phi is considered to have a total ordering for all vectors.
Note does not commute with the projection to xy space.

Definition at line 142 of file Vector3D.h.

      {
        return norm() < rhs.norm() or (norm() == rhs.norm() and
                                       (z() < rhs.z() or (z() == rhs.z() and (phi() < rhs.phi()))));
      }

operator=() [1/3]

Vector3D & operator=

(

const B2Vector3D &

b2Vector3

)

Assignment translating from a B2Vector3 instance.

Definition at line 46 of file Vector3D.cc.

{
  m_xy.setX(b2Vector3.X());
  m_xy.setY(b2Vector3.Y());
  m_z = b2Vector3.Z();
  return *this;
}

operator=() [2/3]

Vector3D & operator=

(

const ROOT::Math::XYZVector &

xyzVector

)

Assignment translating from a ROOT::Math::XYZVector instance.

Definition at line 54 of file Vector3D.cc.

{
  m_xy.setX(xyzVector.X());
  m_xy.setY(xyzVector.Y());
  m_z = xyzVector.Z();
  return *this;
}

operator=() [3/3]

Vector3D & operator=

(

const TVector3 &

tVector3

)

Assignment translating from a TVector3 instance.

Definition at line 38 of file Vector3D.cc.

{
  m_xy.setX(tVector3.X());
  m_xy.setY(tVector3.Y());
  m_z = tVector3.Z();
  return *this;
}

operator==()

bool operator== ( const Vector3D & rhs ) const

inline

Equality comparison with all three coordinates.

Definition at line 129 of file Vector3D.h.

      {
        return x() == rhs.x() and y() == rhs.y() and z() == rhs.z();
      }

orthogonalComp()

double orthogonalComp ( const Vector3D & relativTo ) const

inline

Calculates the component orthogonal to the given vector.

The orthogonal component is the rest of the vector not parallel to
relative to. Since the three dimensional space does not have a unique
orientation given by the vector relative to, the sign of the orthogonal
component is meaningless and is always set to positive

Definition at line 441 of file Vector3D.h.

      {
        return relativTo.cross(*this).norm() / relativTo.norm();
      }

orthogonalVector()

Vector3D orthogonalVector ( const Vector3D & relativTo ) const

inline

Calculates the part of this vector that is orthogonal to the given vector.

Definition at line 447 of file Vector3D.h.

      {
        return *this - Belle2::VectorUtil::parallelVector(*this, relativTo);
      }

parallelComp()

double parallelComp ( const Vector3D & relativTo ) const

inline

Calculates the component parallel to the given vector.

Definition at line 423 of file Vector3D.h.

      {
        return relativTo.dot(*this) / relativTo.norm();
      }

passiveMoveBy()

void passiveMoveBy ( const Vector3D & by )

inline

Passively moves the vector inplace by the given vector.

Definition at line 461 of file Vector3D.h.

      {
        subtract(by);
      }

passiveMovedBy()

Vector3D passiveMovedBy ( const Vector3D & by )

inline

Passively moves the vector inplace by the given vector.

Definition at line 467 of file Vector3D.h.

      {
        return *this - by;
      }

phi()

double phi ( ) const

inline

Getter for the azimuth angle.

Definition at line 541 of file Vector3D.h.

      {
        return xy().phi();
      }

reverse()

Vector3D & reverse ( )

inline

Reverses the direction of the vector in place.

Definition at line 392 of file Vector3D.h.

      {
        scale(-1.0);
        return *this;
      }

reversed()

Vector3D reversed ( ) const

inline

Returns a vector pointing in the opposite direction.

Definition at line 399 of file Vector3D.h.

      {
        return scaled(-1.0);
      }

scale()

Vector3D & scale ( const double factor )

inline

Scales the vector in place by the given factor.

Definition at line 260 of file Vector3D.h.

      {
        m_xy.scale(factor);
        m_z *= factor;
        return *this;
      }

scaled()

Vector3D scaled ( const double factor ) const

inline

Returns a scaled copy of the vector.

Definition at line 274 of file Vector3D.h.

      {
        return Vector3D(xy().scaled(factor), z() * factor);
      }

set()

void set ( const double first, const double second, const double third )

inline

Setter for all three coordinates.

Definition at line 521 of file Vector3D.h.

      {
        setX(first);
        setY(second);
        setZ(third);
      }

setX()

void setX ( const double x )

inline

Setter for the x coordinate.

Definition at line 479 of file Vector3D.h.

      {
        m_xy.setX(x);
      }

setXY()

void setXY ( const Vector2D & xy )

inline

Setter for the xy projected vector.

Definition at line 515 of file Vector3D.h.

      {
        m_xy = xy;
      }

setY()

void setY ( const double y )

inline

Setter for the y coordinate.

Definition at line 491 of file Vector3D.h.

      {
        m_xy.setY(y);
      }

setZ()

void setZ ( const double z )

inline

Setter for the z coordinate.

Definition at line 503 of file Vector3D.h.

      {
        m_z = z;
      }

sinWith()

double sinWith ( const Vector3D & rhs ) const

inline

Sine of the angle between this and rhs.

Definition at line 238 of file Vector3D.h.

      {
        return cross(rhs).norm() / (norm() * rhs.norm());
      }

subtract() [1/2]

Vector3D & subtract ( const Vector2D & rhs )

inline

Subtracts a two dimensional vector from this in place taking z of the given vector as zero.

Definition at line 347 of file Vector3D.h.

      {
        m_xy.subtract(rhs);
        return *this;
      }

subtract() [2/2]

Vector3D & subtract ( const Vector3D & rhs )

inline

Subtracts a vector to this in place.

Definition at line 339 of file Vector3D.h.

      {
        m_xy.subtract(rhs.xy());
        m_z -= rhs.z();
        return *this;
      }

tanLambda()

double tanLambda ( ) const

inline

Getter for the tangent of lambda equivalent to cotTheta()

Definition at line 565 of file Vector3D.h.

      {
        return z() / cylindricalR();
      }

theta()

double theta ( ) const

inline

Getter for the polar angle.

Definition at line 547 of file Vector3D.h.

      {
        return atan2(cylindricalR(), z());
      }

unit()

Vector3D unit ( ) const

inline

Returns a unit vector colaligned with this.

Definition at line 366 of file Vector3D.h.

      {
        return isNull() ? Vector3D(0.0, 0.0, 0.0) : divided(norm());
      }

unnormalizedOrthogonalComp()

double unnormalizedOrthogonalComp ( const Vector3D & relativTo ) const

inline

Same as orthogonalComp() but assumes the given vector to be of unit length.

This assumes the given vector relativeTo to be of unit length and avoids
a costly computation of the vector norm()

Definition at line 455 of file Vector3D.h.

      {
        return relativTo.cross(*this).norm();
      }

unnormalizedParallelComp()

double unnormalizedParallelComp ( const Vector3D & relativTo ) const

inline

Same as parallelComp() but assumes the given vector to be of unit length.

This assumes the given vector relativeTo to be of unit length and avoids
a costly computation of the vector norm()

Definition at line 431 of file Vector3D.h.

      {
        return relativTo.dot(*this);
      }

x()

double x ( ) const

inline

Getter for the x coordinate.

Definition at line 473 of file Vector3D.h.

      {
        return m_xy.x();
      }

xy()

const Vector2D & xy ( ) const

inline

Getter for the xy projected vector ( reference ! )

Definition at line 509 of file Vector3D.h.

      {
        return m_xy;
      }

y()

double y ( ) const

inline

Getter for the y coordinate.

Definition at line 485 of file Vector3D.h.

      {
        return m_xy.y();
      }

z()

double z ( ) const

inline

Getter for the z coordinate.

Definition at line 497 of file Vector3D.h.

      {
        return m_z;
      }

Member Data Documentation

m_xy

Vector2D m_xy {0.0, 0.0}

private

Memory for the first and second coordinate available as a vector.

Definition at line 572 of file Vector3D.h.

{0.0, 0.0};

m_z

double m_z = 0.0

private

Memory for the third coordinate.

Definition at line 575 of file Vector3D.h.

---

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

• tracking/trackingUtilities/geometry/include/Vector3D.h
• tracking/trackingUtilities/geometry/src/Vector3D.cc