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

Examples:: Examples/RegistrationITKv3/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/SpatialObjects/BoundingBoxFromImageMaskSpatialObject.cxx, and Examples/SpatialObjects/ImageMaskSpatialObject.cxx.

Definition at line 38 of file itkImageMaskSpatialObject.h.

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 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 unsigned char	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, unsigned char >	Self

typedef SpatialObject< TDimension >	Superclass

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::SpatialObject< TDimension >
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer

typedef AffineGeometryFrame < double, VDimension >	AffineGeometryFrameType

typedef BoundingBoxType::Pointer	BoundingBoxPointer

typedef BoundingBox < IdentifierType, VDimension, ScalarType, VectorContainerType >	BoundingBoxType

typedef ChildrenListType *	ChildrenListPointer

typedef std::list< Pointer >	ChildrenListType

typedef SmartPointer< const Self >	ConstPointer

typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType

typedef Index< VDimension >	IndexType

typedef Point< ScalarType, VDimension >	InputType

typedef Offset< VDimension >	OffsetType

typedef OutputVectorType *	OutputVectorPointer

typedef CovariantVector < double, VDimension >	OutputVectorType

typedef SmartPointer< Self >	Pointer

typedef PointType *	PointPointer

typedef Point< ScalarType, VDimension >	PointType

typedef PropertyType::Pointer	PropertyPointer

typedef SpatialObjectProperty < float >	PropertyType

typedef ImageRegion< VDimension >	RegionType

typedef double	ScalarType

typedef SpatialObject< VDimension >	Self

typedef Size< VDimension >	SizeType

typedef double *	SpacingType

typedef DataObject	Superclass

typedef const TransformType *	TransformConstPointer

typedef TransformType::Pointer	TransformPointer

typedef ScalableAffineTransform < double, VDimension >	TransformType

typedef SpatialObjectTreeNode < VDimension >	TreeNodeType

typedef VectorContainer < IdentifierType, PointType >	VectorContainerType

typedef VectorType *	VectorPointer

typedef Vector< ScalarType, VDimension >	VectorType

Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual bool	ComputeLocalBoundingBox () const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

RegionType	GetAxisAlignedBoundingBoxRegion () const

virtual const char *	GetNameOfClass () const

bool	IsInside (const PointType &point, unsigned int depth, char *name) const override

virtual bool	IsInside (const PointType &point) const

Public Member Functions inherited from itk::ImageSpatialObject< TDimension, unsigned char >
bool	ComputeLocalBoundingBox () const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

const ImageType *	GetImage () const

ModifiedTimeType	GetMTime (void) const override

const char *	GetPixelType ()

int	GetSlicePosition (unsigned int dimension)

bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override

bool	IsInside (const PointType &point, unsigned int depth, char *name) const override

bool	IsInside (const PointType &point) const

void	SetImage (const ImageType *image)

void	SetSlicePosition (unsigned int dimension, int position)

bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const override

void	SetInterpolator (InterpolatorType *interpolator)

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const InterpolatorType *	GetInterpolator () const

Public Member Functions inherited from itk::SpatialObject< TDimension >
void	AddSpatialObject (Self *pointer)

virtual void	Clear ()

virtual bool	ComputeBoundingBox () const

void	ComputeObjectToParentTransform ()

void	ComputeObjectToWorldTransform ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=nullptr)

bool	Evaluate (const PointType &point) const

virtual BoundingBoxType *	GetBoundingBox () const

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=nullptr) const

const TransformType *	GetIndexToObjectTransform () const

TransformType *	GetIndexToObjectTransform (void)

virtual const TransformType *	GetIndexToWorldTransform () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

TransformType *	GetModifiableIndexToObjectTransform (void)

virtual TransformType *	GetModifiableIndexToWorldTransform ()

virtual TreeNodeType *	GetModifiableTreeNode ()

TransformType *	GetNodeToParentNodeTransform ()

const TransformType *	GetNodeToParentNodeTransform () const

unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const

unsigned int	GetObjectDimension (void) const

unsigned long	GetObjectMTime (void) const

TransformType *	GetObjectToNodeTransform ()

const TransformType *	GetObjectToNodeTransform () const

TransformType *	GetObjectToParentTransform ()

const TransformType *	GetObjectToParentTransform () const

virtual const Self *	GetParent () const

virtual Self *	GetParent ()

virtual const RegionType &	GetRequestedRegion () const

virtual const double *	GetSpacing () const

virtual std::string	GetSpatialObjectTypeAsString () const

unsigned long	GetTransformMTime ()

virtual const TreeNodeType *	GetTreeNode () const

virtual const char *	GetTypeName (void) const

unsigned long	GetWorldTransformMTime ()

virtual bool	HasParent () const

virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const

virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=nullptr) 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	SetParent (Self *parent)

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegion (const DataObject *data) override

void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])

virtual void	SetTreeNode (TreeNodeType *_arg)

virtual void	Update (void) override

virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const

virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)

virtual AffineGeometryFrameType *	GetModifiableAffineGeometryFrame ()

virtual const AffineGeometryFrameType *	GetAffineGeometryFrame () const

void	SetObjectToWorldTransform (TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const OffsetValueType *	GetOffsetTable () const

OffsetValueType	ComputeOffset (const IndexType &ind) const

IndexType	ComputeIndex (OffsetValueType offset) const

virtual void	CopyInformation (const DataObject *data) override

virtual void	UpdateOutputInformation () override

virtual void	SetRequestedRegionToLargestPossibleRegion () override

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual bool	VerifyRequestedRegion () override

PropertyType *	GetProperty ()

const PropertyType *	GetProperty (void) const

void	SetProperty (PropertyType *property)

virtual const int &	GetId () const

virtual void	SetId (int _arg)

virtual void	SetParentId (int _arg)

virtual const int &	GetParentId () const

virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)

virtual const unsigned int &	GetBoundingBoxChildrenDepth () const

virtual void	SetBoundingBoxChildrenName (std::string _arg)

virtual const std::string &	GetBoundingBoxChildrenName () const

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

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

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

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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

const MetaDataDictionary &	GetMetaDataDictionary () 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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 ()

Static Public Member Functions inherited from itk::ImageSpatialObject< TDimension, unsigned char >
static Pointer	New ()

Static Public Member Functions inherited from itk::SpatialObject< TDimension >
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	ImageMaskSpatialObject (const Self &)

	ImageMaskSpatialObject ()

void	operator= (const Self &)

void	PrintSelf (std::ostream &os, Indent indent) const override

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

void	operator= (const Self &)

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual	~ImageSpatialObject ()

Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()

virtual const BoundingBoxType *	GetBounds () const

virtual const unsigned int &	GetDimension () const

virtual const TransformType *	GetInternalInverseTransform () const

virtual BoundingBoxType *	GetModifiableBounds ()

virtual TransformType *	GetModifiableInternalInverseTransform ()

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

virtual void	PropagateResetPipeline ()

	~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
Static Public Attributes inherited from itk::SpatialObject< TDimension >
static const unsigned int	MaximumDepth

static const unsigned int	ObjectDimension

Protected Attributes inherited from itk::ImageSpatialObject< TDimension, unsigned char >
ImagePointer	m_Image

InterpolatorType::Pointer	m_Interpolator

std::string	m_PixelType

int *	m_SlicePosition

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount