itk::ImageSpatialObject< TDimension, TPixelType > Class Template Reference

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

#include <itkImageSpatialObject.h>

Inheritance diagram for itk::ImageSpatialObject< TDimension, TPixelType >:

[legend]Collaboration diagram for itk::ImageSpatialObject< TDimension, TPixelType >:

[legend]List of all members.

Public Types
typedef double	ScalarType
typedef ImageSpatialObject< TDimension, TPixelType >	Self
typedef SpatialObject< TDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TPixelType	PixelType
typedef Image< PixelType, TDimension >	ImageType
typedef ImageType::ConstPointer	ImagePointer
typedef ImageType::IndexType	IndexType
typedef ImageType::RegionType	RegionType
typedef Superclass::TransformType	TransformType
typedef Superclass::PointType	PointType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef PointContainerType::Pointer	PointContainerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetImage (const ImageType *image)
const ImageType *	GetImage (void) const
bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
bool	IsInside (const PointType &point, unsigned int depth, char *name) const
bool	IsInside (const PointType &point) const
bool	ComputeLocalBoundingBox () const
unsigned long	GetMTime (void) const
void	SetSlicePosition (unsigned int dimension, int position)
int	GetSlicePosition (unsigned int dimension)
const char *	GetPixelType ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageSpatialObject ()
virtual	~ImageSpatialObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
ImagePointer	m_Image
int *	m_SlicePosition
std::string	m_PixelType

---

Detailed Description

template<unsigned int TDimension = 3, class TPixelType = unsigned char>
class itk::ImageSpatialObject< TDimension, TPixelType >

Implementation of an image as spatial object.

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

See also:

SpatialObject CompositeSpatialObject

Definition at line 40 of file itkImageSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef Superclass::BoundingBoxType itk::ImageSpatialObject< TDimension, TPixelType >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 59 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef SmartPointer< const Self > itk::ImageSpatialObject< TDimension, TPixelType >::ConstPointer

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef ImageType::ConstPointer itk::ImageSpatialObject< TDimension, TPixelType >::ImagePointer

Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 54 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef Image< PixelType, TDimension > itk::ImageSpatialObject< TDimension, TPixelType >::ImageType

Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 53 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef ImageType::IndexType itk::ImageSpatialObject< TDimension, TPixelType >::IndexType

Index typedef support. An index is used to access pixel values. Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 55 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef TPixelType itk::ImageSpatialObject< TDimension, TPixelType >::PixelType

Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 52 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef PointContainerType::Pointer itk::ImageSpatialObject< TDimension, TPixelType >::PointContainerPointer

Definition at line 62 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef VectorContainer< unsigned long, PointType> itk::ImageSpatialObject< TDimension, TPixelType >::PointContainerType

Definition at line 61 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef SmartPointer< Self > itk::ImageSpatialObject< TDimension, TPixelType >::Pointer

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef Superclass::PointType itk::ImageSpatialObject< TDimension, TPixelType >::PointType

Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 58 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef ImageType::RegionType itk::ImageSpatialObject< TDimension, TPixelType >::RegionType

Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 56 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef double itk::ImageSpatialObject< TDimension, TPixelType >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 46 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef ImageSpatialObject< TDimension, TPixelType > itk::ImageSpatialObject< TDimension, TPixelType >::Self

Standard class typedefs. Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 47 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef SpatialObject< TDimension > itk::ImageSpatialObject< TDimension, TPixelType >::Superclass

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> typedef Superclass::TransformType itk::ImageSpatialObject< TDimension, TPixelType >::TransformType

Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >. Definition at line 57 of file itkImageSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3, class TPixelType = unsigned char> itk::ImageSpatialObject< TDimension, TPixelType >::ImageSpatialObject (   )  [protected]

template<unsigned int TDimension = 3, class TPixelType = unsigned char> virtual itk::ImageSpatialObject< TDimension, TPixelType >::~ImageSpatialObject (   )  [protected, virtual]

---

Member Function Documentation

template<unsigned int TDimension = 3, class TPixelType = unsigned char> bool itk::ImageSpatialObject< TDimension, TPixelType >::ComputeLocalBoundingBox (   )  const [virtual]

Compute the boundaries of the iamge spatial object. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> const ImageType* itk::ImageSpatialObject< TDimension, TPixelType >::GetImage (  void   )  const

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> unsigned long itk::ImageSpatialObject< TDimension, TPixelType >::GetMTime (  void   )  const [virtual]

Returns the latest modified time of the object and its component. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> virtual const char* itk::ImageSpatialObject< TDimension, TPixelType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SpatialObject< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> const char* itk::ImageSpatialObject< TDimension, TPixelType >::GetPixelType (   )  [inline]

Definition at line 110 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> int itk::ImageSpatialObject< TDimension, TPixelType >::GetSlicePosition (  unsigned int  dimension  )  [inline]

Get the slice position Definition at line 107 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> bool itk::ImageSpatialObject< TDimension, TPixelType >::IsEvaluableAt (  const PointType &  point, unsigned int  depth = 0, char *  name = NULL )  const [virtual]

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> bool itk::ImageSpatialObject< TDimension, TPixelType >::IsInside (  const PointType &  point  )  const

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 Reimplemented in itk::ImageMaskSpatialObject< TDimension >.

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

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> Pointer itk::ImageSpatialObject< TDimension, TPixelType >::New (   )  [static]

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

template<unsigned int TDimension = 3, class TPixelType = unsigned char> void itk::ImageSpatialObject< TDimension, TPixelType >::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< TDimension >. Reimplemented in itk::ImageMaskSpatialObject< TDimension >.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> void itk::ImageSpatialObject< TDimension, TPixelType >::SetImage (  const ImageType *  image  )

Set the image.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> void itk::ImageSpatialObject< TDimension, TPixelType >::SetSlicePosition (  unsigned int  dimension, int  position )

Set the slice position

template<unsigned int TDimension = 3, class TPixelType = unsigned char> bool itk::ImageSpatialObject< TDimension, TPixelType >::ValueAt (  const PointType &  point, double &  value, unsigned int  depth = 0, char *  name = NULL )  const [virtual]

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

---

Member Data Documentation

template<unsigned int TDimension = 3, class TPixelType = unsigned char> ImagePointer itk::ImageSpatialObject< TDimension, TPixelType >::m_Image [protected]

Definition at line 117 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> std::string itk::ImageSpatialObject< TDimension, TPixelType >::m_PixelType [protected]

Definition at line 125 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char> int* itk::ImageSpatialObject< TDimension, TPixelType >::m_SlicePosition [protected]

Definition at line 124 of file itkImageSpatialObject.h.

---

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

• itkImageSpatialObject.h

---