Tile multiple input images into a single output image. More...

#include <sitkTileImageFilter.h>

Inheritance diagram for itk::simple::TileImageFilter:

Collaboration diagram for itk::simple::TileImageFilter:

Detailed Description

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.

See also: itk::simple::Tile for the procedural interface

Definition at line 42 of file sitkTileImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList

using	Self = TileImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, const Image &image2, const Image &image3)

Image	Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4)

Image	Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4, const Image &image5)

Image	Execute (const std::vector< Image > &images)

double	GetDefaultPixelValue () const

std::vector< uint32_t >	GetLayout () const

std::string	GetName () const

Self &	SetDefaultPixelValue (double DefaultPixelValue)

Self &	SetLayout (std::vector< uint32_t > Layout)

	TileImageFilter ()

std::string	ToString () const

virtual	~TileImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( const std::vector<Image> & )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const std::vector< Image > &images)

Private Attributes
double	m_DefaultPixelValue {0.0}

std::vector< uint32_t >	m_Layout {std::vector<uint32_t>(3, 100)}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType>
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::TileImageFilter::MemberFunctionType = Image (Self::*)( const std::vector<Image> & )

private

Setup for member function dispatching

Definition at line 103 of file sitkTileImageFilter.h.

◆ PixelIDTypeList

using itk::simple::TileImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 57 of file sitkTileImageFilter.h.

◆ Self

using itk::simple::TileImageFilter::Self = TileImageFilter

Definition at line 46 of file sitkTileImageFilter.h.

Constructor & Destructor Documentation

◆ ~TileImageFilter()

virtual itk::simple::TileImageFilter::~TileImageFilter ( )

virtual

Destructor

◆ TileImageFilter()

itk::simple::TileImageFilter::TileImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/6]

Image itk::simple::TileImageFilter::Execute ( const Image & image1 )

◆ Execute() [2/6]

Image itk::simple::TileImageFilter::Execute	(	const Image &	image1,
		const Image &	image2 )

◆ Execute() [3/6]

Image itk::simple::TileImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const Image &	image3 )

◆ Execute() [4/6]

Image itk::simple::TileImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const Image &	image3,
		const Image &	image4 )

◆ Execute() [5/6]

Image itk::simple::TileImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const Image &	image3,
		const Image &	image4,
		const Image &	image5 )

◆ Execute() [6/6]

Image itk::simple::TileImageFilter::Execute ( const std::vector< Image > & images )

Execute the filter on the input images

References itk::images.

◆ ExecuteInternal()

template<class TImageType>

Image itk::simple::TileImageFilter::ExecuteInternal ( const std::vector< Image > & images )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetDefaultPixelValue()

double itk::simple::TileImageFilter::GetDefaultPixelValue ( ) const

inline

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

Definition at line 80 of file sitkTileImageFilter.h.

References m_DefaultPixelValue.

◆ GetLayout()

std::vector< uint32_t > itk::simple::TileImageFilter::GetLayout ( ) const

inline

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

Definition at line 70 of file sitkTileImageFilter.h.

References m_Layout.

◆ GetName()

std::string itk::simple::TileImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 83 of file sitkTileImageFilter.h.

◆ SetDefaultPixelValue()

Self & itk::simple::TileImageFilter::SetDefaultPixelValue ( double DefaultPixelValue )

inline

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

Definition at line 75 of file sitkTileImageFilter.h.

References m_DefaultPixelValue.

◆ SetLayout()

Self & itk::simple::TileImageFilter::SetLayout ( std::vector< uint32_t > Layout )

inline

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

Definition at line 65 of file sitkTileImageFilter.h.

References m_Layout.

◆ ToString()

std::string itk::simple::TileImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 104 of file sitkTileImageFilter.h.

References ExecuteInternal(), and itk::images.

Member Data Documentation

◆ m_DefaultPixelValue

double itk::simple::TileImageFilter::m_DefaultPixelValue {0.0}

private

Definition at line 115 of file sitkTileImageFilter.h.

Referenced by GetDefaultPixelValue(), and SetDefaultPixelValue().

◆ m_Layout

std::vector<uint32_t> itk::simple::TileImageFilter::m_Layout {std::vector<uint32_t>(3, 100)}

private

Definition at line 113 of file sitkTileImageFilter.h.

Referenced by GetLayout(), and SetLayout().

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::TileImageFilter::m_MemberFactory

private

Definition at line 110 of file sitkTileImageFilter.h.

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

sitkTileImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~TileImageFilter()

◆ TileImageFilter()

Member Function Documentation

◆ Execute() [1/6]

◆ Execute() [2/6]

◆ Execute() [3/6]

◆ Execute() [4/6]

◆ Execute() [5/6]

◆ Execute() [6/6]

◆ ExecuteInternal()

◆ GetDefaultPixelValue()

◆ GetLayout()

◆ GetName()

◆ SetDefaultPixelValue()

◆ SetLayout()

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_DefaultPixelValue

◆ m_Layout

◆ m_MemberFactory