mitk::Line< TCoordRep, NPointDimension > Class Template Reference

Describes a line in N-dimensional space. More...

#include <mitkLine.h>

Public Member Functions
	Line ()
	Line (const itk::Point< TCoordRep, NPointDimension > &point, const itk::Vector< TCoordRep, NPointDimension > &direction)
	Define line by point and direction. More...
const itk::Point< TCoordRep, NPointDimension > &	GetPoint () const
	Get start point of the line (const). More...
itk::Point< TCoordRep, NPointDimension > &	GetPoint ()
	Get start point of the line (non-const). More...
const itk::Point< TCoordRep, NPointDimension >	GetPoint (TCoordRep t) const
	Get point on the line at parameter t. More...
void	SetPoint (const itk::Point< TCoordRep, NPointDimension > &point1)
	Set/change start point of the line. More...
const itk::Vector< TCoordRep, NPointDimension > &	GetDirection () const
	Get the direction vector of the line (const). More...
itk::Vector< TCoordRep, NPointDimension > &	GetDirection ()
	Get the direction vector of the line (non-const). More...
void	SetDirection (const itk::Vector< TCoordRep, NPointDimension > &direction)
	Set the direction vector of the line. More...
void	Set (const itk::Point< TCoordRep, NPointDimension > &point, const itk::Vector< TCoordRep, NPointDimension > &direction)
	Define line by point and direction. More...
void	SetPoints (const itk::Point< TCoordRep, NPointDimension > &point1, const itk::Point< TCoordRep, NPointDimension > &point2)
	Define line by two points. More...
void	SetPoint1 (const itk::Point< TCoordRep, NPointDimension > &point1)
	Set/change start point of the line. More...
const itk::Point< TCoordRep, NPointDimension > &	GetPoint1 () const
	Get start point of the line. More...
void	SetPoint2 (const itk::Point< TCoordRep, NPointDimension > &point2)
	Set/change end point of the line. More...
itk::Point< TCoordRep, NPointDimension >	GetPoint2 () const
	Get end point of the line. More...
void	Transform (itk::Transform< TCoordRep, NPointDimension, NPointDimension > &transform)
	Transform the line with an ITK Transform. More...
void	Transform (const itk::Matrix< TCoordRep, NPointDimension, NPointDimension > &matrix)
	Transform the line with a matrix. More...
double	Distance (const itk::Point< TCoordRep, NPointDimension > &point) const
	Compute the distance of a point from the line. More...
itk::Point< TCoordRep, NPointDimension >	Project (const itk::Point< TCoordRep, NPointDimension > &point) const
	Project a point onto the line. More...
bool	IsPartOfStraightLine (const itk::Point< TCoordRep, NPointDimension > &point) const
	Test if a point is part of the line segment. More...
bool	IsPartOfLine (const itk::Point< TCoordRep, NPointDimension > &point) const
	Test if a point is part of the line (line having infinite length). More...
bool	IsParallel (const Line< TCoordRep, NPointDimension > &line) const
	Test if a line is parallel to this line. More...
bool	IsPartOfLine (const Line< TCoordRep, NPointDimension > &line) const
	Test if another line is part of this line (line having infinite length). More...
bool	operator== (const Line< TCoordRep, NPointDimension > &line) const
	Test if the two lines are identical. More...
const Line< TCoordRep, NPointDimension > &	operator= (const Line< TCoordRep, NPointDimension > &line)
	Set the line by another line (copy assignment). More...
bool	operator!= (const Line< TCoordRep, NPointDimension > &line) const
	Test if two lines are not identical. More...

Static Public Member Functions
static int	RectangleLineIntersection (TCoordRep x1, TCoordRep y1, TCoordRep x2, TCoordRep y2, itk::Point< TCoordRep, 2 > p, itk::Vector< TCoordRep, 2 > d, itk::Point< TCoordRep, 2 > &s1, itk::Point< TCoordRep, 2 > &s2)
	Calculates the intersection points of a straight line in 2D with a rectangle. More...
static int	BoxLineIntersection (TCoordRep x1, TCoordRep y1, TCoordRep z1, TCoordRep x2, TCoordRep y2, TCoordRep z2, itk::Point< TCoordRep, 3 > p, itk::Vector< TCoordRep, 3 > d, itk::Point< TCoordRep, 3 > &s1, itk::Point< TCoordRep, 3 > &s2)
	Calculates the intersection points of a straight line in 3D with a box. More...

Protected Attributes
itk::Point< TCoordRep, NPointDimension >	m_Point
itk::Vector< TCoordRep, NPointDimension >	m_Direction

Detailed Description

template<class TCoordRep, unsigned int NPointDimension = 3>
class mitk::Line< TCoordRep, NPointDimension >

