#include <itkContinuousBorderWarpImageFilter.h>

Inheritance diagram for itk::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >:

Collaboration diagram for itk::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >:

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TDisplacementField>
class itk::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >

Warps an image using an input deformation field with continuous boundary conditions.

ContinuousBorderWarpImageFilter warps an existing image with respect to a given displacement field and a given interpolation scheme.The default interpolation typed used is the LinearInterpolateImageFunction. The user can specify a particular interpolation function via SetInterpolator().

Positions mapped to outside of the input image buffer are assigned the value of the next boundary pixel in the image.

The input image is set via SetInput(). The input displacement field is set via SetDisplacementField().

This filter is implemented as a multithreaded filter.

See Also: WarpImageFilter

Warning: This filter assumes that the input type, output type and displacement field type all have the same number of dimensions.

Note: This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).

Author: Alexander Schmidt-Richberg; Rene Werner; Jan Ehrhardt

Definition at line 63 of file itkContinuousBorderWarpImageFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	DisplacementType = typename DisplacementFieldType::PixelType

using	IndexType = typename OutputImageType::IndexType

using	InputImageConstPointer = typename Superclass::InputImageConstPointer

using	InputImagePointer = typename Superclass::InputImagePointer

using	InputImageType = typename Superclass::InputImageType

using	InterpolatorType = typename Superclass::InterpolatorType

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = typename Superclass::OutputImageType

using	PixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename Superclass::PointType

using	Self = ContinuousBorderWarpImageFilter

using	SizeType = typename OutputImageType::SizeType

using	SpacingType = typename OutputImageType::SpacingType

using	Superclass = WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >

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

using	CoordRepType = double

using	DefaultInterpolatorType = LinearInterpolateImageFunction< InputImageType, CoordRepType >

using	DirectionType = typename TOutputImage::DirectionType

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	DisplacementType = typename DisplacementFieldType::PixelType

using	ImageBaseType = ImageBase< Self::ImageDimension >

using	IndexType = typename OutputImageType::IndexType

using	IndexValueType = typename OutputImageType::IndexValueType

using	InputImageConstPointer = typename Superclass::InputImageConstPointer

using	InputImagePointer = typename Superclass::InputImagePointer

using	InputImageType = typename Superclass::InputImageType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = InterpolateImageFunction< InputImageType, CoordRepType >

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageType = typename Superclass::OutputImageType

using	PixelComponentType = typename OutputImageType::InternalPixelType

using	PixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = Point< CoordRepType, Self::ImageDimension >

using	Self = WarpImageFilter

using	SizeType = typename OutputImageType::SizeType

using	SpacingType = typename OutputImageType::SpacingType

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

virtual const DisplacementFieldType *	GetDisplacementField () const

virtual PixelType	GetEdgePaddingValue () const

virtual const PointType &	GetOutputOrigin () const

virtual const SizeType &	GetOutputSize () const

virtual const SpacingType &	GetOutputSpacing () const

virtual const IndexType &	GetOutputStartIndex () const

virtual void	SetDisplacementField (const DisplacementFieldType *input)

virtual void	SetEdgePaddingValue (PixelType _arg)

void	SetOutputParametersFromImage (const ImageBaseType *image)

virtual void	SetOutputSize (SizeType _arg)

virtual void	SetOutputStartIndex (IndexType _arg)

virtual void	SetInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const InterpolatorType *	GetInterpolator () const

virtual void	SetOutputSpacing (SpacingType _arg)

virtual void	SetOutputSpacing (const double *values)

virtual void	SetOutputOrigin (PointType _arg)

virtual void	SetOutputOrigin (const double *values)

virtual void	SetOutputDirection (DirectionType _arg)

virtual const DirectionType &	GetOutputDirection () const

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

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

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 >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

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

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

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

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

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

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

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	DeformationFieldDimension = TDisplacementField::ImageDimension

static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >
static constexpr unsigned int	DisplacementFieldDimension = TDisplacementField::ImageDimension

static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = 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
	ContinuousBorderWarpImageFilter ()=default

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	~ContinuousBorderWarpImageFilter () override=default

Protected Member Functions inherited from itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >
void	EvaluateDisplacementAtPhysicalPoint (const PointType &p, DisplacementType &output)

void	EvaluateDisplacementAtPhysicalPoint (const PointType &p, const DisplacementFieldType *fieldPtr, DisplacementType &output)

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

void	VerifyInputInformation () ITKv5_CONST override

	WarpImageFilter ()

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)

	ImageToImageFilter ()

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

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

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

	~ImageSource () override=default

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

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 num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () ITKv5_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 idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

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

Protected Attributes inherited from itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >
bool	m_DefFieldSameInformation

IndexType	m_EndIndex

IndexType	m_StartIndex

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

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

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