#include <itkImageAlgorithm.h>

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 3>
class itk::VectorImage< TPixel, VImageDimension >

Templated n-dimensional vector image class.

This class differs from Image in that it is intended to represent multiple images. Each pixel represents k measurements, each of datatype TPixel. The memory organization of the resulting image is as follows: ... Pi0 Pi1 Pi2 Pi3 P(i+1)0 P(i+1)1 P(i+1)2 P(i+1)3 P(i+2)0 ... where Pi0 represents the 0th measurement of the pixel at index i.

Conceptually, a VectorImage< TPixel, 3 > is the same as a Image< VariableLengthVector< TPixel >, 3 >. The difference lies in the memory organization. The latter results in a fragmented organization with each location in the Image holding a pointer to an VariableLengthVector holding the actual pixel. The former stores the k pixels instead of a pointer reference, which apart from avoiding fragmentation of memory also avoids storing a 8 bytes of pointer reference for each pixel. The parameter k can be set using SetVectorLength.

The API of the class is such that it returns a pixeltype VariableLengthVector< TPixel > when queried, with the data internally pointing to the buffer. (the container does not manage the memory). Similarly SetPixel calls can be made with VariableLengthVector< TPixel >.

The API of this class is similar to Image.

Caveats:: When using Iterators on this image, you cannot use the it.Value(). You must use Set/Get() methods instead.

Note: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

See also: DefaultVectorPixelAccessor; DefaultVectorPixelAccessorFunctor; VectorImageToImagePixelAccessor; VectorImageToImageAdaptor; Image; ImportImageContainer

ITK Sphinx Examples:

All ITK Sphinx Examples

Cast Vector Image To Another Type

Create Vector Image

Neighborhood Iterator On Vector Image

Examples: Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/Statistics/BayesianClassifier.cxx, SphinxExamples/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Code.cxx, SphinxExamples/src/Core/Common/CastVectorImageToAnotherType/Code.cxx, SphinxExamples/src/Core/Common/CreateVectorImage/Code.cxx, SphinxExamples/src/Core/Common/NeighborhoodIteratorOnVectorImage/Code.cxx, SphinxExamples/src/Core/ImageAdaptors/ViewComponentVectorImageAsScaleImage/Code.cxx, SphinxExamples/src/Filtering/ImageCompose/CreateVectorImageFromScalarImages/Code.cxx, SphinxExamples/src/Filtering/ImageIntensity/ComputerMagInVectorImageToMakeMagImage/Code.cxx, and SphinxExamples/src/Filtering/ImageIntensity/ExtractComponentOfVectorImage/Code.cxx.

Definition at line 29 of file itkImageAlgorithm.h.

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

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

Classes
struct	Rebind

Public Types
using	AccessorFunctorType = DefaultVectorPixelAccessorFunctor< Self >

using	AccessorType = DefaultVectorPixelAccessor< InternalPixelType >

using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	InternalPixelType = TPixel

using	IOPixelType = InternalPixelType

using	NeighborhoodAccessorFunctorType = VectorImageNeighborhoodAccessorFunctor< Self >

using	PixelContainer = ImportImageContainer< SizeValueType, InternalPixelType >

using	PixelContainerConstPointer = typename PixelContainer::ConstPointer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	PixelType = VariableLengthVector< TPixel >

using	Pointer = SmartPointer< Self >

template<typename UPixelType , unsigned int VUImageDimension = VImageDimension>
using	RebindImageType = typename Rebind< UPixelType, VUImageDimension >::Type

using	Self = VectorImage

using	Superclass = ImageBase< VImageDimension >

using	ValueType = PixelType

using	VectorLengthType = unsigned int

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 UseValueInitialization=false) override

void	FillBuffer (const PixelType &value)

const char *	GetNameOfClass () const override

NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()

const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const

unsigned int	GetNumberOfComponentsPerPixel () const override

PixelType	GetPixel (const IndexType &index)

const PixelType	GetPixel (const IndexType &index) const

