#include <itkSpecialCoordinatesImage.h>

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::SpecialCoordinatesImage< TPixel, VImageDimension >

Templated n-dimensional nonrectilinear-coordinate image base class.

SpecialCoordinatesImages are templated over a pixel type (modeling the dependent variables), and a dimension (number of independent variables). The container for the pixel data is the ImportImageContainer.

Within the pixel container, images are modeled as arrays, defined by a start index and a size.

Almost arbitrary mappings between index space & Cartesian physical space are possible, and so m_Origin and m_Spacing should be ignored. They exist only to allow the possibility of running a "spatially-aware" filter in raw index space, as if the SpecialCoordinatesImage data was laid out on a regular grid. Note that this may or may not produce useful results, and it is up the user to determine the appropriateness of running a filter designed for normal images on special-coordinates images.

The only correct generic method for operating on a SpecialCoordinatesImage in physical space is to use the virtual functions TransformPhysicalPointToIndex, TransformPhysicalPointToContinuousIndex, TransformIndexToPhysicalPoint, and TransformContinuousIndexToPhysicalPoint. All of these methods transform points in Cartesian physical space to and from indices in the special (typically non-Cartesian) index space. It is also possible to check the type of coordinate representation being used by a SpecialCoordinatesImage, and then use representation-specific code to speed up the filter for certain coordinate representations, falling back to the generic method for unrecognized and/or unoptimized coordinate representations.

There are three sets of meta-data describing portions of a SpecialCoordinatesImages. These are "Region" objects that define a portion of an image via a starting index for the image array and a size. The ivar LargestPossibleRegion defines the size and starting index of the image dataset. The entire image dataset, however, need not be resident in memory. The region of the image that is resident in memory is defined by the "BufferedRegion". The Buffer is a contiguous block of memory. The third set of meta-data defines a region of interest, called the "RequestedRegion". The RequestedRegion is used by the pipeline execution model to define what a filter is requested to produce.

[RegionIndex, RegionSize] C [BufferIndex, BufferSize] C [ImageIndex, ImageSize]

Pixels can be accessed directly using the SetPixel() and GetPixel() methods or can be accessed via iterators. Begin() creates an iterator that can walk a specified region of a buffer.

The pixel type may be one of the native types; a Insight-defined class type such as Vector; or a user-defined type. Note that depending on the type of pixel that you use, the process objects (i.e., those filters processing data objects) may not operate on the image and/or pixel type. This becomes apparent at compile-time because operator overloading (for the pixel type) is not supported.

The data in an image is arranged in a 1D array as [][][][slice][row][col] with the column index varying most rapidly. The Index type reverses the order so that with Index[0] = col, Index[1] = row, Index[2] = slice, ...

See also: ImageContainerInterface; Image

Definition at line 95 of file itkSpecialCoordinatesImage.h.

Inheritance diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:

Collaboration diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:

Public Types
using	AccessorFunctorType = DefaultPixelAccessorFunctor< Self >

using	AccessorType = DefaultPixelAccessor< PixelType >

using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	InternalPixelType = TPixel

using	IOPixelType = PixelType

using	PixelContainer = ImportImageContainer< SizeValueType, PixelType >

using	PixelContainerConstPointer = typename PixelContainer::ConstPointer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	PixelType = TPixel

using	Pointer = SmartPointer< Self >

using	Self = SpecialCoordinatesImage

using	Superclass = ImageBase< VImageDimension >

using	ValueType = TPixel

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

using	DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >

using	ImageDimensionType = unsigned int

using	IndexType = Index< VImageDimension >

using	IndexValueType = typename IndexType::IndexValueType

using	OffsetType = Offset< VImageDimension >

using	OffsetValueType = typename OffsetType::OffsetValueType

using	Pointer = SmartPointer< Self >

using	PointType = Point< PointValueType, VImageDimension >

using	PointValueType = SpacePrecisionType

using	RegionType = ImageRegion< VImageDimension >

using	Self = ImageBase

using	SizeType = Size< VImageDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SpacingType = Vector< SpacingValueType, VImageDimension >

using	SpacingValueType = SpacePrecisionType

using	Superclass = DataObject

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
void	Allocate (bool initialize=false) override

void	FillBuffer (const TPixel &value)

const char *	GetNameOfClass () const override

TPixel &	GetPixel (const IndexType &index)

const TPixel &	GetPixel (const IndexType &index) const

AccessorType	GetPixelAccessor ()

const AccessorType	GetPixelAccessor () const

PixelContainer *	GetPixelContainer ()

const PixelContainer *	GetPixelContainer () const

void	Initialize () override

