#include <itkInterpolateImagePointsFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>
class itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >

Resamples an image at the coordinates specified by the user.

This class may be templated over the Interpolate Function but defaults to the BSplineInterpolateImageFunction for cubic interpolation. The user must set the image using the SetInputImage function and they must set the coordinates (one coordinate "image" for each dimension) using SetInterpolationCoordinate(). The coordinates may be any number of points and can be randomly organized. The interpolated output will correspond to the ordering of the coordinate points. The coordinates must be of type ContinuousIndexType and not of PointType.

This function is different from the resampleImageFilter class in that the resampleImageFilter applies a transform to the original input image coordinates. This function takes an arbitrary set of point coordinates and applies the transform at these locations.

Limitations: The coordinates must be in an image of the same dimension as the input image. There is no reason why this should be the case and future revisions should look at eliminating this limitation. Currently TCoordType must be the same as the input pixel type (TInputImage). Again future revisions should look at eliminating this limitation. Though the output generation may be streamed the entire input image, must be supplied. The coordinates may be streamed in smaller blocks. The coordinates are specified as separate images for each dimension. The coordinates are treated as Continuous Indices. If coordinates are supplied as Points then they must be converted to an Index before passing to this class.

See also: BSplineInterpolateImageFunction; ResampleImageFilter

Definition at line 80 of file itkInterpolateImagePointsFilter.h.

Inheritance diagram for itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >:

Collaboration diagram for itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = typename InterpolatorType::ContinuousIndexType

using	CoordImageType = Image< TCoordType, Self::ImageDimension >

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	OutputImageIterator = ImageRegionIterator< InputImageType >

using	OutputImagePointer = typename TOutputImage::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	PixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::ImageDimension, Self::ImageDimension >

using	Self = InterpolateImagePointsFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

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

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

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

void	GenerateOutputInformation () override

virtual PixelType	GetDefaultPixelValue () const

InterpolatorPointer	GetInterpolator ()

const char *	GetNameOfClass () const override

virtual void	SetDefaultPixelValue (PixelType _arg)

void	SetInputImage (const TInputImage *inputImage)

void	SetInterpolationCoordinate (const CoordImageType *coordinate, unsigned int setDimension)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () 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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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 = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	InterpolateImagePointsFilter ()

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

void	VerifyInputInformation () const override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

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

virtual	~LightObject ()

Private Types
using	CoordImageIterator = ImageRegionConstIterator< CoordImageType >

using	CoordImageRegionType = typename CoordImageType::RegionType

using	CoordImageTypePointer = typename CoordImageType::Pointer

Private Attributes
PixelType	m_DefaultPixelValue {}