AccessorType	GetPixelAccessor ()

const AccessorType	GetPixelAccessor () const

PixelContainer *	GetPixelContainer ()

const PixelContainer *	GetPixelContainer () const

virtual void	Graft (const Self *image)

void	Initialize () override

PixelType	operator[] (const IndexType &index)

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

void	SetNumberOfComponentsPerPixel (unsigned int n) override

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

void	SetPixelContainer (PixelContainer *container)


InternalPixelType *	GetBufferPointer ()

const InternalPixelType *	GetBufferPointer () const


virtual void	SetVectorLength (VectorLengthType _arg)

virtual const VectorLengthType &	GetVectorLength () const

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

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	SetOrigin (PointType _arg)

virtual void	SetOrigin (const double origin[VImageDimension])

virtual void	SetOrigin (const float origin[VImageDimension])

virtual void	SetRegions (const RegionType &region)

const OffsetValueType *	GetOffsetTable () const

IndexType	ComputeIndex (OffsetValueType offset) const

virtual void	SetSpacing (const SpacingType &spacing)

virtual void	SetSpacing (const double spacing[VImageDimension])

virtual void	SetSpacing (const float spacing[VImageDimension])

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

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	Graft (const DataObject *data) override

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

	VectorImage ()=default

	~VectorImage () override=default

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

void	ComputeOffsetTable ()

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

VectorLengthType	m_VectorLength { 0 }

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 = 3>

using itk::VectorImage< TPixel, VImageDimension >::AccessorFunctorType = DefaultVectorPixelAccessorFunctor<Self>

Functor to provide a common API between DefaultPixelAccessor and DefaultVectorPixelAccessor

Definition at line 121 of file itkVectorImage.h.

◆ AccessorType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::AccessorType = DefaultVectorPixelAccessor<InternalPixelType>

Accessor type that convert data between internal and external representations.

Definition at line 117 of file itkVectorImage.h.

◆ ConstPointer

template<typename TPixel, unsigned int VImageDimension = 3>

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

Definition at line 90 of file itkVectorImage.h.

◆ ConstWeakPointer

template<typename TPixel, unsigned int VImageDimension = 3>

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

Definition at line 91 of file itkVectorImage.h.

◆ InternalPixelType

template<typename TPixel, unsigned int VImageDimension = 3>

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

This is the actual pixel type contained in the buffer. Each vector pixel is composed of 'm_VectorLength' contiguous InternalPixelType.

Definition at line 108 of file itkVectorImage.h.

◆ IOPixelType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::IOPixelType = InternalPixelType

Definition at line 113 of file itkVectorImage.h.

◆ NeighborhoodAccessorFunctorType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType = VectorImageNeighborhoodAccessorFunctor<Self>

Typedef for the functor used to access a neighborhood of pixel pointers.

Definition at line 125 of file itkVectorImage.h.

◆ PixelContainer

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::PixelContainer = ImportImageContainer<SizeValueType, InternalPixelType>

Container used to store pixels in the image.

Definition at line 144 of file itkVectorImage.h.

◆ PixelContainerConstPointer

template<typename TPixel, unsigned int VImageDimension = 3>

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

Definition at line 163 of file itkVectorImage.h.

◆ PixelContainerPointer

template<typename TPixel, unsigned int VImageDimension = 3>

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

A pointer to the pixel container.

Definition at line 162 of file itkVectorImage.h.

◆ PixelType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::PixelType = VariableLengthVector<TPixel>

Pixel type alias support Used to declare pixel type in filters or other operations. This is not the actual pixel type contained in the buffer, ie m_Buffer. The image exhibits an external API of an VariableLengthVector< T > and internally stores its data as type T.

Definition at line 103 of file itkVectorImage.h.

◆ Pointer

template<typename TPixel, unsigned int VImageDimension = 3>

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

Definition at line 89 of file itkVectorImage.h.

◆ RebindImageType

template<typename TPixel, unsigned int VImageDimension = 3>

