A line in the sz space. More...

#include <SZLine.h>

Public Member Functions
	SZLine ()
	Default constructor for ROOT compatibility.

	SZLine (double tanLambda, double z0)
	Constructor from slope and intercept in the sz space.

	SZLine (const SZParameters &szParameters)
	Constructor from the sz parameters.

double	tanLambda () const
	Getter for the tan lambda parameter.

double	slope () const
	Getter for the slope in the sz space which is equivalent to tan lambda.

double	inverseSlope () const
	Returns the slope over the second coordinate.

double	theta () const
	Getter for the theta dip angle.

void	setTanLambda (double tanLambda)
	Getter for the tan lambda parameter.

double	z0 () const
	Getter for the z0 parameter.

double	intercept () const
	Getter for the intercept in the sz space which is equivalent to z0.

void	setZ0 (double z0)
	Getter for the z0 parameter.

SZParameters	szParameters () const
	Getter for the sz parameters.

double	zero () const
	Returns the the two dimensional arc length s where the z coordinate approaches zero.

double	map (double s) const
	Maps the two dimensional arc length s to z.

double	operator() (double s) const
	Maps the two dimensional arc length s to z.

double	inverseMap (double z) const
	Maps the z coordinate to the two dimensional arc length s.

void	invalidate ()
	Sets the parameters to a invalid representation.

bool	isInvalid () const
	Indicates if the line parameters do not represent a valid line.

void	reverse ()
	Reverse the arc length direction in place.

SZLine	reversed () const
	Returns a copy of the line with reversed the arc length direction.

double	distance (const ROOT::Math::XYVector &szPoint) const
	Calculates the signed distance of the point to the line.

double	distance (double s, double z) const
	Calculates the signed distance of the point given by its to coordinates to the line.

ROOT::Math::XYVector	intersection (const SZLine &szLine) const
	Calculates the intersection point of two line. Infinity for parallels.

void	passiveMoveBy (const ROOT::Math::XYVector &bySZ)
	Passively move the coordinate system in place by the given sz vector.

void	passiveMoveBy (double s, double z)
	Passively move the coordinate system in place by the given s and z coordinates.

SZLine	passiveMovedBy (const ROOT::Math::XYVector &bySZ) const
	Return a line passively move by the given vector as a copy.

SZLine	passiveMovedBy (double s, double z) const
	Return a line passively move by the given s and z coordinates as a copy.

Static Public Member Functions
static SZJacobian	passiveMoveByJacobian (const ROOT::Math::XYVector &bySZ)
	Computes the Jacobi matrix for a move of the coordinate system by the given vector.

Private Attributes
double	m_tanLambda
	Memory for the tan lambda parameter.

double	m_z0
	Memory for the z0 parameter.

Detailed Description

A line in the sz space.

The line is represented in sz parameters tan lambda and z0 beginning the slope and the intercept of the line in the sz space.

Definition at line 28 of file SZLine.h.

Constructor & Destructor Documentation

◆ SZLine() [1/3]

SZLine ( )

inline

Default constructor for ROOT compatibility.

Definition at line 32 of file SZLine.h.

        : m_tanLambda(NAN)
        , m_z0(NAN)
      {
      }

◆ SZLine() [2/3]

SZLine	(	double	tanLambda,
		double	z0 )

inline

Constructor from slope and intercept in the sz space.

Definition at line 39 of file SZLine.h.

        : m_tanLambda(tanLambda)
        , m_z0(z0)
      {
      }

◆ SZLine() [3/3]

SZLine ( const SZParameters & szParameters )

inlineexplicit

Constructor from the sz parameters.

Definition at line 46 of file SZLine.h.

        : m_tanLambda(szParameters(ESZParameter::c_TanL))
        , m_z0(szParameters(ESZParameter::c_Z0))
      {
      }

Member Function Documentation

◆ distance() [1/2]

double distance ( const ROOT::Math::XYVector & szPoint ) const

inline

Calculates the signed distance of the point to the line.

Returns the signed distance of the point to the line. The sign is positive
below the curve and negative above it.

Definition at line 167 of file SZLine.h.

      {
        return distance(szPoint.X(), szPoint.Y());
      }

◆ distance() [2/2]

double distance	(	double	s,
		double	z ) const

inline

Calculates the signed distance of the point given by its to coordinates to the line.

Returns the signed distance of the point to the line. The sign is positive
below the curve and negative above it.

Definition at line 177 of file SZLine.h.

      {
        return (map(s) - z) / hypot2(1, tanLambda());
      }

◆ intercept()

double intercept ( ) const

inline

Getter for the intercept in the sz space which is equivalent to z0.

Definition at line 90 of file SZLine.h.

      {
        return m_z0;
      }

◆ intersection()

ROOT::Math::XYVector intersection ( const SZLine & szLine ) const

Calculates the intersection point of two line. Infinity for parallels.

Definition at line 14 of file SZLine.cc.

{
  const double s = -(z0() - szLine.z0()) / (tanLambda() - szLine.tanLambda());
  return ROOT::Math::XYVector(s, map(s));
}

◆ invalidate()

void invalidate ( )

inline

Sets the parameters to a invalid representation.

Definition at line 137 of file SZLine.h.

      {
        setZ0(NAN);
        setTanLambda(NAN);
      }

◆ inverseMap()

double inverseMap ( double z ) const

inline

Maps the z coordinate to the two dimensional arc length s.

Definition at line 130 of file SZLine.h.

      {
        return (z - z0()) / tanLambda();
      }

◆ inverseSlope()

double inverseSlope ( ) const

inline

Returns the slope over the second coordinate.

