itk::PadImageFilter< TInputImage, TOutputImage > Class Template Reference
[Geometric Transformation Filters]

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

#include <itkPadImageFilter.h>

Inheritance diagram for itk::PadImageFilter:

[legend]Collaboration diagram for itk::PadImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef PadImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TInputImage::RegionType	InputImageRegionType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef TInputImage::PixelType	InputImagePixelType
typedef TOutputImage::IndexType	OutputImageIndexType
typedef TInputImage::IndexType	InputImageIndexType
typedef TOutputImage::SizeType	OutputImageSizeType
typedef TInputImage::SizeType	InputImageSizeType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	SetPadLowerBound (const unsigned long data[])
virtual void	SetPadUpperBound (const unsigned long data[])
virtual const unsigned long *	GetPadLowerBound () const
virtual const unsigned long *	GetPadUpperBound () const
Static Public Methods
Pointer	New ()
Protected Methods
	PadImageFilter ()
	~PadImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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.

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.

Definition at line 40 of file itkPadImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 48 of file itkPadImageFilter.h.

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

Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 63 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 59 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 55 of file itkPadImageFilter.h.

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

Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 65 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 62 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::ImageSource< TOutputImage >. Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 58 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 54 of file itkPadImageFilter.h.

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

Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 64 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 47 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 45 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::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >. Definition at line 46 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 99 of file itkPadImageFilter.h. References HardConnectedComponentImageFilter::PrintSelf().

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual void itk::PadImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (    )  [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 >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::PadImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (    )  [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 const char* itk::PadImageFilter< TInputImage, TOutputImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const unsigned long* itk::PadImageFilter< TInputImage, TOutputImage >::GetPadLowerBound (    )  const [virtual]

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

template<class TInputImage, class TOutputImage> virtual const unsigned long* itk::PadImageFilter< TInputImage, TOutputImage >::GetPadUpperBound (    )  const [virtual]

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

template<class TInputImage, class TOutputImage> itk::PadImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  ImageDimension   , unsigned    int, TInputImage::ImageDimension    )

ImageDimension enumeration. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> Pointer itk::PadImageFilter< TInputImage, TOutputImage >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< 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 >, and itk::MirrorPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadLowerBound (  const unsigned long    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 (  const unsigned long    data[] )  [virtual]

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

---

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

• itkPadImageFilter.h

---