ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
itk::ImageSpatialObject< TDimension, TPixelType > Class Template Reference
Module ITKSpatialObjects

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

#include <itkImageSpatialObject.h>

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

List of all members.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
typedef SmartPointer< const Self > ConstPointer
typedef ImageType::ConstPointer ImagePointer
typedef Image< PixelType,
TDimension > 		ImageType
typedef ImageType::IndexType IndexType
typedef
InterpolateImageFunction
< ImageType > 		InterpolatorType
typedef
NearestNeighborInterpolateImageFunction
< ImageType > 		NNInterpolatorType
typedef TPixelType PixelType
typedef PointContainerType::Pointer PointContainerPointer
typedef VectorContainer
< IdentifierType, PointType > 		PointContainerType
typedef SmartPointer< Self > Pointer
typedef Superclass::PointType PointType
typedef ImageType::RegionType RegionType
typedef double ScalarType
typedef ImageSpatialObject
< TDimension, TPixelType > 		Self
typedef SpatialObject< TDimension > Superclass
typedef Superclass::TransformType TransformType

Public Member Functions

bool ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
const ImageType * GetImage (void) const
virtual InterpolatorType * GetInterpolator ()
unsigned long GetMTime (void) const
virtual const char * GetNameOfClass () const
const char * GetPixelType ()
int GetSlicePosition (unsigned int dimension)
bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
bool IsInside (const PointType &point) const
bool IsInside (const PointType &point, unsigned int depth, char *name) const
void SetImage (const ImageType *image)
void SetInterpolator (InterpolatorType *interpolator)
void SetSlicePosition (unsigned int dimension, int position)
bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 ImageSpatialObject (const Self &)
 ImageSpatialObject ()
void InternalSetPixelType (const unsigned char *)
void InternalSetPixelType (const unsigned short *)
void InternalSetPixelType (const float *)
void InternalSetPixelType (const short *)
template<typename T >
void InternalSetPixelType (const T *)
void InternalSetPixelType (const double *)
void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~ImageSpatialObject ()

Protected Attributes

ImagePointer m_Image
InterpolatorType::Pointer m_Interpolator
std::string m_PixelType
int * m_SlicePosition

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 58 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 49 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 53 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 52 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 54 of file itkImageSpatialObject.h.

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

Reimplemented in itk::ImageMaskSpatialObject< TDimension >.

Definition at line 59 of file itkImageSpatialObject.h.

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

Definition at line 62 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 51 of file itkImageSpatialObject.h.

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

Definition at line 65 of file itkImageSpatialObject.h.

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

Definition at line 64 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 48 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 57 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 55 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 45 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 46 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 47 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 56 of file itkImageSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3, class TPixelType = unsigned char>
itk::ImageSpatialObject< TDimension, TPixelType >::ImageSpatialObject ( const Self &  ) [protected]
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>
virtual::itk::LightObject::Pointer itk::ImageSpatialObject< TDimension, TPixelType >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::SpatialObject< TDimension >.

Reimplemented in itk::ImageMaskSpatialObject< 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>
virtual InterpolatorType* itk::ImageSpatialObject< TDimension, TPixelType >::GetInterpolator ( ) [virtual]
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 112 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 109 of file itkImageSpatialObject.h.

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

Definition at line 153 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char>
template<typename T >
void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const T *  ) [inline, protected]

Definition at line 137 of file itkImageSpatialObject.h.

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

Definition at line 141 of file itkImageSpatialObject.h.

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

Definition at line 145 of file itkImageSpatialObject.h.

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

Definition at line 149 of file itkImageSpatialObject.h.

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

Definition at line 157 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

Return true if the object is evaluable at the requested point, and else otherwise.

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

Returns true if the point is inside, false otherwise.

Reimplemented in itk::ImageMaskSpatialObject< 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>
static 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 >::operator= ( const Self &  ) [protected]

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]

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

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 >::SetInterpolator ( InterpolatorType *  interpolator)

Set/Get the interpolator

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

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

Member Data Documentation

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

Definition at line 125 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, class TPixelType = unsigned char>
InterpolatorType::Pointer itk::ImageSpatialObject< TDimension, TPixelType >::m_Interpolator [protected]

Definition at line 135 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 133 of file itkImageSpatialObject.h.

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

Definition at line 132 of file itkImageSpatialObject.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 00:24:31 for ITK by doxygen 1.7.4