#include <itkImageMaskSpatialObject.h>

Detailed Description

template<unsigned int TDimension = 3, typename TPixel = unsigned char>
class itk::ImageMaskSpatialObject< TDimension, TPixel >

Implementation of an image mask as spatial object.

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

Note: The bounding box of an image mask is defined in such a way that any point whose nearest pixel has a non-zero value (or matches the specified mask value) is inside the bounding box. When all the pixels of an image are zero, the bounding box of the image mask is empty, and its bounds are all zero.

See also: ImageSpatialObject SpatialObject CompositeSpatialObject

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

Definition at line 47 of file itkImageMaskSpatialObject.h.

Inheritance diagram for itk::ImageMaskSpatialObject< TDimension, TPixel >:

Collaboration diagram for itk::ImageMaskSpatialObject< TDimension, TPixel >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	ImagePointer

using	ImageType

using	IndexType

using	InterpolatorType

using	PixelType

using	Pointer = SmartPointer<Self>

using	ScalarType

using	Self = ImageMaskSpatialObject<TDimension, TPixel>

using	SliceIteratorType = itk::ImageSliceConstIteratorWithIndex<ImageType>

using	Superclass = ImageSpatialObject<TDimension, TPixel>

Public Types inherited from itk::ImageSpatialObject< 3, unsigned char >
using	ConstPointer

using	ContinuousIndexType

using	ImagePointer

using	ImageType

using	IndexType

using	InterpolatorType

using	NNInterpolatorType

using	PixelType

using	Pointer

typedef Point< ScalarType, VDimension >	PointType

using	PointType

using	ScalarType

using	Self

using	Superclass

Public Types inherited from itk::SpatialObject< TDimension >
using	BoundingBoxPointer

using	BoundingBoxPointer

using	BoundingBoxType

using	BoundingBoxType

using	ChildrenConstListPointer

using	ChildrenConstListPointer

using	ChildrenConstListType

using	ChildrenConstListType

using	ChildrenListPointer

using	ChildrenListPointer

using	ChildrenListType

using	ChildrenListType

using	ConstPointer

using	ConstPointer

using	CovariantVectorType

using	CovariantVectorType

using	DerivativeOffsetType

using	DerivativeOffsetType

using	DerivativeVectorPointer

using	DerivativeVectorPointer

using	DerivativeVectorType

using	DerivativeVectorType

using	IndexType

using	IndexType

using	InputType

using	InputType

using	ObjectConstListType

using	ObjectConstListType

using	ObjectDimensionType

using	ObjectDimensionType

using	ObjectListType

using	ObjectListType

using	Pointer

using	Pointer

using	PointPointer

using	PointPointer

using	PointType

using	PointType

using	PropertyType

using	PropertyType

using	RegionType

using	RegionType

using	ScalarType

using	ScalarType

using	Self

using	Self

using	SizeType

using	SizeType

using	Superclass

using	Superclass

using	TransformConstPointer

using	TransformConstPointer

using	TransformPointer

using	TransformPointer

using	TransformType

using	TransformType

using	VectorContainerType

using	VectorContainerType

using	VectorPointer

using	VectorPointer

using	VectorType

using	VectorType

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

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector<Pointer>::size_type

using	Pointer = SmartPointer<Self>

using	Self = DataObject

using	Superclass = Object

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

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
RegionType	ComputeMyBoundingBoxInIndexSpace () const

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

const char *	GetNameOfClass () const override

virtual const bool &	GetUseMaskValue () const

bool	IsInsideInObjectSpace (const PointType &point) const override

virtual void	SetUseMaskValue (bool _arg)

virtual void	UseMaskValueOff ()

virtual void	UseMaskValueOn ()


virtual void	SetMaskValue (PixelType _arg)

virtual const PixelType &	GetMaskValue () const

Public Member Functions inherited from itk::ImageSpatialObject< 3, unsigned char >
void	Clear () override

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

const ImageType *	GetImage () const

ModifiedTimeType	GetMTime () const override

const char *	GetNameOfClass () const override

bool	IsInsideInObjectSpace (const PointType &point) const override

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

void	SetImage (const ImageType *image)

void	Update () override

bool	ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const override

virtual void	SetSliceNumber (IndexType _arg)

void	SetSliceNumber (unsigned int dimension, int position)

virtual IndexType	GetSliceNumber () const