InterpolatorPointer	m_Interpolator {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::ConstPointer = SmartPointer<const Self>

Definition at line 89 of file itkInterpolateImagePointsFilter.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::ContinuousIndexType = typename InterpolatorType::ContinuousIndexType

Definition at line 115 of file itkInterpolateImagePointsFilter.h.

◆ CoordImageIterator

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::CoordImageIterator = ImageRegionConstIterator<CoordImageType>

private

Definition at line 188 of file itkInterpolateImagePointsFilter.h.

◆ CoordImageRegionType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::CoordImageRegionType = typename CoordImageType::RegionType

private

Definition at line 189 of file itkInterpolateImagePointsFilter.h.

◆ CoordImageType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::CoordImageType = Image<TCoordType, Self::ImageDimension>

Typedefs to describe and access coordinate images

Definition at line 118 of file itkInterpolateImagePointsFilter.h.

◆ CoordImageTypePointer

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::CoordImageTypePointer = typename CoordImageType::Pointer

private

Typedefs to describe and access coordinate images

Definition at line 187 of file itkInterpolateImagePointsFilter.h.

◆ InterpolatorPointer

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::InterpolatorPointer = typename InterpolatorType::Pointer

Typedefs to describe and access Interpolator

Definition at line 114 of file itkInterpolateImagePointsFilter.h.

◆ OutputImageIterator

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::OutputImageIterator = ImageRegionIterator<InputImageType>

Definition at line 107 of file itkInterpolateImagePointsFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::OutputImagePointer = typename TOutputImage::Pointer

Typedefs to describe and access output image.

Definition at line 106 of file itkInterpolateImagePointsFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 108 of file itkInterpolateImagePointsFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::PixelType = typename TOutputImage::PixelType

Image pixel value type alias.

Definition at line 111 of file itkInterpolateImagePointsFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::Pointer = SmartPointer<Self>

Definition at line 88 of file itkInterpolateImagePointsFilter.h.

◆ RegionCopierType

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::RegionCopierType = ImageToImageFilterDetail::ImageRegionCopier<Self::ImageDimension, Self::ImageDimension>

Typedef for region copier

Definition at line 121 of file itkInterpolateImagePointsFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::Self = InterpolateImagePointsFilter

Standard class type aliases.

Definition at line 86 of file itkInterpolateImagePointsFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

using itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 87 of file itkInterpolateImagePointsFilter.h.

Constructor & Destructor Documentation

◆ InterpolateImagePointsFilter()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::InterpolateImagePointsFilter ( )

protected

Member Function Documentation

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

Main function for calculating interpolated values at each coordinate set. Access is through the Update() call.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::GenerateInputRequestedRegion ( )

overridevirtual

Overloaded to set the input image to the largest possible region

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::GenerateOutputInformation ( )

overridevirtual

Overloaded to ensure that output is sized the same as the coordinate inputs and not the size of the input image.

Reimplemented from itk::ProcessObject.

◆ GetDefaultPixelValue()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

virtual PixelType itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::GetDefaultPixelValue ( ) const

virtual

Get the pixel value when a transformed pixel is outside of the image

◆ GetInterpolator()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

InterpolatorPointer itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::GetInterpolator ( )

inline

Returns a pointer to the interpolator.

Definition at line 143 of file itkInterpolateImagePointsFilter.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

const char * itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ New()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

static Pointer itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::New ( )

static

New macro for creation of through a Smart Pointer

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::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::ImageToImageFilter< TInputImage, TOutputImage >.

◆ SetDefaultPixelValue()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

virtual void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::SetDefaultPixelValue ( PixelType _arg )

virtual

Set the pixel value when a transformed pixel is outside of the image

◆ SetInputImage()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::SetInputImage ( const TInputImage * inputImage )

SetInputImage is used to set the image to be interpolated. Note that this should be used instead of the direct setInput as multiple inputs are needed and this class keeps track of the ordering.

◆ SetInterpolationCoordinate()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::SetInterpolationCoordinate	(	const CoordImageType *	coordinate,
		unsigned int	setDimension
	)

SetInterpolationCoordinate must be called for each dimension. The variable setDimension is used to identify the dimension being set, i.e. 0,1,2...N

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

void itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::VerifyInputInformation ( ) const

inlineoverrideprotectedvirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also: ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 182 of file itkInterpolateImagePointsFilter.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

constexpr unsigned int itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension enumeration.

Definition at line 98 of file itkInterpolateImagePointsFilter.h.

◆ m_DefaultPixelValue

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

PixelType itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::m_DefaultPixelValue {}

private

Definition at line 192 of file itkInterpolateImagePointsFilter.h.

◆ m_Interpolator

template<typename TInputImage , typename TOutputImage , typename TCoordType = typename TInputImage::PixelType, typename InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType>>

InterpolatorPointer itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >::m_Interpolator {}

private

Definition at line 191 of file itkInterpolateImagePointsFilter.h.

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

itkInterpolateImagePointsFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ CoordImageIterator

◆ CoordImageRegionType

◆ CoordImageType

◆ CoordImageTypePointer

◆ InterpolatorPointer

◆ OutputImageIterator

◆ OutputImagePointer

◆ OutputImageRegionType

◆ PixelType

◆ Pointer

◆ RegionCopierType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ InterpolateImagePointsFilter()

Member Function Documentation

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetDefaultPixelValue()

◆ GetInterpolator()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetDefaultPixelValue()

◆ SetInputImage()

◆ SetInterpolationCoordinate()

◆ VerifyInputInformation()

Member Data Documentation

◆ ImageDimension

◆ m_DefaultPixelValue

◆ m_Interpolator