itk::ImageSpatialObject< TDimension, TPixelType > Class Template Reference

#include <itkImageSpatialObject.h>

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

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

Detailed Description

template<unsigned int TDimension = 3, typename 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

Examples:

Examples/SpatialObjects/ImageSpatialObject.cxx.

Definition at line 40 of file itkImageSpatialObject.h.

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 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 Member Functions
bool	ComputeLocalBoundingBox () const override
virtual ::itk::LightObject::Pointer	CreateAnother () const
const ImageType *	GetImage () const
ModifiedTimeType	GetMTime (void) const override
virtual const char *	GetNameOfClass () const
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
ModifiedTimeType	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
ModifiedTimeType	GetTransformMTime ()
virtual const TreeNodeType *	GetTreeNode () const
virtual const char *	GetTypeName (void) const
ModifiedTimeType	GetWorldTransformMTime ()
virtual bool	HasParent () 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 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

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

Protected Member Functions
	ImageSpatialObject ()
template<typename T >
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	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 Attributes
ImagePointer	m_Image
InterpolatorType::Pointer	m_Interpolator
std::string	m_PixelType
int *	m_SlicePosition

Additional Inherited Members
Static Public Attributes inherited from itk::SpatialObject< TDimension >
static const unsigned int	MaximumDepth
static const unsigned int	ObjectDimension

Member Typedef Documentation

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

typedef Superclass::BoundingBoxType itk::ImageSpatialObject< TDimension, TPixelType >::BoundingBoxType

Definition at line 58 of file itkImageSpatialObject.h.

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

typedef SmartPointer< const Self > itk::ImageSpatialObject< TDimension, TPixelType >::ConstPointer

Definition at line 49 of file itkImageSpatialObject.h.

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

typedef ImageType::ConstPointer itk::ImageSpatialObject< TDimension, TPixelType >::ImagePointer

Definition at line 53 of file itkImageSpatialObject.h.

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

typedef Image< PixelType, TDimension > itk::ImageSpatialObject< TDimension, TPixelType >::ImageType

Definition at line 52 of file itkImageSpatialObject.h.

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

typedef ImageType::IndexType itk::ImageSpatialObject< TDimension, TPixelType >::IndexType

Definition at line 54 of file itkImageSpatialObject.h.

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

typedef InterpolateImageFunction< ImageType > itk::ImageSpatialObject< TDimension, TPixelType >::InterpolatorType

Definition at line 59 of file itkImageSpatialObject.h.

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

typedef NearestNeighborInterpolateImageFunction< ImageType > itk::ImageSpatialObject< TDimension, TPixelType >::NNInterpolatorType

Definition at line 62 of file itkImageSpatialObject.h.

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

typedef TPixelType itk::ImageSpatialObject< TDimension, TPixelType >::PixelType

Definition at line 51 of file itkImageSpatialObject.h.

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

typedef PointContainerType::Pointer itk::ImageSpatialObject< TDimension, TPixelType >::PointContainerPointer

Definition at line 65 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, typename 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, typename TPixelType = unsigned char>

typedef SmartPointer< Self > itk::ImageSpatialObject< TDimension, TPixelType >::Pointer

Definition at line 48 of file itkImageSpatialObject.h.

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

typedef Superclass::PointType itk::ImageSpatialObject< TDimension, TPixelType >::PointType

Definition at line 57 of file itkImageSpatialObject.h.

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

typedef ImageType::RegionType itk::ImageSpatialObject< TDimension, TPixelType >::RegionType

Definition at line 55 of file itkImageSpatialObject.h.

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

typedef double itk::ImageSpatialObject< TDimension, TPixelType >::ScalarType

Definition at line 45 of file itkImageSpatialObject.h.

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

typedef ImageSpatialObject< TDimension, TPixelType > itk::ImageSpatialObject< TDimension, TPixelType >::Self

Definition at line 46 of file itkImageSpatialObject.h.

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

