itk::ImageMaskSpatialObject< TDimension > Class Template Reference

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

#include <itkImageMaskSpatialObject.h>

Inheritance diagram for itk::ImageMaskSpatialObject< TDimension >:

Collaboration diagram for itk::ImageMaskSpatialObject< TDimension >:

List of all members.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ImagePointer	ImagePointer
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef Superclass::RegionType	RegionType
typedef Superclass::ScalarType	ScalarType
typedef ImageMaskSpatialObject < TDimension >	Self
typedef Superclass::SizeType	SizeType
typedef itk::ImageSliceConstIteratorWithIndex < ImageType >	SliceIteratorType
typedef ImageSpatialObject < TDimension >	Superclass
typedef Superclass::TransformType	TransformType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
RegionType	GetAxisAlignedBoundingBoxRegion () const
virtual const char *	GetNameOfClass () const
bool	IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool	IsInside (const PointType &point) const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	ImageMaskSpatialObject (const Self &)
	ImageMaskSpatialObject ()
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~ImageMaskSpatialObject ()

---

Detailed Description

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

Implementation of an image mask as spatial object.

This class derives from the ImageSpatialObject and overloads the IsInside() method. One of the common uses of this class is to serve as Mask for the Image Registration Metrics.

See also:

ImageSpatialObject SpatialObject CompositeSpatialObject

Definition at line 38 of file itkImageMaskSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef Superclass::BoundingBoxType itk::ImageMaskSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 57 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< const Self > itk::ImageMaskSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 46 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::ImagePointer itk::ImageMaskSpatialObject< TDimension >::ImagePointer

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 51 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::ImageType itk::ImageMaskSpatialObject< TDimension >::ImageType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 50 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::IndexType itk::ImageMaskSpatialObject< TDimension >::IndexType

Index typedef support. An index is used to access pixel values.

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 52 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::InterpolatorType itk::ImageMaskSpatialObject< TDimension >::InterpolatorType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 58 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::PixelType itk::ImageMaskSpatialObject< TDimension >::PixelType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 49 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< Self > itk::ImageMaskSpatialObject< TDimension >::Pointer

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 45 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::PointType itk::ImageMaskSpatialObject< TDimension >::PointType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 56 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::RegionType itk::ImageMaskSpatialObject< TDimension >::RegionType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 53 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::ScalarType itk::ImageMaskSpatialObject< TDimension >::ScalarType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 48 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef ImageMaskSpatialObject< TDimension > itk::ImageMaskSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 43 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::SizeType itk::ImageMaskSpatialObject< TDimension >::SizeType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 54 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef itk::ImageSliceConstIteratorWithIndex< ImageType > itk::ImageMaskSpatialObject< TDimension >::SliceIteratorType

Definition at line 61 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef ImageSpatialObject< TDimension > itk::ImageMaskSpatialObject< TDimension >::Superclass

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 44 of file itkImageMaskSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::TransformType itk::ImageMaskSpatialObject< TDimension >::TransformType

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

Definition at line 55 of file itkImageMaskSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::ImageMaskSpatialObject< TDimension >::ImageMaskSpatialObject

(

const Self &

)

[protected]

template<unsigned int TDimension = 3>

itk::ImageMaskSpatialObject< TDimension >::ImageMaskSpatialObject

(

)

[protected]

template<unsigned int TDimension = 3>

virtual itk::ImageMaskSpatialObject< TDimension >::~ImageMaskSpatialObject

(

)

[protected, virtual]

---

Member Function Documentation

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::ImageMaskSpatialObject< TDimension >::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::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

RegionType itk::ImageMaskSpatialObject< TDimension >::GetAxisAlignedBoundingBoxRegion

(

)

const

Compute axis aligned bounding box from the image mask. The bounding box is returned as an image region. Each call to this function will recompute the region. This function is useful in cases, where you may have a mask image resulting from say a segmentation and you want to get the smallest box region that encapsulates the mask image. Currently this is done only for 3D volumes.

template<unsigned int TDimension = 3>

virtual const char* itk::ImageMaskSpatialObject< TDimension >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

bool itk::ImageMaskSpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth,
		char *	name
	)		const

Returns true if the point is inside, false otherwise.

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

virtual bool itk::ImageMaskSpatialObject< 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

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

static Pointer itk::ImageMaskSpatialObject< TDimension >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

void itk::ImageMaskSpatialObject< TDimension >::operator=

(

const Self &

)

[protected]

Reimplemented from itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

void itk::ImageMaskSpatialObject< TDimension >::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::ImageSpatialObject< TDimension, unsigned char >.

---

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

• itkImageMaskSpatialObject.h