itk::ImageMaskSpatialObject< TDimension > Class Template Reference

#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 Types inherited from itk::ImageSpatialObject< TDimension, unsigned char >
typedef NearestNeighborInterpolateImageFunction < ImageType >	NNInterpolatorType
typedef PointContainerType::Pointer	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
Public Types inherited from itk::SpatialObject< TDimension >
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer
typedef AffineGeometryFrame < double, VDimension >	AffineGeometryFrameType
typedef BoundingBoxType::Pointer	BoundingBoxPointer
typedef ChildrenListType *	ChildrenListPointer
typedef std::list< Pointer >	ChildrenListType
typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType
typedef Point< ScalarType, VDimension >	InputType
typedef Offset< VDimension >	OffsetType
typedef OutputVectorType *	OutputVectorPointer
typedef CovariantVector < double, VDimension >	OutputVectorType
typedef PointType *	PointPointer
typedef PropertyType::Pointer	PropertyPointer
typedef SpatialObjectProperty < float >	PropertyType
typedef double *	SpacingType
typedef const TransformType *	TransformConstPointer
typedef TransformType::Pointer	TransformPointer
typedef SpatialObjectTreeNode < VDimension >	TreeNodeType
typedef VectorContainer < IdentifierType, PointType >	VectorContainerType
typedef VectorType *	VectorPointer
typedef Vector< ScalarType, VDimension >	VectorType
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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
Public Member Functions inherited from itk::ImageSpatialObject< TDimension, unsigned char >
bool	ComputeLocalBoundingBox () const
const ImageType *	GetImage (void) const
virtual InterpolatorType *	GetInterpolator ()
unsigned long	GetMTime (void) const
const char *	GetPixelType ()
int	GetSlicePosition (unsigned int dimension)
bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) 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
Public Member Functions inherited from itk::SpatialObject< TDimension >
void	AddSpatialObject (Self *pointer)
virtual void	Clear (void)
virtual bool	ComputeBoundingBox () const
void	ComputeObjectToParentTransform (void)
void	ComputeObjectToWorldTransform (void)
virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
bool	Evaluate (const PointType &point) const
virtual BoundingBoxType *	GetBoundingBox () const
virtual const RegionType &	GetBufferedRegion () const
virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=NULL) const
TransformType *	GetIndexToObjectTransform (void)
const TransformType *	GetIndexToObjectTransform (void) const
virtual TransformType *	GetIndexToWorldTransform ()
virtual const TransformType *	GetIndexToWorldTransform ()
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth () const
TransformType *	GetNodeToParentNodeTransform (void)
const TransformType *	GetNodeToParentNodeTransform (void) const
unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int	GetObjectDimension (void) const
unsigned long	GetObjectMTime (void) const
TransformType *	GetObjectToNodeTransform (void)
const TransformType *	GetObjectToNodeTransform (void) const
TransformType *	GetObjectToParentTransform (void)
const TransformType *	GetObjectToParentTransform (void) const
virtual TransformType *	GetObjectToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform ()
virtual const Self *	GetParent (void) const
virtual Self *	GetParent (void)
virtual const RegionType &	GetRequestedRegion () const
virtual const double *	GetSpacing () const
virtual std::string	GetSpatialObjectTypeAsString () const
unsigned long	GetTransformMTime (void)
virtual const char *	GetTypeName (void) const
unsigned long	GetWorldTransformMTime (void)
virtual bool	HasParent (void) const
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const
void	RemoveSpatialObject (Self *object)
virtual void	SetBufferedRegion (const RegionType &region)
void	SetChildren (ChildrenListType &children)
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetNodeToParentNodeTransform (TransformType *transform)
void	SetObjectToParentTransform (TransformType *transform)
void	SetObjectToWorldTransform (TransformType *transform)
void	SetParent (Self *parent)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data)
void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void	SetTreeNode (TreeNodeType *_arg)
virtual void	Update (void)
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
virtual const AffineGeometryFrameType *	GetAffineGeometryFrame ()
virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
const OffsetValueType *	GetOffsetTable () const
OffsetValueType	ComputeOffset (const IndexType &ind) const
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data)
virtual void	UpdateOutputInformation ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool	VerifyRequestedRegion ()
PropertyType *	GetProperty (void)
const PropertyType *	GetProperty (void) const
void	SetProperty (PropertyType *property)
virtual const int &	GetId ()
virtual void	SetId (int _arg)
virtual void	SetParentId (int _arg)
virtual const int &	GetParentId ()
virtual TreeNodeType *	GetTreeNode ()
virtual const TreeNodeType *	GetTreeNode ()
virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int &	GetBoundingBoxChildrenDepth ()
virtual void	SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string &	GetBoundingBoxChildrenName ()
virtual void	SetDefaultInsideValue (double _arg)
virtual double	GetDefaultInsideValue () const
virtual void	SetDefaultOutsideValue (double _arg)
virtual double	GetDefaultOutsideValue () const
Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Initialize ()
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
bool	ShouldIReleaseData () const
virtual void	UpdateOutputData ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) 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 ()
Protected Member Functions inherited from itk::ImageSpatialObject< TDimension, unsigned char >
	ImageSpatialObject (const Self &)
	ImageSpatialObject ()
void	InternalSetPixelType (const T *)
void	InternalSetPixelType (const short *)
void	InternalSetPixelType (const unsigned char *)
void	InternalSetPixelType (const unsigned short *)
void	InternalSetPixelType (const float *)
void	InternalSetPixelType (const double *)
virtual	~ImageSpatialObject ()
Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds ()
virtual const unsigned int &	GetDimension ()
virtual const TransformType *	GetInternalInverseTransform ()
virtual void	SetDimension (unsigned int _arg)
bool	SetInternalInverseTransformToWorldToIndexTransform () const
virtual void	SetTypeName (std::string _arg)
	SpatialObject ()
virtual	~SpatialObject ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Additional Inherited Members
Protected Attributes inherited from itk::ImageSpatialObject< TDimension, unsigned char >
ImagePointer	m_Image
InterpolatorType::Pointer	m_Interpolator
std::string	m_PixelType
int *	m_SlicePosition

---

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 ( )

protectedvirtual

---

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

protectedvirtual

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