Describes a line in N-dimensional space.

A line is defined by a start point and a direction vector. The length of the direction vector defines the length of the line segment for methods like IsPartOfStraightLine().

Template Parameters

TCoordRep	The coordinate representation type.
NPointDimension	The dimensionality of the space (default is 3).

Definition at line 36 of file mitkLine.h.

Constructor & Destructor Documentation

Line() [1/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

mitk::Line< TCoordRep, NPointDimension >::Line ( )

inline

Definition at line 39 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Line() [2/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

mitk::Line< TCoordRep, NPointDimension >::Line ( const itk::Point< TCoordRep, NPointDimension > &  point, const itk::Vector< TCoordRep, NPointDimension > &  direction  )

inline

Define line by point and direction.

Length of direction defines the length of the line.

Parameters

point	Start point of the line.
direction	Direction vector of the line.

Definition at line 52 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Member Function Documentation

BoxLineIntersection()

template<class TCoordRep , unsigned int NPointDimension = 3>

static int mitk::Line< TCoordRep, NPointDimension >::BoxLineIntersection ( TCoordRep  x1, TCoordRep  y1, TCoordRep  z1, TCoordRep  x2, TCoordRep  y2, TCoordRep  z2, itk::Point< TCoordRep, 3 >  p, itk::Vector< TCoordRep, 3 >  d, itk::Point< TCoordRep, 3 > &  s1, itk::Point< TCoordRep, 3 > &  s2  )

inlinestatic

Calculates the intersection points of a straight line in 3D with a box.

Parameters

x1,y1,z1	first corner of the box
x2,y2,z2	second corner of the box
p,d	straight line: p point on it, d direction of line
s1	first intersection point (valid only if s_num>0)
s2	second intersection point (valid only if s_num==2)

Returns

number of intersection points (0<=s_num<=2)

Definition at line 427 of file mitkLine.h.

References mitk::eps.

Distance()

template<class TCoordRep , unsigned int NPointDimension = 3>

double mitk::Line< TCoordRep, NPointDimension >::Distance ( const itk::Point< TCoordRep, NPointDimension > &  point ) const

inline

Compute the distance of a point from the line.

Parameters

point

The point to compute the distance for.

Returns

The perpendicular distance from the point to the line.

Definition at line 191 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::Project().

Referenced by mitk::Line< TCoordRep, NPointDimension >::IsPartOfLine(), and mitk::Line< TCoordRep, NPointDimension >::IsPartOfStraightLine().

GetDirection() [1/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Vector<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::GetDirection ( )

inline

Get the direction vector of the line (non-const).

Definition at line 90 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction.

GetDirection() [2/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

const itk::Vector<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::GetDirection ( ) const

inline

Get the direction vector of the line (const).

Definition at line 87 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction.

Referenced by mitk::Line< TCoordRep, NPointDimension >::IsParallel(), and mitk::Line< TCoordRep, NPointDimension >::operator=().

GetPoint() [1/3]

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Point<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::GetPoint ( )

inline

Get start point of the line (non-const).

Definition at line 62 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Point.

GetPoint() [2/3]

template<class TCoordRep , unsigned int NPointDimension = 3>

const itk::Point<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::GetPoint ( ) const

inline

Get start point of the line (const).

Definition at line 59 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Point.

Referenced by mitk::Line< TCoordRep, NPointDimension >::IsPartOfLine(), and mitk::Line< TCoordRep, NPointDimension >::operator=().

GetPoint() [3/3]

template<class TCoordRep , unsigned int NPointDimension = 3>

const itk::Point<TCoordRep, NPointDimension> mitk::Line< TCoordRep, NPointDimension >::GetPoint ( TCoordRep  t ) const

inline

Get point on the line at parameter t.

Parameters

t	Parameter along the line direction.

Returns

m_Point + t * m_Direction

Definition at line 69 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

GetPoint1()

template<class TCoordRep , unsigned int NPointDimension = 3>

const itk::Point<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::GetPoint1 ( ) const

inline

Get start point of the line.

Definition at line 142 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Point.

Referenced by mitk::Line< TCoordRep, NPointDimension >::operator==().

GetPoint2()

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Point<TCoordRep, NPointDimension> mitk::Line< TCoordRep, NPointDimension >::GetPoint2 ( ) const

inline

Get end point of the line.

Returns

The point at m_Point + m_Direction.

Definition at line 156 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Referenced by mitk::Line< TCoordRep, NPointDimension >::operator==().

IsParallel()

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::IsParallel ( const Line< TCoordRep, NPointDimension > &  line ) const

inline

Test if a line is parallel to this line.

Uses the cross product of direction vectors (3D only).

Parameters

line	The other line to compare.

Returns

True if the lines are parallel, false otherwise.

Definition at line 266 of file mitkLine.h.

References mitk::eps, mitk::Line< TCoordRep, NPointDimension >::GetDirection(), and mitk::Line< TCoordRep, NPointDimension >::m_Direction.

Referenced by mitk::Line< TCoordRep, NPointDimension >::IsPartOfLine().

IsPartOfLine() [1/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::IsPartOfLine ( const itk::Point< TCoordRep, NPointDimension > &  point ) const

inline

Test if a point is part of the line (line having infinite length).

Parameters

point

The point to test.

Returns

True if the point lies on the infinite line, false otherwise.

Definition at line 251 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::Distance(), and mitk::eps.

IsPartOfLine() [2/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::IsPartOfLine ( const Line< TCoordRep, NPointDimension > &  line ) const

inline

Test if another line is part of this line (line having infinite length).

The other line must be parallel and share a common point.

Parameters

line	The other line to test.

Returns

True if the other line lies on this infinite line, false otherwise.

Definition at line 285 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::Distance(), mitk::Line< TCoordRep, NPointDimension >::GetPoint(), and mitk::Line< TCoordRep, NPointDimension >::IsParallel().

IsPartOfStraightLine()

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::IsPartOfStraightLine ( const itk::Point< TCoordRep, NPointDimension > &  point ) const

inline

Test if a point is part of the line segment.

The length of the direction vector defines the length of the line segment. The point must lie on the line and within the segment bounds.

Parameters

point

The point to test.

Returns

True if the point is on the line segment, false otherwise.

Definition at line 229 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::Distance(), mitk::eps, mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

operator!=()

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::operator!= ( const Line< TCoordRep, NPointDimension > &  line ) const

inline

Test if two lines are not identical.

See also

operator==

Definition at line 326 of file mitkLine.h.

operator=()

template<class TCoordRep , unsigned int NPointDimension = 3>

const Line<TCoordRep, NPointDimension>& mitk::Line< TCoordRep, NPointDimension >::operator= ( const Line< TCoordRep, NPointDimension > &  line )

inline

Set the line by another line (copy assignment).

Parameters

line	The line to copy from.

Returns

Reference to this line.

Definition at line 315 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::GetDirection(), mitk::Line< TCoordRep, NPointDimension >::GetPoint(), mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

operator==()

template<class TCoordRep , unsigned int NPointDimension = 3>

bool mitk::Line< TCoordRep, NPointDimension >::operator== ( const Line< TCoordRep, NPointDimension > &  line ) const

inline

Test if the two lines are identical.

Start point and direction and length of direction vector must be equal for identical lines.

Parameters

line	The other line to compare.

Returns

True if both lines are identical, false otherwise.

Definition at line 298 of file mitkLine.h.

References mitk::eps, mitk::Line< TCoordRep, NPointDimension >::GetPoint1(), and mitk::Line< TCoordRep, NPointDimension >::GetPoint2().

Project()

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Point<TCoordRep, NPointDimension> mitk::Line< TCoordRep, NPointDimension >::Project ( const itk::Point< TCoordRep, NPointDimension > &  point ) const

inline

Project a point onto the line.

If the direction vector has zero norm, the start point is returned.

Parameters

point

The point to project.

Returns

The projected point on the line.

Definition at line 205 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Referenced by mitk::Line< TCoordRep, NPointDimension >::Distance().

RectangleLineIntersection()

template<class TCoordRep , unsigned int NPointDimension = 3>

static int mitk::Line< TCoordRep, NPointDimension >::RectangleLineIntersection ( TCoordRep  x1, TCoordRep  y1, TCoordRep  x2, TCoordRep  y2, itk::Point< TCoordRep, 2 >  p, itk::Vector< TCoordRep, 2 >  d, itk::Point< TCoordRep, 2 > &  s1, itk::Point< TCoordRep, 2 > &  s2  )

inlinestatic

Calculates the intersection points of a straight line in 2D with a rectangle.

Parameters

x1	Left boundary of the rectangle.
y1	Bottom boundary of the rectangle.
x2	Right boundary of the rectangle.
y2	Top boundary of the rectangle.
p	A point on the straight line.
d	Direction vector of the straight line.
s1	First intersection point (valid only if return value > 0).
s2	Second intersection point (valid only if return value == 2).

Returns

Number of intersection points (0 <= return value <= 2).

Definition at line 341 of file mitkLine.h.

References mitk::eps.

Set()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::Set ( const itk::Point< TCoordRep, NPointDimension > &  point, const itk::Vector< TCoordRep, NPointDimension > &  direction  )

inline

Define line by point and direction.

Length of direction defines the length of the line.

Parameters

point	Start point of the line.
direction	Direction vector of the line.

Definition at line 105 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

SetDirection()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::SetDirection ( const itk::Vector< TCoordRep, NPointDimension > &  direction )

inline

Set the direction vector of the line.

Parameters

direction

New direction vector.

Definition at line 96 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction.

SetPoint()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::SetPoint ( const itk::Point< TCoordRep, NPointDimension > &  point1 )

inline

Set/change start point of the line.

The end point of the line is preserved, so the direction vector is recomputed accordingly.

Parameters

point1

New start point.

Definition at line 78 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

SetPoint1()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::SetPoint1 ( const itk::Point< TCoordRep, NPointDimension > &  point1 )

inline

Set/change start point of the line.

The end point of the line is preserved, so the direction vector is recomputed accordingly.

Parameters

point1

New start point.

Definition at line 132 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

SetPoint2()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::SetPoint2 ( const itk::Point< TCoordRep, NPointDimension > &  point2 )

inline

Set/change end point of the line.

The start point is preserved, so the direction vector is recomputed.

Parameters

point2

New end point.

Definition at line 150 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

SetPoints()

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::SetPoints ( const itk::Point< TCoordRep, NPointDimension > &  point1, const itk::Point< TCoordRep, NPointDimension > &  point2  )

inline

Define line by two points.

Parameters

point1	Start point of the line.
point2	End point of the line.

Definition at line 117 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Transform() [1/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::Transform ( const itk::Matrix< TCoordRep, NPointDimension, NPointDimension > &  matrix )

inline

Transform the line with a matrix.

Only the direction will be changed, not the start point.

Parameters

matrix

The transformation matrix to apply.

Definition at line 181 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction.

Transform() [2/2]

template<class TCoordRep , unsigned int NPointDimension = 3>

void mitk::Line< TCoordRep, NPointDimension >::Transform ( itk::Transform< TCoordRep, NPointDimension, NPointDimension > &  transform )

inline

Transform the line with an ITK Transform.

Both the start point and the direction vector are transformed.

Parameters

transform

The ITK transform to apply.

Definition at line 169 of file mitkLine.h.

References mitk::Line< TCoordRep, NPointDimension >::m_Direction, and mitk::Line< TCoordRep, NPointDimension >::m_Point.

Member Data Documentation

m_Direction

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Vector<TCoordRep, NPointDimension> mitk::Line< TCoordRep, NPointDimension >::m_Direction

protected

Definition at line 487 of file mitkLine.h.

Referenced by mitk::Line< TCoordRep, NPointDimension >::GetDirection(), mitk::Line< TCoordRep, NPointDimension >::GetPoint(), mitk::Line< TCoordRep, NPointDimension >::GetPoint2(), mitk::Line< TCoordRep, NPointDimension >::IsParallel(), mitk::Line< TCoordRep, NPointDimension >::IsPartOfStraightLine(), mitk::Line< TCoordRep, NPointDimension >::Line(), mitk::Line< TCoordRep, NPointDimension >::operator=(), mitk::Line< TCoordRep, NPointDimension >::Project(), mitk::Line< TCoordRep, NPointDimension >::Set(), mitk::Line< TCoordRep, NPointDimension >::SetDirection(), mitk::Line< TCoordRep, NPointDimension >::SetPoint(), mitk::Line< TCoordRep, NPointDimension >::SetPoint1(), mitk::Line< TCoordRep, NPointDimension >::SetPoint2(), mitk::Line< TCoordRep, NPointDimension >::SetPoints(), and mitk::Line< TCoordRep, NPointDimension >::Transform().

m_Point

template<class TCoordRep , unsigned int NPointDimension = 3>

itk::Point<TCoordRep, NPointDimension> mitk::Line< TCoordRep, NPointDimension >::m_Point

protected

Definition at line 486 of file mitkLine.h.

Referenced by mitk::Line< TCoordRep, NPointDimension >::GetPoint(), mitk::Line< TCoordRep, NPointDimension >::GetPoint1(), mitk::Line< TCoordRep, NPointDimension >::GetPoint2(), mitk::Line< TCoordRep, NPointDimension >::IsPartOfStraightLine(), mitk::Line< TCoordRep, NPointDimension >::Line(), mitk::Line< TCoordRep, NPointDimension >::operator=(), mitk::Line< TCoordRep, NPointDimension >::Project(), mitk::Line< TCoordRep, NPointDimension >::Set(), mitk::Line< TCoordRep, NPointDimension >::SetPoint(), mitk::Line< TCoordRep, NPointDimension >::SetPoint1(), mitk::Line< TCoordRep, NPointDimension >::SetPoint2(), mitk::Line< TCoordRep, NPointDimension >::SetPoints(), and mitk::Line< TCoordRep, NPointDimension >::Transform().

---

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

• mitkLine.h