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

#include <itkMirrorPadImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageIndexType	InputImageIndexType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageSizeType	InputImageSizeType
typedef TInputImage	InputImageType
typedef Superclass::OutputImageIndexType	OutputImageIndexType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageSizeType	OutputImageSizeType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef MirrorPadImageFilter	Self
typedef PadImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::Convertible< InputImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Protected Member Functions
int	BuildInterRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
int	BuildPostRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
int	BuildPreRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
void	ConvertOutputIndexToInputIndex (OutputImageIndexType &outputIndex, InputImageIndexType &inputIndex, OutputImageRegionType &outputRegion, InputImageRegionType &inputRegion, int *oddRegionArray)
int	FindRegionsInArea (long start, long end, long size, long offset)
virtual void	GenerateInputRequestedRegion ()
int	GenerateNextInputRegion (long *regIndices, long *regLimit, std::vector< long > *indices, std::vector< long > *sizes, InputImageRegionType &outputRegion)
int	GenerateNextOutputRegion (long *regIndices, long *regLimit, std::vector< long > *indices, std::vector< long > *sizes, OutputImageRegionType &outputRegion)
int	RegionIsOdd (long base, long test, long size)
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	MirrorPadImageFilter ()
	~MirrorPadImageFilter ()
Private Member Functions
	MirrorPadImageFilter (const Self &)
void	operator= (const Self &)

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::MirrorPadImageFilter< TInputImage, TOutputImage >

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 ThreadedGenerateData() method for its implementation.

See also:

WrapPadImageFilter, ConstantPadImageFilter

Wiki Examples:

• All Examples

• Pad an image using mirroring over the boundaries

Definition at line 52 of file itkMirrorPadImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 60 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageIndexType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageIndexType

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

Definition at line 81 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePixelType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 77 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageRegionType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 73 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageSizeType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageSizeType

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

Definition at line 83 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 66 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageIndexType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

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

Definition at line 80 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePixelType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

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

Definition at line 76 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageRegionType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

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

Definition at line 72 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageSizeType itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

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

Definition at line 82 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 69 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::MirrorPadImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 59 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef MirrorPadImageFilter itk::MirrorPadImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 57 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef PadImageFilter< TInputImage, TOutputImage > itk::MirrorPadImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 58 of file itkMirrorPadImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::MirrorPadImageFilter< TInputImage, TOutputImage >::MirrorPadImageFilter

(

)

[inline, protected]

End concept checking

Definition at line 97 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::MirrorPadImageFilter< TInputImage, TOutputImage >::~MirrorPadImageFilter

(

)

[inline, protected]

End concept checking

Definition at line 98 of file itkMirrorPadImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::MirrorPadImageFilter< TInputImage, TOutputImage >::MirrorPadImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildInterRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)		[protected]

Generate region 0 (inter-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly corresponding to the input region. Padding will be on either side of this region. The algorithmic complications are necessary to support the streaming interface and multithreading.

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildPostRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)		[protected]

Generate region 2 (post-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly succeeding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildPreRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)		[protected]

Generate region 1 (pre-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly preceding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

template<class TInputImage , class TOutputImage >

void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ConvertOutputIndexToInputIndex	(	OutputImageIndexType &	outputIndex,
		InputImageIndexType &	inputIndex,
		OutputImageRegionType &	outputRegion,
		InputImageRegionType &	inputRegion,
		int *	oddRegionArray
	)		[protected]

Convert from the output index to the input index taking into consideration mirrored and normal regions.

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::MirrorPadImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

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::PadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::FindRegionsInArea	(	long	start,
		long	end,
		long	size,
		long	offset
	)		[protected]

Given the start and end indices of a region, determine how many instances of size fit within the region. The variable offset provides a way to adjust width of the area while forcing alignment to the start or end location.

template<class TInputImage , class TOutputImage >

virtual void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion

(

)

[protected, virtual]

MirrorPadImageFilter needs a different input requested region than output requested region. As such, MirrorPadImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:

ProcessObject::GenerateInputRequestedRegion()

PadImageFilter::GenerateInputRequestedRegion()

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

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GenerateNextInputRegion	(	long *	regIndices,
		long *	regLimit,
		std::vector< long > *	indices,
		std::vector< long > *	sizes,
		InputImageRegionType &	outputRegion
	)		[protected]

Given an n dimensional list of input region breakpoints in indices and size (where the current region and maximum region for each dimension is encoded in regIndices and regLimit), choose the next input region.

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GenerateNextOutputRegion	(	long *	regIndices,
		long *	regLimit,
		std::vector< long > *	indices,
		std::vector< long > *	sizes,
		OutputImageRegionType &	outputRegion
	)		[protected]

Given an n dimensional list of output region breakpoints in indices and size (where the current region and maximum region for each dimension is encoded in regIndices and regLimit), choose the next output region.

template<class TInputImage , class TOutputImage >

virtual const char* itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage >

static Pointer itk::MirrorPadImageFilter< TInputImage, TOutputImage >::New

(

)

[static]

Method for creation through the object factory.

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

template<class TInputImage , class TOutputImage >

void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::operator=

(

const Self &

)

[private]

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::PadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::RegionIsOdd	(	long	base,
		long	test,
		long	size
	)		[protected]

Decide whether test falls within an odd or even number of size regions from base.

template<class TInputImage , class TOutputImage >

void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		[protected, virtual]

MirrorPadImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

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

template<class TInputImage , class TOutputImage >

itk::MirrorPadImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::Convertible< InputImagePixelType, OutputImagePixelType >

)

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration.

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

Definition at line 87 of file itkMirrorPadImageFilter.h.

---

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

• itkMirrorPadImageFilter.h