itk::TileImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkTileImageFilter.h>

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

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

Detailed Description

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

Tile multiple input images into a single output image.

This filter will tile multiple images using a user-specified layout. The tile sizes will be large enough to accommodate the largest image for each tile. The layout is specified with the SetLayout method. The layout has the same dimension as the output image. If all entries of the layout are positive, the tiled output will contain the exact number of tiles. If the layout contains a 0 in the last dimension, the filter will compute a size that will accommodate all of the images. Empty tiles are filled with the value specified with the SetDefault value method. The input images must have a dimension less than or equal to the output image. The output image have a larger dimension than the input images. This filter can be used to create a volume from a series of inputs by specifying a layout of 1,1,0.

Wiki Examples:

• All Examples
• Tile multiple images into another image
• Stack multiple 2D images into a 3D image
• Tile multiple images side by side

Examples:

SphinxExamples/src/Filtering/ImageGrid/AppendTwo3DVolumes/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/Create3DVolume/Code.cxx, WikiExamples/ImageProcessing/TileImageFilter_CreateVolume.cxx, and WikiExamples/ImageProcessing/TileImageFilter_SideBySide.cxx.

Definition at line 52 of file itkTileImageFilter.h.

Classes
class	TileInfo

Public Types
using	ConstPointer = SmartPointer< const Self >
using	InputImagePointer = typename TInputImage::Pointer
using	InputImageRegionType = typename TInputImage::RegionType
using	InputIndexType = typename TInputImage::IndexType
using	InputPixelType = typename TInputImage::PixelType
using	InputSizeType = typename TInputImage::SizeType
using	LayoutArrayType = FixedArray< unsigned int, Self::OutputImageDimension >
using	OutputImagePointer = typename TOutputImage::Pointer
using	OutputImageRegionType = typename TOutputImage::RegionType
using	OutputIndexType = typename TOutputImage::IndexType
using	OutputPixelComponentType = typename NumericTraits< OutputPixelType >::ValueType
using	OutputPixelType = typename TOutputImage::PixelType
using	OutputSizeType = typename TOutputImage::SizeType
using	Pointer = SmartPointer< Self >
using	Self = TileImageFilter
using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >
using	TileImageType = Image< TileInfo, Self::OutputImageDimension >
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
	itkConceptMacro (OutputEqualityComparableCheck,(Concept::EqualityComparable< OutputPixelType >))
	itkConceptMacro (SameTypeCheck,(Concept::SameType< InputPixelType, OutputPixelType >))
	itkConceptMacro (OutputOStreamWritableCheck,(Concept::OStreamWritable< OutputPixelType >))
	itkGetConstMacro (DefaultPixelValue, OutputPixelType)
	itkSetMacro (DefaultPixelValue, OutputPixelType)
	itkSetMacro (Layout, LayoutArrayType)
	itkGetConstMacro (Layout, LayoutArrayType)
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::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	InputImageDimension = TInputImage::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::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	GenerateData () override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	TileImageFilter ()
void	VerifyInputInformation () ITKv5_CONST override
	~TileImageFilter () override=default
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	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
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 void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
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 ()

Private Attributes
OutputPixelType	m_DefaultPixelValue
LayoutArrayType	m_Layout
TileImageType::Pointer	m_TileImage

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

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >

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

Definition at line 62 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Image related type alias.

Definition at line 76 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 82 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::InputIndexType = typename TInputImage::IndexType

Definition at line 81 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Image pixel value type alias.

Definition at line 71 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::InputSizeType = typename TInputImage::SizeType

Definition at line 80 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::LayoutArrayType = FixedArray< unsigned int, Self::OutputImageDimension >

LayoutArray type.

Definition at line 109 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename TOutputImage::Pointer

Definition at line 77 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Definition at line 85 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputIndexType = typename TOutputImage::IndexType

Definition at line 84 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputPixelComponentType = typename NumericTraits<OutputPixelType>::ValueType

Definition at line 73 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 72 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::OutputSizeType = typename TOutputImage::SizeType

Definition at line 83 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 61 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Standard Self type alias

Definition at line 59 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 60 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

using itk::TileImageFilter< TInputImage, TOutputImage >::TileImageType = Image< TileInfo, Self::OutputImageDimension >

Definition at line 106 of file itkTileImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >

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

protected

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::TileImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TInputImage , typename TOutputImage >

void itk::TileImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See Also

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage >

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

template<typename TInputImage , typename TOutputImage >

void itk::TileImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<typename TInputImage , typename TOutputImage >

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

virtual

Runtime information support.

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

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro	(	OutputEqualityComparableCheck	,
		(Concept::EqualityComparable< OutputPixelType >)
	)

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro	(	SameTypeCheck	,
		(Concept::SameType< InputPixelType, OutputPixelType >)
	)

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro	(	OutputOStreamWritableCheck	,
		(Concept::OStreamWritable< OutputPixelType >)
	)

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkGetConstMacro	(	Layout	,
		LayoutArrayType
	)

Set/Get the layout of the tiles. If the last Layout value is 0, the filter will compute a value that will acoomodate all of the images.

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkGetConstMacro	(	DefaultPixelValue	,
		OutputPixelType
	)

Get the pixel value for locations that are not covered by an input image.

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkSetMacro	(	Layout	,
		LayoutArrayType
	)

Set/Get the layout of the tiles. If the last Layout value is 0, the filter will compute a value that will acoomodate all of the images.

template<typename TInputImage , typename TOutputImage >

itk::TileImageFilter< TInputImage, TOutputImage >::itkSetMacro	(	DefaultPixelValue	,
		OutputPixelType
	)

Set the pixel value for locations that are not covered by an input image. The default default pixel value is Zero.

template<typename TInputImage , typename TOutputImage >

static Pointer itk::TileImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >

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

template<typename TInputImage , typename TOutputImage >

void itk::TileImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( )

overrideprotectedvirtual

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

See Also

ProcessObject::VerifyInputInformation

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

Member Data Documentation

template<typename TInputImage , typename TOutputImage >

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

static

Image related type alias.

Definition at line 88 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

OutputPixelType itk::TileImageFilter< TInputImage, TOutputImage >::m_DefaultPixelValue

private

Definition at line 159 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

LayoutArrayType itk::TileImageFilter< TInputImage, TOutputImage >::m_Layout

private

Definition at line 161 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

TileImageType::Pointer itk::TileImageFilter< TInputImage, TOutputImage >::m_TileImage

private

Definition at line 157 of file itkTileImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

static

Definition at line 89 of file itkTileImageFilter.h.

---

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

• itkTileImageFilter.h