itk::ArrowSpatialObject< TDimension > Class Template Reference

Representation of a Arrow based on the spatial object classes. More...

#include <itkArrowSpatialObject.h>

Inheritance diagram for itk::ArrowSpatialObject< TDimension >:

[legend]Collaboration diagram for itk::ArrowSpatialObject< TDimension >:

[legend]List of all members.

Public Types
typedef ArrowSpatialObject	Self
typedef SpatialObject< TDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef double	ScalarType
typedef Vector< double, TDimension >	VectorType
typedef Point< double, TDimension >	PointType
typedef Superclass::TransformType	TransformType
typedef TransformType::MatrixType	MatrixType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual PointType	GetPosition () const
void	SetPosition (float x, float y)
void	SetPosition (float x, float y, float z)
virtual VectorType	GetDirection () const
void	SetDirection (float x, float y)
void	SetDirection (float x, float y, float z)
virtual double	GetLength ()
double	GetLenght ()
bool	ComputeLocalBoundingBox () const
bool	IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool	IsInside (const PointType &point) const
void	SetPosition (const PointType &p)
void	SetDirection (const VectorType &d)
void	SetLength (double length)
void	SetLenght (double length)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ArrowSpatialObject ()
virtual	~ArrowSpatialObject ()
void	UpdateTransform ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<unsigned int TDimension = 3>
class itk::ArrowSpatialObject< TDimension >

Representation of a Arrow based on the spatial object classes.

A ArrowSpatialObject represents a Arrow by serving as the parent of the elements of the Arrow. Since any itk::SpatialObject can have children (see SpatialObject::GetChildren()), this class needs no additional methods.

Definition at line 40 of file itkArrowSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3> typedef SmartPointer< const Self > itk::ArrowSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 49 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef TransformType::MatrixType itk::ArrowSpatialObject< TDimension >::MatrixType

Definition at line 54 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef SmartPointer< Self > itk::ArrowSpatialObject< TDimension >::Pointer

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 48 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef Point<double,TDimension> itk::ArrowSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 52 of file itkArrowSpatialObject.h. Referenced by itk::ArrowSpatialObject< TDimension >::GetLenght(), and itk::ArrowSpatialObject< TDimension >::SetPosition().

template<unsigned int TDimension = 3> typedef double itk::ArrowSpatialObject< TDimension >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 50 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef ArrowSpatialObject itk::ArrowSpatialObject< TDimension >::Self

Standard class typedefs. Reimplemented from itk::SpatialObject< TDimension >. Definition at line 46 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef SpatialObject< TDimension > itk::ArrowSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 47 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef Superclass::TransformType itk::ArrowSpatialObject< TDimension >::TransformType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 53 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> typedef Vector<double,TDimension> itk::ArrowSpatialObject< TDimension >::VectorType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 51 of file itkArrowSpatialObject.h. Referenced by itk::ArrowSpatialObject< TDimension >::GetLenght().

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3> itk::ArrowSpatialObject< TDimension >::ArrowSpatialObject (   )  [protected]

template<unsigned int TDimension = 3> virtual itk::ArrowSpatialObject< TDimension >::~ArrowSpatialObject (   )  [protected, virtual]

---

Member Function Documentation

template<unsigned int TDimension = 3> bool itk::ArrowSpatialObject< TDimension >::ComputeLocalBoundingBox (   )  const [virtual]

Compute the local bounding box Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual VectorType itk::ArrowSpatialObject< TDimension >::GetDirection (   )  const [virtual]

template<unsigned int TDimension = 3> double itk::ArrowSpatialObject< TDimension >::GetLenght (   )  [inline]

Get the length of the arrow. NOTE the misspelling of length. This method is included for backward compatibility. Definition at line 124 of file itkArrowSpatialObject.h. References itk::ArrowSpatialObject< TDimension >::PointType, and itk::ArrowSpatialObject< TDimension >::VectorType.

template<unsigned int TDimension = 3> virtual double itk::ArrowSpatialObject< TDimension >::GetLength (   )  [virtual]

Get the length of the arrow

template<unsigned int TDimension = 3> virtual const char* itk::ArrowSpatialObject< TDimension >::GetNameOfClass (   )  const [virtual]

Method for creation through the object factory. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual PointType itk::ArrowSpatialObject< TDimension >::GetPosition (   )  const [virtual]

template<unsigned int TDimension = 3> virtual bool itk::ArrowSpatialObject< TDimension >::IsInside (  const PointType &  point  )  const [virtual]

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

template<unsigned int TDimension = 3> bool itk::ArrowSpatialObject< TDimension >::IsInside (  const PointType &  point, unsigned int  depth, char *  name )  const [virtual]

Returns true if the point is inside the line, false otherwise. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> Pointer itk::ArrowSpatialObject< TDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual void itk::ArrowSpatialObject< TDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Method to print the object. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetDirection (  float  x, float  y, float  z )  [inline]

Definition at line 106 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetDirection (  float  x, float  y )  [inline]

Definition at line 99 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetDirection (  const VectorType &  d  )  [inline]

Set the direction of the arrow Definition at line 90 of file itkArrowSpatialObject.h. References itk::ArrowSpatialObject< TDimension >::UpdateTransform().

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetLenght (  double  length  )  [inline]

Set the length of the arrow Definition at line 116 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetLength (  double  length  )

Set the length of the arrow

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetPosition (  float  x, float  y, float  z )  [inline]

Definition at line 81 of file itkArrowSpatialObject.h. References itk::ArrowSpatialObject< TDimension >::UpdateTransform().

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetPosition (  float  x, float  y )  [inline]

Definition at line 74 of file itkArrowSpatialObject.h. References itk::ArrowSpatialObject< TDimension >::UpdateTransform().

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::SetPosition (  const PointType &  p  )  [inline]

Set the position of the arrow Definition at line 65 of file itkArrowSpatialObject.h. References itk::ArrowSpatialObject< TDimension >::PointType, and itk::ArrowSpatialObject< TDimension >::UpdateTransform().

template<unsigned int TDimension = 3> void itk::ArrowSpatialObject< TDimension >::UpdateTransform (   )  [protected]

Update the transformation given the position and the direction Referenced by itk::ArrowSpatialObject< TDimension >::SetDirection(), and itk::ArrowSpatialObject< TDimension >::SetPosition().

---

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

• itkArrowSpatialObject.h

---