int	GetSliceNumber (unsigned int dimension)

void	SetInterpolator (InterpolatorType *interpolator)

virtual InterpolatorType *	GetInterpolator () const

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

void	AddChild (Self *pointer)

virtual void	AddChildrenToConstList (ChildrenConstListType *childrenCList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToConstList (ChildrenConstListType *childrenCList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const

bool	CheckIdValidity () const

bool	CheckIdValidity () const

virtual bool	ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const

virtual bool	ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const

void	ComputeObjectToParentTransform ()

void	ComputeObjectToParentTransform ()

void	CopyInformation (const DataObject *data) override

void	CopyInformation (const DataObject *data) override

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

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

virtual void	DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

virtual void	DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

void	DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

void	DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

bool	Evaluate (const PointType &point) const

bool	Evaluate (const PointType &point) const

void	FixIdValidity ()

void	FixIdValidity ()

bool	FixParentChildHierarchyUsingParentIds ()

bool	FixParentChildHierarchyUsingParentIds ()

virtual const RegionType &	GetBufferedRegion () const

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, const std::string &name="") const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, const std::string &name="") const

virtual std::string	GetClassNameAndDimension () const

virtual std::string	GetClassNameAndDimension () const

virtual ChildrenConstListType *	GetConstChildren (unsigned int depth=0, const std::string &name="") const

virtual ChildrenConstListType *	GetConstChildren (unsigned int depth=0, const std::string &name="") const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInWorldSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInWorldSpace () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

unsigned int	GetMaximumDepth () const

ModifiedTimeType	GetMTime () const override

ModifiedTimeType	GetMTime () const override

virtual const BoundingBoxType *	GetMyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInWorldSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInWorldSpace () const

ModifiedTimeType	GetMyMTime () const

ModifiedTimeType	GetMyMTime () const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

int	GetNextAvailableId () const

int	GetNextAvailableId () const

unsigned int	GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const

unsigned int	GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const

SpatialObject< VDimension > *	GetObjectById (int id)

SpatialObject< VDimension > *	GetObjectById (int id)

unsigned int	GetObjectDimension () const

unsigned int	GetObjectDimension () const

virtual Self *	GetParent ()

virtual Self *	GetParent ()

virtual const Self *	GetParent () const

virtual const Self *	GetParent () const

PropertyType &	GetProperty ()

PropertyType &	GetProperty ()

const PropertyType &	GetProperty () const

const PropertyType &	GetProperty () const

virtual const RegionType &	GetRequestedRegion () const

virtual const RegionType &	GetRequestedRegion () const

virtual std::string	GetTypeName () const

virtual std::string	GetTypeName () const

virtual bool	HasParent () const

virtual bool	HasParent () const

virtual bool	IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsInsideChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsInsideChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInWorldSpace (const PointType &point) const

bool	IsInsideInWorldSpace (const PointType &point) const

bool	IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

bool	RemoveChild (Self *pointer)

bool	RemoveChild (Self *pointer)

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

virtual void	SetBufferedRegion (const RegionType &region)

void	SetChildren (ChildrenListType &children)

void	SetChildren (ChildrenListType &children)

virtual void	SetLargestPossibleRegion (const RegionType &region)

virtual void	SetLargestPossibleRegion (const RegionType &region)

void	SetParent (Self *parent)

void	SetParent (Self *parent)

void	SetRequestedRegion (const DataObject *data) override

void	SetRequestedRegion (const DataObject *data) override

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegionToLargestPossibleRegion () override

void	SetRequestedRegionToLargestPossibleRegion () override

virtual void	SetTypeName (std::string _arg)

virtual void	SetTypeName (std::string _arg)

void	Update () override

void	Update () override

void	UpdateOutputInformation () override

void	UpdateOutputInformation () override

virtual bool	ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

virtual bool	ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	VerifyRequestedRegion () override

bool	VerifyRequestedRegion () override

void	SetId (int id)

virtual const int &	GetId () const

void	SetId (int id)

virtual const int &	GetId () const

void	SetProperty (const PropertyType &property)

void	SetProperty (const PropertyType &property)

void	SetObjectToWorldTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const TransformType *	GetObjectToWorldTransformInverse () const

void	SetObjectToWorldTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const TransformType *	GetObjectToWorldTransformInverse () const

void	SetObjectToParentTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToParentTransform ()