TPixel &	operator[] (const IndexType &index)

const TPixel &	operator[] (const IndexType &index) const

void	SetPixel (const IndexType &index, const TPixel &value)

void	SetPixelContainer (PixelContainer *container)


TPixel *	GetBufferPointer ()

const TPixel *	GetBufferPointer () const


void	SetSpacing (const SpacingType &) override

void	SetSpacing (const double[VImageDimension]) override

void	SetSpacing (const float[VImageDimension]) override

void	SetOrigin (const PointType) override

void	SetOrigin (const double[VImageDimension]) override

void	SetOrigin (const float[VImageDimension]) override

Public Member Functions inherited from itk::ImageBase< VImageDimension >
void	AllocateInitialized ()

OffsetValueType	ComputeOffset (const IndexType &ind) const

void	CopyInformation (const DataObject *data) override

virtual const RegionType &	GetBufferedRegion () const

virtual const DirectionType &	GetDirection () const

virtual const DirectionType &	GetInverseDirection () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const PointType &	GetOrigin () const

virtual const RegionType &	GetRequestedRegion () const

virtual const SpacingType &	GetSpacing () const

virtual void	Graft (const Self *image)

bool	IsCongruentImageGeometry (const ImageBase *otherImage, double coordinateTolerance, double directionTolerance) const

bool	IsSameImageGeometryAs (const ImageBase *otherImage, double coordinateTolerance=DefaultImageCoordinateTolerance, double directionTolerance=DefaultImageDirectionTolerance) const

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

virtual void	SetDirection (const DirectionType &direction)

virtual void	SetLargestPossibleRegion (const RegionType &region)

virtual void	SetRegions (const SizeType &size)

void	SetRequestedRegion (const DataObject *data) override

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegionToLargestPossibleRegion () override

template<typename TCoordinate >
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordinate, VImageDimension > &inputGradient, FixedArray< TCoordinate, VImageDimension > &outputGradient) const

template<typename TIndexRep , typename TCoordinate >
ContinuousIndex< TIndexRep, VImageDimension >	TransformPhysicalPointToContinuousIndex (const Point< TCoordinate, VImageDimension > &point) const

template<typename TCoordinate , typename TIndexRep >
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordinate, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const

template<typename TCoordinate >
bool	TransformPhysicalPointToIndex (const Point< TCoordinate, VImageDimension > &point, IndexType &index) const

template<typename TCoordinate >
void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordinate, VImageDimension > &inputGradient, FixedArray< TCoordinate, VImageDimension > &outputGradient) const

void	UpdateOutputData () override

void	UpdateOutputInformation () override

bool	VerifyRequestedRegion () override

virtual void	SetRegions (const RegionType &region)

const OffsetValueType *	GetOffsetTable () const

IndexType	ComputeIndex (OffsetValueType offset) const

template<typename TCoordinate >
IndexType	TransformPhysicalPointToIndex (const Point< TCoordinate, VImageDimension > &point) const

template<typename TCoordinate , typename TIndexRep >
void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordinate, VImageDimension > &point) const

template<typename TCoordinate , typename TIndexRep >
Point< TCoordinate, VImageDimension >	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index) const

template<typename TCoordinate >
void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordinate, VImageDimension > &point) const

template<typename TCoordinate >
Point< TCoordinate, VImageDimension >	TransformIndexToPhysicalPoint (const IndexType &index) const

template<typename TVector >
TVector	TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const

template<typename TVector >
TVector	TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const

virtual unsigned int	GetNumberOfComponentsPerPixel () const

virtual void	SetNumberOfComponentsPerPixel (unsigned int)

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

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

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

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () 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::ImageBase< VImageDimension >
static constexpr unsigned int	GetImageDimension ()

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

Static Public Attributes
static constexpr unsigned int	ImageDimension = VImageDimension

Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static constexpr ImageDimensionType	ImageDimension = VImageDimension

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

	SpecialCoordinatesImage ()=default

	~SpecialCoordinatesImage () override=default

Protected Member Functions inherited from itk::ImageBase< VImageDimension >
virtual void	ComputeIndexToPhysicalPointMatrices ()

void	ComputeOffsetTable ()

void	Graft (const DataObject *data) override

	ImageBase ()=default

virtual void	InitializeBufferedRegion ()

	~ImageBase () override=default

OffsetValueType	FastComputeOffset (const IndexType &ind) const

IndexType	FastComputeIndex (OffsetValueType offset) const

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

Private Attributes
PixelContainerPointer	m_Buffer { PixelContainer::New() }