typedef SpatialObject< TDimension > itk::ImageSpatialObject< TDimension, TPixelType >::Superclass

Definition at line 47 of file itkImageSpatialObject.h.

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

typedef Superclass::TransformType itk::ImageSpatialObject< TDimension, TPixelType >::TransformType

Definition at line 56 of file itkImageSpatialObject.h.

Constructor & Destructor Documentation

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

itk::ImageSpatialObject< TDimension, TPixelType >::ImageSpatialObject ( )

protected

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

virtual itk::ImageSpatialObject< TDimension, TPixelType >::~ImageSpatialObject ( )

protectedvirtual

Member Function Documentation

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

bool itk::ImageSpatialObject< TDimension, TPixelType >::ComputeLocalBoundingBox ( ) const

overridevirtual

Compute the boundaries of the iamge spatial object.

Reimplemented from itk::SpatialObject< TDimension >.

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

virtual::itk::LightObject::Pointer itk::ImageSpatialObject< TDimension, TPixelType >::CreateAnother

(

)

const

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

const ImageType* itk::ImageSpatialObject< TDimension, TPixelType >::GetImage

(

)

const

Get a pointer to the image currently attached to the object.

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

virtual const InterpolatorType* itk::ImageSpatialObject< TDimension, TPixelType >::GetInterpolator ( ) const

virtual

Set/Get the interpolator

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

virtual InterpolatorType* itk::ImageSpatialObject< TDimension, TPixelType >::GetModifiableInterpolator ( )

virtual

Set/Get the interpolator

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

ModifiedTimeType itk::ImageSpatialObject< TDimension, TPixelType >::GetMTime ( void  ) const

overridevirtual

Returns the latest modified time of the object and its component.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3, typename 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, typename TPixelType = unsigned char>

const char* itk::ImageSpatialObject< TDimension, TPixelType >::GetPixelType ( )

inline

Definition at line 112 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, typename 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, typename TPixelType = unsigned char>

template<typename T >

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const T *  )

inlineprotected

Definition at line 137 of file itkImageSpatialObject.h.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const short *  )

inlineprotected

Definition at line 141 of file itkImageSpatialObject.h.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const unsigned char *  )

inlineprotected

Definition at line 145 of file itkImageSpatialObject.h.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const unsigned short *  )

inlineprotected

Definition at line 149 of file itkImageSpatialObject.h.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const float *  )

inlineprotected

Definition at line 153 of file itkImageSpatialObject.h.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::InternalSetPixelType ( const double *  )

inlineprotected

Definition at line 157 of file itkImageSpatialObject.h.

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

bool itk::ImageSpatialObject< TDimension, TPixelType >::IsEvaluableAt ( const PointType &  point, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

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

Reimplemented from itk::SpatialObject< TDimension >.

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

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

overridevirtual

Returns true if the point is inside, false otherwise.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3, typename 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

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

static Pointer itk::ImageSpatialObject< TDimension, TPixelType >::New ( )

static

Method for creation through the object factory.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Reimplemented from itk::SpatialObject< TDimension >.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::SetImage

(

const ImageType *

image

)

Set the image.

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

void itk::ImageSpatialObject< TDimension, TPixelType >::SetInterpolator

(

InterpolatorType *

interpolator

)

Set/Get the interpolator

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

void itk::ImageSpatialObject< TDimension, TPixelType >::SetSlicePosition	(	unsigned int	dimension,
		int	position
	)

Set the slice position

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

bool itk::ImageSpatialObject< TDimension, TPixelType >::ValueAt ( const PointType &  point, double &  value, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

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

Reimplemented from itk::SpatialObject< TDimension >.

Member Data Documentation

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

ImagePointer itk::ImageSpatialObject< TDimension, TPixelType >::m_Image

protected

Definition at line 119 of file itkImageSpatialObject.h.

template<unsigned int TDimension = 3, typename 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, typename 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, typename 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:

• itkImageSpatialObject.h