Definition at line 66 of file SZLine.h.

      {
        return 1 / tanLambda();
      }

◆ isInvalid()

bool isInvalid ( ) const

inline

Indicates if the line parameters do not represent a valid line.

Definition at line 144 of file SZLine.h.

      {
        return not std::isfinite(tanLambda()) or not std::isfinite(z0());
      }

◆ map()

double map ( double s ) const

inline

Maps the two dimensional arc length s to z.

Definition at line 118 of file SZLine.h.

      {
        return tanLambda() * s + z0();
      }

◆ operator()()

double operator() ( double s ) const

inline

Maps the two dimensional arc length s to z.

Definition at line 124 of file SZLine.h.

      {
        return map(s);
      }

◆ passiveMoveBy() [1/2]

void passiveMoveBy ( const ROOT::Math::XYVector & bySZ )

inline

Passively move the coordinate system in place by the given sz vector.

Definition at line 186 of file SZLine.h.

      {
        passiveMoveBy(bySZ.X(), bySZ.Y());
      }

◆ passiveMoveBy() [2/2]

void passiveMoveBy	(	double	s,
		double	z )

inline

Passively move the coordinate system in place by the given s and z coordinates.

Definition at line 192 of file SZLine.h.

      {
        m_z0 = map(s) - z;
      }

◆ passiveMoveByJacobian()

static SZJacobian passiveMoveByJacobian ( const ROOT::Math::XYVector & bySZ )

inlinestatic

Computes the Jacobi matrix for a move of the coordinate system by the given vector.

Definition at line 210 of file SZLine.h.

      {
        using namespace NSZParameterIndices;
        SZJacobian result = SZUtil::identity();
        result(c_Z0, c_TanL) = bySZ.X();
        return result;
      }

◆ passiveMovedBy() [1/2]

SZLine passiveMovedBy ( const ROOT::Math::XYVector & bySZ ) const

inline

Return a line passively move by the given vector as a copy.

Definition at line 198 of file SZLine.h.

      {
        return passiveMovedBy(bySZ.X(), bySZ.Y());
      }

◆ passiveMovedBy() [2/2]

SZLine passiveMovedBy	(	double	s,
		double	z ) const

inline

Return a line passively move by the given s and z coordinates as a copy.

Definition at line 204 of file SZLine.h.

      {
        return SZLine(tanLambda(), map(s) - z);
      }

◆ reverse()

void reverse ( )

inline

Reverse the arc length direction in place.

Definition at line 150 of file SZLine.h.

      {
        m_tanLambda = -m_tanLambda;
      }

◆ reversed()

SZLine reversed ( ) const

inline

Returns a copy of the line with reversed the arc length direction.

Definition at line 156 of file SZLine.h.

      {
        return SZLine(-tanLambda(), z0());
      }

◆ setTanLambda()

void setTanLambda ( double tanLambda )

inline

Getter for the tan lambda parameter.

Definition at line 78 of file SZLine.h.

      {
        m_tanLambda = tanLambda;
      }

◆ setZ0()

void setZ0 ( double z0 )

inline

Getter for the z0 parameter.

Definition at line 96 of file SZLine.h.

      {
        m_z0 = z0;
      }

◆ slope()

double slope ( ) const

inline

Getter for the slope in the sz space which is equivalent to tan lambda.

Definition at line 60 of file SZLine.h.

      {
        return m_tanLambda;
      }

◆ szParameters()

SZParameters szParameters ( ) const

inline

Getter for the sz parameters.

Definition at line 102 of file SZLine.h.

      {
        using namespace NSZParameterIndices;
        SZParameters result;
        result(c_TanL) = tanLambda();
        result(c_Z0) = z0();
        return result;
      }

◆ tanLambda()

double tanLambda ( ) const

inline

Getter for the tan lambda parameter.

Definition at line 54 of file SZLine.h.

      {
        return m_tanLambda;
      }

◆ theta()

double theta ( ) const

inline

Getter for the theta dip angle.

Definition at line 72 of file SZLine.h.

      {
        return m_tanLambda;
      }

◆ z0()

double z0 ( ) const

inline

Getter for the z0 parameter.

Definition at line 84 of file SZLine.h.

      {
        return m_z0;
      }

◆ zero()

double zero ( ) const

inline

Returns the the two dimensional arc length s where the z coordinate approaches zero.

Definition at line 112 of file SZLine.h.

      {
        return -intercept() / slope();
      }

Member Data Documentation

◆ m_tanLambda

double m_tanLambda

private

Memory for the tan lambda parameter.

Definition at line 220 of file SZLine.h.

◆ m_z0

double m_z0

private

Memory for the z0 parameter.

Definition at line 223 of file SZLine.h.

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

tracking/trackingUtilities/geometry/include/SZLine.h
tracking/trackingUtilities/geometry/src/SZLine.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SZLine() [1/3]

◆ SZLine() [2/3]

◆ SZLine() [3/3]

Member Function Documentation

◆ distance() [1/2]

◆ distance() [2/2]

◆ intercept()

◆ intersection()

◆ invalidate()

◆ inverseMap()

◆ inverseSlope()

◆ isInvalid()

◆ map()

◆ operator()()

◆ passiveMoveBy() [1/2]

◆ passiveMoveBy() [2/2]

◆ passiveMoveByJacobian()

◆ passiveMovedBy() [1/2]

◆ passiveMovedBy() [2/2]

◆ reverse()

◆ reversed()

◆ setTanLambda()

◆ setZ0()

◆ slope()

◆ szParameters()

◆ tanLambda()

◆ theta()

◆ z0()

◆ zero()

Member Data Documentation

◆ m_tanLambda

◆ m_z0