#include <itkVectorImageToImageAdaptor.h>

Detailed Description

template<typename TPixelType, unsigned int Dimension>
class itk::VectorImageToImageAdaptor< TPixelType, Dimension >

Presents a VectorImage and extracts a component from it into an image.

The class is expected to be templated over a pixel type and dimension. These are the pixel types and dimension of the VectorImage.

The component to extract is set with SetExtractComponentIdx() method.

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.

ITK Sphinx Examples:

All ITK Sphinx Examples

View Component Vector Image As Scalar Image

Examples: SphinxExamples/src/Core/ImageAdaptors/ViewComponentVectorImageAsScaleImage/Code.cxx.

Definition at line 146 of file itkVectorImageToImageAdaptor.h.

Inheritance diagram for itk::VectorImageToImageAdaptor< TPixelType, Dimension >:

Collaboration diagram for itk::VectorImageToImageAdaptor< TPixelType, Dimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = VectorImageToImageAdaptor

using	Superclass = ImageAdaptor< VectorImageType, Accessor::VectorImageToImagePixelAccessor< TPixelType > >

using	VectorImageType = VectorImage< TPixelType, Dimension >

using	VectorLengthType = typename VectorImageType::VectorLengthType

Public Types inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
using	AccessorFunctorType = typename InternalImageType::AccessorFunctorType::template Rebind< Self >::Type

using	AccessorType = Accessor::VectorImageToImagePixelAccessor< TPixelType >

using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	IndexValueType = typename IndexType::IndexValueType

using	InternalImageType = VectorImage< TPixelType, Dimension >

using	InternalPixelType = typename Accessor::VectorImageToImagePixelAccessor< TPixelType > ::InternalType

using	IOPixelType = PixelType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelContainer = typename VectorImage< TPixelType, Dimension > ::PixelContainer

using	PixelContainerConstPointer = typename VectorImage< TPixelType, Dimension > ::PixelContainerConstPointer

using	PixelContainerPointer = typename VectorImage< TPixelType, Dimension > ::PixelContainerPointer

using	PixelType = typename Accessor::VectorImageToImagePixelAccessor< TPixelType > ::ExternalType

using	Pointer = SmartPointer< Self >

using	RebindImageType = itk::Image< UPixelType, VUImageDimension >

using	Self = ImageAdaptor

using	SizeValueType = typename SizeType::SizeValueType

using	Superclass = ImageBase< Self::ImageDimension >

Public Types inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
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
VectorLengthType	GetExtractComponentIndex () const

const char *	GetNameOfClass () const override

void	SetExtractComponentIndex (VectorLengthType componentIdx)

Public Member Functions inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
void	Allocate (bool initialize=false) override

IndexType	ComputeIndex (OffsetValueType offset) const

void	CopyInformation (const DataObject *data) override

const RegionType &	GetBufferedRegion () const override

InternalPixelType *	GetBufferPointer ()

const InternalPixelType *	GetBufferPointer () const

const DirectionType &	GetDirection () const override

const RegionType &	GetLargestPossibleRegion () const override

ModifiedTimeType	GetMTime () const override

const char *	GetNameOfClass () const override

const OffsetValueType *	GetOffsetTable () const

const PointType &	GetOrigin () const override

PixelType	GetPixel (const IndexType &index) const

AccessorType &	GetPixelAccessor ()

const AccessorType &	GetPixelAccessor () const

PixelContainerPointer	GetPixelContainer ()

const PixelContainer *	GetPixelContainer () const

const RegionType &	GetRequestedRegion () const override

const SpacingType &	GetSpacing () const override

virtual void	Graft (const Self *imgData)

void	Initialize () override

void	Modified () const override

PixelType	operator[] (const IndexType &index) const

void	PropagateRequestedRegion () override

void	SetBufferedRegion (const RegionType &region) override

void	SetDirection (const DirectionType &direction) override

virtual void	SetImage (VectorImage< TPixelType, Dimension > *)

void	SetLargestPossibleRegion (const RegionType &region) override

void	SetOrigin (const double *origin) override

void	SetOrigin (const float *origin) override

void	SetOrigin (const PointType origin) override

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

void	SetPixelAccessor (const AccessorType &accessor)

void	SetPixelContainer (PixelContainer *container)

void	SetRequestedRegion (const DataObject *data) override

void	SetRequestedRegion (const RegionType &region) override

void	SetRequestedRegionToLargestPossibleRegion () override

void	SetSpacing (const double *spacing) override

void	SetSpacing (const float *spacing) override

void	SetSpacing (const SpacingType &spacing) override

void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordinate, Self::ImageDimension > &index, Point< TCoordinate, Self::ImageDimension > &point) const

Point< TCoordinate, VectorImage< TPixelType, Dimension > ::ImageDimension >	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, Self::ImageDimension > &index) const

Point< TCoordinate, Self::ImageDimension >	TransformIndexToPhysicalPoint (const IndexType &index) const

void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordinate, Self::ImageDimension > &point) const

void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordinate, Self::ImageDimension > &inputGradient, FixedArray< TCoordinate, Self::ImageDimension > &outputGradient) const

TVector	TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const

bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordinate, Self::ImageDimension > &point, ContinuousIndex< TCoordinate, Self::ImageDimension > &index) const

ContinuousIndex< TIndexRep, VectorImage< TPixelType, Dimension > ::ImageDimension >	TransformPhysicalPointToContinuousIndex (const Point< TCoordinate, VectorImage< TPixelType, Dimension > ::ImageDimension > &point) const

IndexType	TransformPhysicalPointToIndex (const Point< TCoordinate, Self::ImageDimension > &point) const

bool	TransformPhysicalPointToIndex (const Point< TCoordinate, Self::ImageDimension > &point, IndexType &index) const

void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordinate, Self::ImageDimension > &inputGradient, FixedArray< TCoordinate, Self::ImageDimension > &outputGradient) const

TVector	TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const

void	Update () override

void	UpdateOutputData () override

void	UpdateOutputInformation () override

bool	VerifyRequestedRegion () override

Public Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
void	AllocateInitialized ()

OffsetValueType	ComputeOffset (const IndexType &ind) const

virtual const DirectionType &	GetInverseDirection () 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	SetRegions (const SizeType &size)

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

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

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

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

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

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 double spacing[VImageDimension])

virtual void	SetSpacing (const float spacing[VImageDimension])

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

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

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

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

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

TVector	TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const

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

void	ReleaseData ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

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 const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) 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::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
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 ()

Protected Member Functions
	VectorImageToImageAdaptor ()=default

	~VectorImageToImageAdaptor () override=default

Protected Member Functions inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
void	Graft (const DataObject *data) override

	ImageAdaptor ()

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

	~ImageAdaptor () override=default

Protected Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
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 ()

Additional Inherited Members
Static Public Attributes inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
static constexpr ImageDimensionType	ImageDimension

Protected Attributes inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
SpacingType	m_Spacing

PointType	m_Origin

DirectionType	m_Direction

DirectionType	m_InverseDirection

DirectionType	m_IndexToPhysicalPoint

DirectionType	m_PhysicalPointToIndex

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