virtual const TransformType *	GetObjectToParentTransform () const

const TransformType *	GetObjectToParentTransformInverse () const

void	SetObjectToParentTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToParentTransform ()

virtual const TransformType *	GetObjectToParentTransform () const

const TransformType *	GetObjectToParentTransformInverse () const

virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultInsideValue () const

virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultInsideValue () const

virtual void	SetDefaultOutsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const

virtual void	SetDefaultOutsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const

virtual void	SetParentId (int _arg)

virtual const int &	GetParentId () const

virtual void	SetParentId (int _arg)

virtual const int &	GetParentId () const

Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

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

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

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

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

static Pointer	New ()

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

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

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

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

static Pointer	New ()

Protected Member Functions
void	ComputeMyBoundingBox () override

	ImageMaskSpatialObject ()

LightObject::Pointer	InternalClone () const override

	~ImageMaskSpatialObject () override=default

Protected Member Functions inherited from itk::ImageSpatialObject< 3, unsigned char >
void	ComputeMyBoundingBox () override

	ImageSpatialObject ()

LightObject::Pointer	InternalClone () const override

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

	~ImageSpatialObject () override

Protected Member Functions inherited from itk::SpatialObject< TDimension >
BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace ()

BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace ()

LightObject::Pointer	InternalClone () const override

LightObject::Pointer	InternalClone () const override

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

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

void	ProtectedComputeObjectToWorldTransform ()

void	ProtectedComputeObjectToWorldTransform ()

	SpatialObject ()=default

	SpatialObject ()=default

	~SpatialObject () override

	~SpatialObject () override

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
PixelType	m_MaskValue { NumericTraits<PixelType>::OneValue() }

bool	m_UseMaskValue { false }

Additional Inherited Members
Static Public Attributes inherited from itk::ImageSpatialObject< 3, unsigned char >
static constexpr unsigned int	ObjectDimension

Static Public Attributes inherited from itk::SpatialObject< TDimension >
static constexpr unsigned int	MaximumDepth

static constexpr unsigned int	MaximumDepth

static constexpr ObjectDimensionType	ObjectDimension

static constexpr ObjectDimensionType	ObjectDimension

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageMaskSpatialObject< TDimension, TPixel >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkImageMaskSpatialObject.h.

◆ ImagePointer

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::ImagePointer

Definition at line 54 of file itkImageSpatialObject.h.

◆ ImageType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::ImageType

Definition at line 53 of file itkImageSpatialObject.h.

◆ IndexType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::IndexType

Definition at line 55 of file itkImageSpatialObject.h.

◆ InterpolatorType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::InterpolatorType

Definition at line 57 of file itkImageSpatialObject.h.

◆ PixelType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::PixelType

Definition at line 52 of file itkImageSpatialObject.h.

◆ Pointer

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageMaskSpatialObject< TDimension, TPixel >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkImageMaskSpatialObject.h.

◆ ScalarType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageSpatialObject< TDimension, TPixel >::ScalarType

Definition at line 45 of file itkImageSpatialObject.h.

◆ Self

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageMaskSpatialObject< TDimension, TPixel >::Self = ImageMaskSpatialObject<TDimension, TPixel>

Definition at line 52 of file itkImageMaskSpatialObject.h.

◆ SliceIteratorType

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageMaskSpatialObject< TDimension, TPixel >::SliceIteratorType = itk::ImageSliceConstIteratorWithIndex<ImageType>

Definition at line 69 of file itkImageMaskSpatialObject.h.

◆ Superclass

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

using itk::ImageMaskSpatialObject< TDimension, TPixel >::Superclass = ImageSpatialObject<TDimension, TPixel>

Definition at line 53 of file itkImageMaskSpatialObject.h.

Constructor & Destructor Documentation

◆ ImageMaskSpatialObject()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

itk::ImageMaskSpatialObject< TDimension, TPixel >::ImageMaskSpatialObject ( )

protected

◆ ~ImageMaskSpatialObject()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

itk::ImageMaskSpatialObject< TDimension, TPixel >::~ImageMaskSpatialObject ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeMyBoundingBox()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

void itk::ImageMaskSpatialObject< TDimension, TPixel >::ComputeMyBoundingBox ( )

overrideprotectedvirtual

Get the boundaries of a specific object. This function needs to be called every time one of the object's components is changed.

