itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension > Class Template Reference

Implementation of an image as spatial object. More...

#include <itkImageSpatialObject.h>

Inheritance diagram for itk::ImageSpatialObject:

[legend]Collaboration diagram for itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >:

[legend]List of all members.

Public Types
typedef double	ScalarType
typedef ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >	Self
typedef SpatialObject< NDimensions, TransformType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Image< PixelType, NDimensions >	ImageType
typedef ImageType::Pointer	ImagePointer
typedef ImageType::IndexType	IndexType
typedef ImageType::RegionType	RegionType
typedef Superclass::PointType	PointType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef PointContainerType::Pointer	PointContainerPointer
Public Methods
virtual const char *	GetClassName () const
void	SetImage (ImageType *image)
ImageType *	GetImage (void)
bool	IsEvaluableAt (const PointType &point)
void	ValueAt (const PointType &point, double &value)
bool	IsInside (const PointType &point)
void	ComputeBounds (void)
unsigned long	GetMTime (void) const
void	SetSlicePosition (unsigned int dimension, int position)
int	GetSlicePosition (unsigned int dimension)
Static Public Methods
Pointer	New ()
Protected Methods
	ImageSpatialObject ()
virtual	~ImageSpatialObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
ImagePointer	m_Image
int *	m_SlicePosition

---

Detailed Description

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3>
class itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >

Implementation of an image as spatial object.

This class combines functionnalities from a spatial object, and an image.

\also SpatialObject CompositeSpatialObject

Definition at line 44 of file itkImageSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef Superclass::BoundingBoxType itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 62 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef SmartPointer< const Self > itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ConstPointer

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 54 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef ImageType::Pointer itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ImagePointer

Definition at line 57 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef Image< PixelType, NDimensions > itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ImageType

Definition at line 56 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef ImageType::IndexType itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::IndexType

Index typedef support. An index is used to access pixel values. Reimplemented from itk::NDimensionalSpatialObject< PipelineDimension >. Definition at line 58 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef PointContainerType::Pointer itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::PointContainerPointer

Definition at line 65 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef VectorContainer< unsigned long, PointType> itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::PointContainerType

Definition at line 64 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef SmartPointer< Self > itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::Pointer

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 53 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef Superclass::PointType itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::PointType

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 61 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef ImageType::RegionType itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::RegionType

Reimplemented from itk::NDimensionalSpatialObject< PipelineDimension >. Definition at line 59 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef double itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ScalarType

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 50 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef ImageSpatialObject< NDimensions, TransformType, PixelType , PipelineDimension > itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::Self

Standard class typedefs. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 51 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> typedef SpatialObject< NDimensions, TransformType > itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::Superclass

Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >. Definition at line 52 of file itkImageSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ImageSpatialObject (    )  [protected]

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> virtual itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::~ImageSpatialObject (    )  [protected, virtual]

---

Member Function Documentation

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> void itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ComputeBounds (  void    )  [virtual]

Compute the boundaries of the iamge spatial object. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> virtual const char* itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> ImageType* itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::GetImage (  void    )

Get a pointer to the image currently attached to the object.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> unsigned long itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::GetMTime (  void    )  const [virtual]

Returns the latest modified time of the object, and all of its component. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> int itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::GetSlicePosition (  unsigned int    dimension )  [inline]

Get the slice position Definition at line 101 of file itkImageSpatialObject.h. References itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::m_SlicePosition.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> bool itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::IsEvaluableAt (  const PointType &    point )  [virtual]

Return true if the object is evaluable at the requested point, and else otherwise. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> bool itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::IsInside (  const PointType &    point )  [virtual]

Returns true if the point is inside, false otherwise. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> Pointer itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> void itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> void itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::SetImage (  ImageType *    image )

Set the image.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> void itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::SetSlicePosition (  unsigned int    dimension, int    position )  [inline]

Set the slice position Definition at line 98 of file itkImageSpatialObject.h. References itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::m_SlicePosition.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> void itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::ValueAt (  const PointType &    point, double &    value )  [virtual]

Returns the value of the image at the requested point. If the point is not inside the object, then an exception is thrown. \also ExceptionObject Reimplemented from itk::SpatialObject< NDimensions, TransformType, PipelineDimension >.

---

Member Data Documentation

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> ImagePointer itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::m_Image [protected]

Definition at line 105 of file itkImageSpatialObject.h.

template<unsigned int NDimensions = 3, class TransformType = AffineTransform< double, NDimensions>, class PixelType = RGBPixel< char >, unsigned int PipelineDimension = 3> int* itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::m_SlicePosition [protected]

Definition at line 112 of file itkImageSpatialObject.h. Referenced by itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::GetSlicePosition(), and itk::ImageSpatialObject< NDimensions, TransformType, PixelType, PipelineDimension >::SetSlicePosition().

---

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

• itkImageSpatialObject.h

---