Increase the image size by padding with replicants of the input image value. More...

#include <sitkMirrorPadImageFilter.h>

Inheritance diagram for itk::simple::MirrorPadImageFilter:

Collaboration diagram for itk::simple::MirrorPadImageFilter:

Detailed Description

Increase the image size by padding with replicants of the input image value.

MirrorPadImageFilter changes the image bounds of an image. Any added pixels are filled in with a mirrored replica of the input image. For instance, if the output image needs a pixel that is two pixels to the left of the LargestPossibleRegion of the input image, the value assigned will be from the pixel two pixels inside the left boundary of the LargestPossibleRegion. The image bounds of the output must be specified.

Visual explanation of padding regions.

This filter is implemented as a multithreaded filter. It provides a DynamicThreadedGenerateData() method for its implementation.

Exponential decay in the bounds is enabled when DecayBase has to be in the range (0.0, 1.0]. When it is 1.0 it is disabled. The decay rate is based on the Manhattan distance.

See also: WrapPadImageFilter , ConstantPadImageFilter; itk::simple::MirrorPad for the procedural interface; itk::MirrorPadImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkMirrorPadImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList

using	Self = MirrorPadImageFilter

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)

double	GetDecayBase () const

std::string	GetName () const

std::vector< unsigned int >	GetPadLowerBound () const

std::vector< unsigned int >	GetPadUpperBound () const

	MirrorPadImageFilter ()

Self &	SetDecayBase (double DecayBase)

Self &	SetPadLowerBound (std::vector< unsigned int > PadLowerBound)

Self &	SetPadUpperBound (std::vector< unsigned int > PadUpperBound)

std::string	ToString () const

virtual	~MirrorPadImageFilter ()

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

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

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

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

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

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 Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
double	m_DecayBase {1.0}

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

std::vector< unsigned int >	m_PadLowerBound {std::vector<unsigned int>(3, 0)}

std::vector< unsigned int >	m_PadUpperBound {std::vector<unsigned int>(3, 0)}

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

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

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

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

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

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

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

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

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::MirrorPadImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 106 of file sitkMirrorPadImageFilter.h.

◆ PixelIDTypeList

using itk::simple::MirrorPadImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkMirrorPadImageFilter.h.

◆ Self

using itk::simple::MirrorPadImageFilter::Self = MirrorPadImageFilter

Definition at line 52 of file sitkMirrorPadImageFilter.h.

Constructor & Destructor Documentation

◆ ~MirrorPadImageFilter()

virtual itk::simple::MirrorPadImageFilter::~MirrorPadImageFilter ( )

virtual

Destructor

◆ MirrorPadImageFilter()

itk::simple::MirrorPadImageFilter::MirrorPadImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::MirrorPadImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetDecayBase()

double itk::simple::MirrorPadImageFilter::GetDecayBase ( ) const

inline

Get/Set the base for exponential decay in mirrored region.

Definition at line 89 of file sitkMirrorPadImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 92 of file sitkMirrorPadImageFilter.h.

◆ GetPadLowerBound()

std::vector<unsigned int> itk::simple::MirrorPadImageFilter::GetPadLowerBound ( ) const

inline

Definition at line 71 of file sitkMirrorPadImageFilter.h.

◆ GetPadUpperBound()

std::vector<unsigned int> itk::simple::MirrorPadImageFilter::GetPadUpperBound ( ) const

inline

Definition at line 79 of file sitkMirrorPadImageFilter.h.

◆ SetDecayBase()

Self& itk::simple::MirrorPadImageFilter::SetDecayBase ( double DecayBase )

inline

Get/Set the base for exponential decay in mirrored region.

Definition at line 84 of file sitkMirrorPadImageFilter.h.

◆ SetPadLowerBound()

Self& itk::simple::MirrorPadImageFilter::SetPadLowerBound ( std::vector< unsigned int > PadLowerBound )

inline

Definition at line 67 of file sitkMirrorPadImageFilter.h.

◆ SetPadUpperBound()

Self& itk::simple::MirrorPadImageFilter::SetPadUpperBound ( std::vector< unsigned int > PadUpperBound )

inline

Definition at line 75 of file sitkMirrorPadImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 110 of file sitkMirrorPadImageFilter.h.

Member Data Documentation

◆ m_DecayBase

double itk::simple::MirrorPadImageFilter::m_DecayBase {1.0}

private

Definition at line 121 of file sitkMirrorPadImageFilter.h.

◆ m_MemberFactory

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

private

Definition at line 112 of file sitkMirrorPadImageFilter.h.

◆ m_PadLowerBound

std::vector<unsigned int> itk::simple::MirrorPadImageFilter::m_PadLowerBound {std::vector<unsigned int>(3, 0)}

private

Definition at line 116 of file sitkMirrorPadImageFilter.h.

◆ m_PadUpperBound

std::vector<unsigned int> itk::simple::MirrorPadImageFilter::m_PadUpperBound {std::vector<unsigned int>(3, 0)}

private

Definition at line 119 of file sitkMirrorPadImageFilter.h.

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

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

◆ ~MirrorPadImageFilter()

◆ MirrorPadImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetDecayBase()

◆ GetName()

◆ GetPadLowerBound()

◆ GetPadUpperBound()

◆ SetDecayBase()

◆ SetPadLowerBound()

◆ SetPadUpperBound()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_DecayBase

◆ m_MemberFactory

◆ m_PadLowerBound

◆ m_PadUpperBound