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

#include <itkPadImageFilter.h>

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

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

List of all members.

Public Types
typedef BoundaryConditionType *	BoundaryConditionPointerType
typedef ImageBoundaryCondition < TInputImage, TOutputImage >	BoundaryConditionType
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::SizeType	InputImageSizeType
typedef TOutputImage::IndexType	OutputImageIndexType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage::SizeType	OutputImageSizeType
typedef SmartPointer< Self >	Pointer
typedef PadImageFilter	Self
typedef TInputImage::SizeType	SizeType
typedef TInputImage::SizeValueType	SizeValueType
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	SetPadBound (const InputImageSizeType &bound)
virtual void	SetPadLowerBound (SizeType _arg)
virtual void	SetPadUpperBound (SizeType _arg)
virtual const SizeType &	GetPadLowerBound ()
virtual const SizeType &	GetPadUpperBound ()
virtual void	SetPadLowerBound (const SizeValueType data[])
virtual void	SetPadUpperBound (const SizeValueType data[])
virtual void	SetBoundaryCondition (BoundaryConditionPointerType _arg)
virtual BoundaryConditionPointerType	GetBoundaryCondition () const
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Protected Member Functions
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
void	InternalSetBoundaryCondition (const BoundaryConditionPointerType boundaryCondition)
	PadImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	~PadImageFilter ()
Private Member Functions
void	operator= (const Self &)
	PadImageFilter (const Self &)
Private Attributes
BoundaryConditionPointerType	m_BoundaryCondition
SizeType	m_PadLowerBound
SizeType	m_PadUpperBound

---

Detailed Description

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

Increase the image size by padding. Superclass for filters that fill in extra pixels.

Visual explanation of padding regions.

PadImageFilter changes the image boundary of an image by padding each dimension with subclass defined algorithms. The number of pixels to pad for the upper and lower bounds of each dimension must be specified.

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

See also:

WrapPadImageFilter, MirrorPadImageFilter, ConstantPadImageFilter

Definition at line 47 of file itkPadImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef BoundaryConditionType* itk::PadImageFilter< TInputImage, TOutputImage >::BoundaryConditionPointerType

Definition at line 78 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ImageBoundaryCondition< TInputImage, TOutputImage > itk::PadImageFilter< TInputImage, TOutputImage >::BoundaryConditionType

Typedef to describe the boundary condition.

Definition at line 77 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 55 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::IndexType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 70 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::PixelType itk::PadImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 66 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::RegionType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 72 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::IndexType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 69 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::PixelType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 65 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::RegionType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 58 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 71 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 54 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 52 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::SizeType

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

Definition at line 73 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::SizeValueType itk::PadImageFilter< TInputImage, TOutputImage >::SizeValueType

Definition at line 74 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 53 of file itkPadImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::PadImageFilter< TInputImage, TOutputImage >::PadImageFilter

(

)

[protected]

template<class TInputImage , class TOutputImage >

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

(

)

[inline, protected]

Definition at line 110 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::PadImageFilter< TInputImage, TOutputImage >::PadImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::PadImageFilter< 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::Object.

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

(

)

[protected, virtual]

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

See also:

ProcessObject::GenerateInputRequestedRegion()

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

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

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation

(

)

[protected, virtual]

PadImageFilter produces an image which is a different resolution than its input image. As such, PadImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:

ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >

virtual BoundaryConditionPointerType itk::PadImageFilter< TInputImage, TOutputImage >::GetBoundaryCondition

(

)

const [virtual]

Set/get the boundary condition.

template<class TInputImage , class TOutputImage >

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

(

)

const [virtual]

Run-time type information (and related methods).

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual const SizeType& itk::PadImageFilter< TInputImage, TOutputImage >::GetPadLowerBound

(

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

virtual const SizeType& itk::PadImageFilter< TInputImage, TOutputImage >::GetPadUpperBound

(

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

void itk::PadImageFilter< TInputImage, TOutputImage >::InternalSetBoundaryCondition

(

const BoundaryConditionPointerType

boundaryCondition

)

[protected]

Method for subclasses to set the boundary condition.

template<class TInputImage , class TOutputImage >

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

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

Reimplemented in itk::MirrorPadImageFilter< TInputImage, TOutputImage >, itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::PadImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

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

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

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetBoundaryCondition

(

BoundaryConditionPointerType

_arg

)

[virtual]

Set/get the boundary condition.

template<class TInputImage , class TOutputImage >

void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadBound

(

const InputImageSizeType &

bound

)

[inline]

Definition at line 97 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadLowerBound

(

SizeType

_arg

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadLowerBound

(

const SizeValueType

data[]

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadUpperBound

(

SizeType

_arg

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadUpperBound

(

const SizeValueType

data[]

)

[virtual]

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >

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

This class can be multithreaded.

Reimplemented from itk::ImageSource< TOutputImage >.

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

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

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

ImageDimension enumeration.

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

Definition at line 85 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

BoundaryConditionPointerType itk::PadImageFilter< TInputImage, TOutputImage >::m_BoundaryCondition [private]

Definition at line 142 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

SizeType itk::PadImageFilter< TInputImage, TOutputImage >::m_PadLowerBound [private]

Definition at line 139 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >

SizeType itk::PadImageFilter< TInputImage, TOutputImage >::m_PadUpperBound [private]

Definition at line 140 of file itkPadImageFilter.h.

---

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

• itkPadImageFilter.h