Reimplemented from itk::SpatialObject< TDimension >.

◆ ComputeMyBoundingBoxInIndexSpace()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

RegionType itk::ImageMaskSpatialObject< TDimension, TPixel >::ComputeMyBoundingBoxInIndexSpace ( ) const

Computes the bounding box of the image mask, in the index space of the image. 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.

Note: This function is introduced with ITK 5.0, replacing GetAxisAlignedBoundingBoxRegion().

◆ CreateAnother()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual::itk::LightObject::Pointer itk::ImageMaskSpatialObject< TDimension, TPixel >::CreateAnother ( ) 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::LightObject.

◆ GetMaskValue()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual const PixelType & itk::ImageMaskSpatialObject< TDimension, TPixel >::GetMaskValue ( ) const

virtual

Specify the value in the mask image that defines the object. You must also call SetUseMaskValue(true) to enable the use of the mask value, otherwise the value is ignored and any non-zero value in the mask is used to define the object.

◆ GetNameOfClass()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

const char * itk::ImageMaskSpatialObject< TDimension, TPixel >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ GetUseMaskValue()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual const bool & itk::ImageMaskSpatialObject< TDimension, TPixel >::GetUseMaskValue ( ) const

virtual

◆ InternalClone()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

LightObject::Pointer itk::ImageMaskSpatialObject< TDimension, TPixel >::InternalClone ( ) const

overrideprotectedvirtual

Actual implementation of the clone method. This method should be reimplemented in subclasses to clone the extra required parameters.

Reimplemented from itk::LightObject.

◆ IsInsideInObjectSpace()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

bool itk::ImageMaskSpatialObject< TDimension, TPixel >::IsInsideInObjectSpace ( const PointType & point ) const

overridevirtual

Test whether a point is inside the object.

A point is inside the image mask when the value of its nearest pixel is non-zero or matches the Mask_Value value.

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::SpatialObject< TDimension >.

◆ New()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

static Pointer itk::ImageMaskSpatialObject< TDimension, TPixel >::New ( )

static

Method for creation through the object factory.

◆ SetMaskValue()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual void itk::ImageMaskSpatialObject< TDimension, TPixel >::SetMaskValue ( PixelType _arg )

virtual

Specify the value in the mask image that defines the object. You must also call SetUseMaskValue(true) to enable the use of the mask value, otherwise the value is ignored and any non-zero value in the mask is used to define the object.

◆ SetUseMaskValue()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual void itk::ImageMaskSpatialObject< TDimension, TPixel >::SetUseMaskValue ( bool _arg )

virtual

◆ UseMaskValueOff()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual void itk::ImageMaskSpatialObject< TDimension, TPixel >::UseMaskValueOff ( )

virtual

◆ UseMaskValueOn()

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

virtual void itk::ImageMaskSpatialObject< TDimension, TPixel >::UseMaskValueOn ( )

virtual

Member Data Documentation

◆ m_MaskValue

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

PixelType itk::ImageMaskSpatialObject< TDimension, TPixel >::m_MaskValue { NumericTraits<PixelType>::OneValue() }

private

Definition at line 139 of file itkImageMaskSpatialObject.h.

◆ m_UseMaskValue

template<unsigned int TDimension = 3, typename TPixel = unsigned char>

bool itk::ImageMaskSpatialObject< TDimension, TPixel >::m_UseMaskValue { false }

private

Definition at line 138 of file itkImageMaskSpatialObject.h.

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

itkImageMaskSpatialObject.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ImagePointer

◆ ImageType

◆ IndexType

◆ InterpolatorType

◆ PixelType

◆ Pointer

◆ ScalarType

◆ Self

◆ SliceIteratorType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageMaskSpatialObject()

◆ ~ImageMaskSpatialObject()

Member Function Documentation

◆ ComputeMyBoundingBox()

◆ ComputeMyBoundingBoxInIndexSpace()

◆ CreateAnother()

◆ GetMaskValue()

◆ GetNameOfClass()

◆ GetUseMaskValue()

◆ InternalClone()

◆ IsInsideInObjectSpace()

◆ New()

◆ SetMaskValue()

◆ SetUseMaskValue()

◆ UseMaskValueOff()

◆ UseMaskValueOn()

Member Data Documentation

◆ m_MaskValue

◆ m_UseMaskValue