#include <itkImageToImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::ImageToImageFilter< TInputImage, TOutputImage >

Base class for filters that take an image as input and produce an image as output.

ImageToImageFilter is the base class for all process objects that output image data and require image data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

This class provides the infrastructure for supporting multithreaded processing of images. If a filter provides an implementation of GenerateData(), the image processing will run in a single thread and the implementation is responsible for allocating its output data. If a filter provides an implementation of ThreadedGenerateData() instead, the image will be divided into a number of work units, a number of threads will be spawned, and ThreadedGenerateData() will be called in each thread. Here, the output memory will be allocated by this superclass prior to calling ThreadedGenerateData().

ImageToImageFilter provides an implementation of GenerateInputRequestedRegion(). The base assumption to this point in the hierarchy is that a process object would ask for the largest possible region on input in order to produce any output. Imaging filters, however, can usually answer this question more precisely. The default implementation of GenerateInputRequestedRegion() in this class is to request an input that matches the size of the requested output. If a filter requires more input (say a filter that uses neighborhood information) or less input (for instance a magnify filter), then these filters will have to provide another implementation of this method. By convention, such implementations should call the Superclass' method first.

All inputs to ImageToImageFilter (if there is more than one) are checked in the VerifyInputInformation() method to verify that they occupy the same physical space. If the input images are in the same physical space, then the location of each voxel is identical, and the filter can operate voxel-by-voxel in index space. Some filters – registration filters, for example – will violate this precondition, in which case they should redefine VerifyInputInformation() to relax or eliminate this requirement.

Access methods – Set/GetCoordinateTolerance and Set/GetDirectionTolerance – are provided for cases where the default spatial-congruency tolerances are too fine, and images that are almost in the same space should be regard as being in the same space. This has come up, for example when comparing different on-disk image formats with differing digits of precision in the position, spacing, and orientation.

The default tolerance is govern by the GlobalDefaultCoordinateTolerance and the GlobalDefaultDirectionTolerance properties, defaulting to 1.0e-6. The default tolerance for spatial comparison is then scaled by the voxelSpacing for coordinates (i.e. the coordinates must be the same to within one part per million). For the direction cosines the values must be within the current absolute tolerance.

ITK Sphinx Examples:

<a href=
<a href=
<a href=
<a href=
<a href=
<a href=
<a href=
<a href=

Definition at line 108 of file itkImageToImageFilter.h.

Inheritance diagram for itk::ImageToImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::ImageToImageFilter< TInputImage, TOutputImage >:

Public Types
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
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 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	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 Types
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

Protected Member Functions
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 void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

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 Attributes
double	m_CoordinateTolerance {}

double	m_DirectionTolerance {}

Additional Inherited Members
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 {}

Static Private Member Functions inherited from itk::ImageToImageFilterCommon
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 119 of file itkImageToImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 131 of file itkImageToImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 133 of file itkImageToImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 130 of file itkImageToImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 132 of file itkImageToImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 129 of file itkImageToImageFilter.h.

◆ InputToOutputRegionCopierType

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier<Self::OutputImageDimension, Self::InputImageDimension>

protected

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 280 of file itkImageToImageFilter.h.

◆ OutputToInputRegionCopierType

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier<Self::InputImageDimension, Self::OutputImageDimension>

protected

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 285 of file itkImageToImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 118 of file itkImageToImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::Self = ImageToImageFilter

Standard class type aliases.

Definition at line 116 of file itkImageToImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::ImageToImageFilter< TInputImage, TOutputImage >::Superclass = ImageSource<TOutputImage>

Definition at line 117 of file itkImageToImageFilter.h.

Constructor & Destructor Documentation

◆ ImageToImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::ImageToImageFilter< TInputImage, TOutputImage >::ImageToImageFilter ( )

protected

◆ ~ImageToImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::ImageToImageFilter< TInputImage, TOutputImage >::~ImageToImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CallCopyInputRegionToOutputRegion()

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)

protectedvirtual

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

◆ CallCopyOutputRegionToInputRegion()

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)

protectedvirtual

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetCoordinateTolerance()

template<typename TInputImage , typename TOutputImage >

virtual double itk::ImageToImageFilter< TInputImage, TOutputImage >::GetCoordinateTolerance ( ) const

virtual

get/set the Coordinate tolerance This tolerance is used when comparing the space defined by the input images. ITK has a requirement that multiple input images be congruent in space by default.

◆ GetDirectionTolerance()

template<typename TInputImage , typename TOutputImage >

virtual double itk::ImageToImageFilter< TInputImage, TOutputImage >::GetDirectionTolerance ( ) const

virtual

get/set the direction tolerance This tolerance is used to make sure that all input images are oriented the same before performing the filter's transformations.

◆ GetGlobalDefaultCoordinateTolerance()

template<typename TInputImage , typename TOutputImage >

static double itk::ImageToImageFilterCommon::GetGlobalDefaultCoordinateTolerance ( )

static

◆ GetGlobalDefaultDirectionTolerance()

template<typename TInputImage , typename TOutputImage >

static double itk::ImageToImageFilterCommon::GetGlobalDefaultDirectionTolerance ( )

static

◆ GetInput() [1/2]

template<typename TInputImage , typename TOutputImage >

const InputImageType * itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( ) const

Referenced by itk::VectorIndexSelectionCastImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::AreaClosingImageFilter< TInputImage, TOutputImage, TAttribute >::GenerateData(), and itk::AreaOpeningImageFilter< TInputImage, TOutputImage, TAttribute >::GenerateData().

◆ GetInput() [2/2]

template<typename TInputImage , typename TOutputImage >

const InputImageType * itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( unsigned int idx ) const

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::ImageToImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ PopBackInput()

template<typename TInputImage , typename TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput ( )

overridevirtual

Reimplemented from itk::ProcessObject.

◆ PopFrontInput()

template<typename TInputImage , typename TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput ( )

overridevirtual

Reimplemented from itk::ProcessObject.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

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

◆ PushBackInput() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input )

protectedvirtual

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

◆ PushBackInput() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput ( const InputImageType * input )

virtual

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

◆ PushFrontInput() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input )

protectedvirtual

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

◆ PushFrontInput() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput ( const InputImageType * input )

virtual

◆ SetCoordinateTolerance()

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetCoordinateTolerance ( double _arg )

virtual

get/set the Coordinate tolerance This tolerance is used when comparing the space defined by the input images. ITK has a requirement that multiple input images be congruent in space by default.

◆ SetDirectionTolerance()

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetDirectionTolerance ( double _arg )

virtual

get/set the direction tolerance This tolerance is used to make sure that all input images are oriented the same before performing the filter's transformations.

◆ SetGlobalDefaultCoordinateTolerance()

template<typename TInputImage , typename TOutputImage >

static void itk::ImageToImageFilterCommon::SetGlobalDefaultCoordinateTolerance ( double )

static

get/set the global default coordinate tolerance

This value is used to initialize the CoordinateTolerance upon class construction of any ImageToImage filter. This has no effect on currently constructed classes.

◆ SetGlobalDefaultDirectionTolerance()

template<typename TInputImage , typename TOutputImage >

static void itk::ImageToImageFilterCommon::SetGlobalDefaultDirectionTolerance ( double )

static

get/set the global default direction tolerance

This value is used to initialize the DirectionTolerance upon class construction of any ImageToImage filter. This has no effect on currently constructed classes.

◆ SetInput() [1/3]

template<typename TInputImage , typename TOutputImage >

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

virtual

Set/Get the image input of this process object.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >.

◆ SetInput() [2/3]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput ( const InputImageType * input )

virtual

Reimplemented in itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >, and itk::WatershedImageFilter< TInputImage >.

◆ SetInput() [3/3]

template<typename TInputImage , typename TOutputImage >

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput	(	unsigned int	,
		const TInputImage *	image
	)

virtual

Reimplemented in itk::WatershedImageFilter< TInputImage >, and itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >.

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage >

void itk::ImageToImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( ) const

overrideprotectedvirtual

Verifies that the input images occupy the same physical space and the each index is at the same physical location.

The default implementation of the PropagateRequestedRegion() methods copies the index and size from the output to the input. This makes an implicit assumption that the images occupy the same physical location at each voxel. This method enforces that they are the same.

This implementation verifies that all input images of InputImageDimensions have the same origin, spacing and direction.

Filters which do not expect all input images to be at the same physical location should over-ride this method. Also filters whose inputs are different dimensions may need to override this method.

See also: ProcessObject::VerifyInputInformation

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 136 of file itkImageToImageFilter.h.

◆ m_CoordinateTolerance

template<typename TInputImage , typename TOutputImage >

double itk::ImageToImageFilter< TInputImage, TOutputImage >::m_CoordinateTolerance {}

private

Tolerances for checking whether input images are defined to occupy the same physical space.

Definition at line 376 of file itkImageToImageFilter.h.

◆ m_DirectionTolerance

template<typename TInputImage , typename TOutputImage >

double itk::ImageToImageFilter< TInputImage, TOutputImage >::m_DirectionTolerance {}

private

Definition at line 377 of file itkImageToImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 137 of file itkImageToImageFilter.h.

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

itkImageToImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ InputToOutputRegionCopierType

◆ OutputToInputRegionCopierType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageToImageFilter()

◆ ~ImageToImageFilter()

Member Function Documentation

◆ CallCopyInputRegionToOutputRegion()

◆ CallCopyOutputRegionToInputRegion()

◆ GenerateInputRequestedRegion()

◆ GetCoordinateTolerance()

◆ GetDirectionTolerance()

◆ GetGlobalDefaultCoordinateTolerance()

◆ GetGlobalDefaultDirectionTolerance()

◆ GetInput() [1/2]

◆ GetInput() [2/2]

◆ GetNameOfClass()

◆ PopBackInput()

◆ PopFrontInput()

◆ PrintSelf()

◆ PushBackInput() [1/2]

◆ PushBackInput() [2/2]

◆ PushFrontInput() [1/2]

◆ PushFrontInput() [2/2]

◆ SetCoordinateTolerance()

◆ SetDirectionTolerance()

◆ SetGlobalDefaultCoordinateTolerance()

◆ SetGlobalDefaultDirectionTolerance()

◆ SetInput() [1/3]

◆ SetInput() [2/3]

◆ SetInput() [3/3]

◆ VerifyInputInformation()

Member Data Documentation

◆ InputImageDimension

◆ m_CoordinateTolerance

◆ m_DirectionTolerance

◆ OutputImageDimension