template<typename UPixelType , unsigned int VUImageDimension = VImageDimension>

using itk::VectorImage< TPixel, VImageDimension >::RebindImageType = typename Rebind<UPixelType, VUImageDimension>::Type

Definition at line 201 of file itkVectorImage.h.

◆ Self

template<typename TPixel, unsigned int VImageDimension = 3>

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

Standard class type aliases

Definition at line 87 of file itkVectorImage.h.

◆ Superclass

template<typename TPixel, unsigned int VImageDimension = 3>

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

Definition at line 88 of file itkVectorImage.h.

◆ ValueType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::ValueType = PixelType

Typedef alias for PixelType

Definition at line 111 of file itkVectorImage.h.

◆ VectorLengthType

template<typename TPixel, unsigned int VImageDimension = 3>

using itk::VectorImage< TPixel, VImageDimension >::VectorLengthType = unsigned int

Definition at line 168 of file itkVectorImage.h.

Constructor & Destructor Documentation

◆ VectorImage()

template<typename TPixel, unsigned int VImageDimension = 3>

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

protecteddefault

◆ ~VectorImage()

template<typename TPixel, unsigned int VImageDimension = 3>

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

overrideprotecteddefault

Member Function Documentation

◆ Allocate()

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< TPixel, VImageDimension >::Allocate ( bool UseValueInitialization = 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 = 3>

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

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

◆ GetBufferPointer() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

InternalPixelType* itk::VectorImage< TPixel, VImageDimension >::GetBufferPointer ( )

inline

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

Definition at line 296 of file itkVectorImage.h.

◆ GetBufferPointer() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

const InternalPixelType* itk::VectorImage< 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 301 of file itkVectorImage.h.

◆ GetNameOfClass()

template<typename TPixel, unsigned int VImageDimension = 3>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageBase< VImageDimension >.

◆ GetNeighborhoodAccessor() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

NeighborhoodAccessorFunctorType itk::VectorImage< TPixel, VImageDimension >::GetNeighborhoodAccessor ( )

inline

Return the NeighborhoodAccessor functor

Definition at line 355 of file itkVectorImage.h.

◆ GetNeighborhoodAccessor() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

const NeighborhoodAccessorFunctorType itk::VectorImage< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const

inline

Return the NeighborhoodAccessor functor

Definition at line 362 of file itkVectorImage.h.

◆ GetNumberOfComponentsPerPixel()

template<typename TPixel, unsigned int VImageDimension = 3>

unsigned int itk::VectorImage< TPixel, VImageDimension >::GetNumberOfComponentsPerPixel ( ) const

overridevirtual

Get/Set the number of components each pixel has, ie the VectorLength

Reimplemented from itk::ImageBase< VImageDimension >.

◆ GetPixel() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Get a "reference" to a pixel. This result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.

To use the results to modify this image, return value optimization must be relied upon.

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

Definition at line 259 of file itkVectorImage.h.

◆ GetPixel() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

const PixelType itk::VectorImage< 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. Note that the method returns a pixel on the stack.

Definition at line 240 of file itkVectorImage.h.

◆ GetPixelAccessor() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Return the Pixel Accessor object

Definition at line 341 of file itkVectorImage.h.

◆ GetPixelAccessor() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Return the Pixel Accesor object

Definition at line 348 of file itkVectorImage.h.

◆ GetPixelContainer() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Return a pointer to the container.

Definition at line 309 of file itkVectorImage.h.

◆ GetPixelContainer() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Return a pointer to the container.

Definition at line 316 of file itkVectorImage.h.

◆ GetVectorLength()

template<typename TPixel, unsigned int VImageDimension = 3>

virtual const VectorLengthType& itk::VectorImage< TPixel, VImageDimension >::GetVectorLength ( ) const

virtual

Set/Get macros for the length of each vector in the vector image

◆ Graft() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< TPixel, VImageDimension >::Graft ( const DataObject * image )

overrideprotectedvirtual

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. Subclasses of ImageBase are responsible for copying the pixel container.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ Graft() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

virtual void itk::VectorImage< TPixel, VImageDimension >::Graft ( const Self * image )

virtual

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ Initialize()

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< 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 = 3>

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

static

Method for creation through the object factory.

◆ operator[]() [1/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Access a pixel. This result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.

To use the results to modify this image, return value optimization must be relied upon.

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

Definition at line 278 of file itkVectorImage.h.

◆ operator[]() [2/2]

template<typename TPixel, unsigned int VImageDimension = 3>

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

inline

Access a pixel.

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

Definition at line 288 of file itkVectorImage.h.

◆ PrintSelf()

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< 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 >.

◆ SetNumberOfComponentsPerPixel()

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< TPixel, VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int )

overridevirtual

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

outputImage->SetNumberOfComponentsPerPixel(

inputImage->GetNumberOfComponentsPerPixel() )

See also: ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that in the ImageBase implementation, this always returns 1. Image returns the

returned from NumericTraits for the pixel type, and VectorImage

returns the vector length set by the user.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ SetPixel()

template<typename TPixel, unsigned int VImageDimension = 3>

void itk::VectorImage< TPixel, VImageDimension >::SetPixel	(	const IndexType &	index,
		const PixelType &	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 224 of file itkVectorImage.h.

◆ SetPixelContainer()

template<typename TPixel, unsigned int VImageDimension = 3>

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

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

◆ SetVectorLength()

template<typename TPixel, unsigned int VImageDimension = 3>

virtual void itk::VectorImage< TPixel, VImageDimension >::SetVectorLength ( VectorLengthType _arg )

virtual

Set/Get macros for the length of each vector in the vector image

Member Data Documentation

◆ ImageDimension

template<typename TPixel, unsigned int VImageDimension = 3>

constexpr unsigned int itk::VectorImage< 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 131 of file itkVectorImage.h.

◆ m_Buffer

template<typename TPixel, unsigned int VImageDimension = 3>

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

private

Memory for the current buffer.

Definition at line 394 of file itkVectorImage.h.

◆ m_VectorLength

template<typename TPixel, unsigned int VImageDimension = 3>

VectorLengthType itk::VectorImage< TPixel, VImageDimension >::m_VectorLength { 0 }

private

Length of the "vector pixel"

Definition at line 391 of file itkVectorImage.h.

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

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 3> class itk::VectorImage< TPixel, VImageDimension >

Classes

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

◆ NeighborhoodAccessorFunctorType

◆ PixelContainer

◆ PixelContainerConstPointer

◆ PixelContainerPointer

◆ PixelType

◆ Pointer

◆ RebindImageType

◆ Self

◆ Superclass

◆ ValueType

◆ VectorLengthType

Constructor & Destructor Documentation

◆ VectorImage()

◆ ~VectorImage()

Member Function Documentation

◆ Allocate()

◆ FillBuffer()

◆ GetBufferPointer() [1/2]

◆ GetBufferPointer() [2/2]

◆ GetNameOfClass()

◆ GetNeighborhoodAccessor() [1/2]

◆ GetNeighborhoodAccessor() [2/2]

◆ GetNumberOfComponentsPerPixel()

◆ GetPixel() [1/2]

◆ GetPixel() [2/2]

◆ GetPixelAccessor() [1/2]

◆ GetPixelAccessor() [2/2]

◆ GetPixelContainer() [1/2]

◆ GetPixelContainer() [2/2]

◆ GetVectorLength()

◆ Graft() [1/2]

◆ Graft() [2/2]

◆ Initialize()

◆ New()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PrintSelf()

◆ SetNumberOfComponentsPerPixel()

returned from NumericTraits for the pixel type, and VectorImage

◆ SetPixel()

◆ SetPixelContainer()

◆ SetVectorLength()

Member Data Documentation

◆ ImageDimension

◆ m_Buffer

◆ m_VectorLength

template<typename TPixel, unsigned int VImageDimension = 3>
class itk::VectorImage< TPixel, VImageDimension >