Additional Inherited Members
Protected Attributes inherited from itk::ImageBase< VImageDimension >
SpacingType	m_Spacing { MakeFilled<SpacingType>(1.0) }

PointType	m_Origin {}

DirectionType	m_Direction { DirectionType::GetIdentity() }

DirectionType	m_InverseDirection { DirectionType::GetIdentity() }

DirectionType	m_IndexToPhysicalPoint { DirectionType::GetIdentity() }

DirectionType	m_PhysicalPointToIndex { DirectionType::GetIdentity() }

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

Member Typedef Documentation

◆ AccessorFunctorType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorFunctorType = DefaultPixelAccessorFunctor<Self>

Accessor functor to choose between accessors: DefaultPixelAccessor for the Image, and DefaultVectorPixelAccessor for the vector image. The functor provides a generic API between the two accessors.

Definition at line 135 of file itkSpecialCoordinatesImage.h.

◆ AccessorType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorType = DefaultPixelAccessor<PixelType>

Accessor type that convert data between internal and external representations.

Definition at line 130 of file itkSpecialCoordinatesImage.h.

◆ ConstPointer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 104 of file itkSpecialCoordinatesImage.h.

◆ ConstWeakPointer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstWeakPointer = WeakPointer<const Self>

Definition at line 105 of file itkSpecialCoordinatesImage.h.

◆ InternalPixelType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::InternalPixelType = TPixel

Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation.

Definition at line 124 of file itkSpecialCoordinatesImage.h.

◆ IOPixelType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IOPixelType = PixelType

Definition at line 126 of file itkSpecialCoordinatesImage.h.

◆ PixelContainer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainer = ImportImageContainer<SizeValueType, PixelType>

Container used to store pixels in the image.

Definition at line 153 of file itkSpecialCoordinatesImage.h.

◆ PixelContainerConstPointer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerConstPointer = typename PixelContainer::ConstPointer

Definition at line 171 of file itkSpecialCoordinatesImage.h.

◆ PixelContainerPointer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerPointer = typename PixelContainer::Pointer

A pointer to the pixel container.

Definition at line 170 of file itkSpecialCoordinatesImage.h.

◆ PixelType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelType = TPixel

Pixel type alias support Used to declare pixel type in filters or other operations.

Definition at line 115 of file itkSpecialCoordinatesImage.h.

◆ Pointer

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Pointer = SmartPointer<Self>

Definition at line 103 of file itkSpecialCoordinatesImage.h.

◆ Self

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Self = SpecialCoordinatesImage

Standard class type aliases

Definition at line 101 of file itkSpecialCoordinatesImage.h.

◆ Superclass

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Superclass = ImageBase<VImageDimension>

Definition at line 102 of file itkSpecialCoordinatesImage.h.

◆ ValueType

template<typename TPixel, unsigned int VImageDimension = 2>

using itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ValueType = TPixel

Typedef alias for PixelType

Definition at line 118 of file itkSpecialCoordinatesImage.h.

Constructor & Destructor Documentation

◆ SpecialCoordinatesImage()

template<typename TPixel, unsigned int VImageDimension = 2>

itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage ( )

protecteddefault

◆ ~SpecialCoordinatesImage()

template<typename TPixel, unsigned int VImageDimension = 2>

itk::SpecialCoordinatesImage< TPixel, VImageDimension >::~SpecialCoordinatesImage ( )

overrideprotecteddefault

Member Function Documentation

◆ Allocate()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Allocate ( bool initialize = false )

overridevirtual

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

Reimplemented from itk::ImageBase< VImageDimension >.

◆ FillBuffer()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::FillBuffer ( const TPixel & value )

Fill the image buffer with a value. Be sure to call Allocate() first.

◆ GetBufferPointer() [1/2]

template<typename TPixel, unsigned int VImageDimension = 2>

TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( )

inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 245 of file itkSpecialCoordinatesImage.h.

◆ GetBufferPointer() [2/2]

template<typename TPixel, unsigned int VImageDimension = 2>

const TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( ) const

inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 250 of file itkSpecialCoordinatesImage.h.

◆ GetNameOfClass()

template<typename TPixel, unsigned int VImageDimension = 2>

const char* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageBase< VImageDimension >.

◆ GetPixel() [1/2]

template<typename TPixel, unsigned int VImageDimension = 2>

TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType & index )

inline

Get a reference to a pixel (e.g. for editing).

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 216 of file itkSpecialCoordinatesImage.h.

◆ GetPixel() [2/2]

template<typename TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType & index ) const

inline

Get a pixel (read only version).

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 205 of file itkSpecialCoordinatesImage.h.

◆ GetPixelAccessor() [1/2]

template<typename TPixel, unsigned int VImageDimension = 2>

AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( )

inline

Return the Pixel Accessor object

Definition at line 276 of file itkSpecialCoordinatesImage.h.

◆ GetPixelAccessor() [2/2]

template<typename TPixel, unsigned int VImageDimension = 2>

const AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( ) const

inline

Return the Pixel Accesor object

Definition at line 283 of file itkSpecialCoordinatesImage.h.

◆ GetPixelContainer() [1/2]

template<typename TPixel, unsigned int VImageDimension = 2>

PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( )

inline

Return a pointer to the container.

Definition at line 258 of file itkSpecialCoordinatesImage.h.

◆ GetPixelContainer() [2/2]

template<typename TPixel, unsigned int VImageDimension = 2>

const PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( ) const

inline

Definition at line 264 of file itkSpecialCoordinatesImage.h.

◆ Initialize()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Initialize ( )

overridevirtual

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ New()

template<typename TPixel, unsigned int VImageDimension = 2>

static Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::New ( )

static

Method for creation through the object factory.

◆ operator[]() [1/2]

template<typename TPixel, unsigned int VImageDimension = 2>

TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType & index )

inline

Access a pixel. This version can be an lvalue.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 227 of file itkSpecialCoordinatesImage.h.

◆ operator[]() [2/2]

template<typename TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType & index ) const

inline

Access a pixel. This version can only be an rvalue.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 237 of file itkSpecialCoordinatesImage.h.

◆ PrintSelf()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ SetOrigin() [1/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const double [VImageDimension] )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 306 of file itkSpecialCoordinatesImage.h.

◆ SetOrigin() [2/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const float [VImageDimension] )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 309 of file itkSpecialCoordinatesImage.h.

◆ SetOrigin() [3/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const PointType )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 303 of file itkSpecialCoordinatesImage.h.

◆ SetPixel()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixel	(	const IndexType &	index,
		const TPixel &	value
	)

inline

Set a pixel value.

Allocate() needs to have been called first – for efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 194 of file itkSpecialCoordinatesImage.h.

◆ SetPixelContainer()

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixelContainer ( PixelContainer * container )

Set the container to use. Note that this does not cause the DataObject to be modified.

◆ SetSpacing() [1/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const double [VImageDimension] )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 297 of file itkSpecialCoordinatesImage.h.

◆ SetSpacing() [2/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const float [VImageDimension] )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 300 of file itkSpecialCoordinatesImage.h.

◆ SetSpacing() [3/3]

template<typename TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const SpacingType & )

inlineoverridevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 294 of file itkSpecialCoordinatesImage.h.

Member Data Documentation

◆ ImageDimension

template<typename TPixel, unsigned int VImageDimension = 2>

constexpr unsigned int itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ImageDimension = VImageDimension

staticconstexpr

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Definition at line 141 of file itkSpecialCoordinatesImage.h.

◆ m_Buffer

template<typename TPixel, unsigned int VImageDimension = 2>

PixelContainerPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::m_Buffer { PixelContainer::New() }

private

Memory for the current buffer.

Definition at line 346 of file itkSpecialCoordinatesImage.h.

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

itkSpecialCoordinatesImage.h

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2> class itk::SpecialCoordinatesImage< TPixel, VImageDimension >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AccessorFunctorType

◆ AccessorType

◆ ConstPointer

◆ ConstWeakPointer

◆ InternalPixelType

◆ IOPixelType

◆ PixelContainer

◆ PixelContainerConstPointer

◆ PixelContainerPointer

◆ PixelType

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ SpecialCoordinatesImage()

◆ ~SpecialCoordinatesImage()

Member Function Documentation

◆ Allocate()

◆ FillBuffer()

◆ GetBufferPointer() [1/2]

◆ GetBufferPointer() [2/2]

◆ GetNameOfClass()

◆ GetPixel() [1/2]

◆ GetPixel() [2/2]

◆ GetPixelAccessor() [1/2]

◆ GetPixelAccessor() [2/2]

◆ GetPixelContainer() [1/2]

◆ GetPixelContainer() [2/2]

◆ Initialize()

◆ New()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PrintSelf()

◆ SetOrigin() [1/3]

◆ SetOrigin() [2/3]

◆ SetOrigin() [3/3]

◆ SetPixel()

◆ SetPixelContainer()

◆ SetSpacing() [1/3]

◆ SetSpacing() [2/3]

◆ SetSpacing() [3/3]

Member Data Documentation

◆ ImageDimension

◆ m_Buffer

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::SpecialCoordinatesImage< TPixel, VImageDimension >