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

Increase the image size by padding with a constant value. More...

#include <itkConstantPadImageFilter.h>

Inheritance diagram for itk::ConstantPadImageFilter:

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

[legend]List of all members.

Public Types
typedef ConstantPadImageFilter	Self
typedef PadImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::OutputImageIndexType	OutputImageIndexType
typedef Superclass::InputImageIndexType	InputImageIndexType
typedef Superclass::OutputImageSizeType	OutputImageSizeType
typedef Superclass::InputImageSizeType	InputImageSizeType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetConstant (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetConstant ()
Static Public Methods
Pointer	New ()
Protected Methods
	ConstantPadImageFilter ()
	~ConstantPadImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
int	GenerateNextRegion (long *regIndices, long *regLimit, OutputImageIndexType *indices, OutputImageSizeType *sizes, OutputImageRegionType &outputRegion)

---

Detailed Description

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

Increase the image size by padding with a constant value.

ConstantPadImageFilter changes the output image region. If the output image region is larger than the input image region, the extra pixels are filled in by a constant value. The output image region must be specified.

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

Definition at line 38 of file itkConstantPadImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 46 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageIndexType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 64 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImagePixelType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageRegionType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 56 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageSizeType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 66 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageIndexType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types. Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 63 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImagePixelType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel. Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageRegionType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type. Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 55 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageSizeType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 65 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::ConstantPadImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 45 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ConstantPadImageFilter itk::ConstantPadImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 43 of file itkConstantPadImageFilter.h.

template<class TInputImage, class TOutputImage> typedef PadImageFilter<TInputImage,TOutputImage> itk::ConstantPadImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >. Definition at line 44 of file itkConstantPadImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::ConstantPadImageFilter< TInputImage, TOutputImage >::ConstantPadImageFilter (    )  [protected]

template<class TInputImage, class TOutputImage> itk::ConstantPadImageFilter< TInputImage, TOutputImage >::~ConstantPadImageFilter (    )  [inline, protected]

Definition at line 79 of file itkConstantPadImageFilter.h. References HardConnectedComponentImageFilter::PrintSelf().

---

Member Function Documentation

template<class TInputImage, class TOutputImage> int itk::ConstantPadImageFilter< TInputImage, TOutputImage >::GenerateNextRegion (  long *    regIndices, long *    regLimit, OutputImageIndexType *    indices, OutputImageSizeType *    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::ConstantPadImageFilter< TInputImage, TOutputImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual OutputImagePixelType itk::ConstantPadImageFilter< TInputImage, TOutputImage >::GetConstant (    )  [virtual]

Set/Get the pad value. Default is Zero.

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

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

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

Method for creation through the object factory. Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

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

template<class TInputImage, class TOutputImage> virtual void itk::ConstantPadImageFilter< TInputImage, TOutputImage >::SetConstant (  OutputImagePixelType    _arg )  [virtual]

Set/Get the pad value. Default is Zero.

template<class TInputImage, class TOutputImage> void itk::ConstantPadImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData (  const OutputImageRegionType &    outputRegionForThread, int    threadId )  [protected, virtual]

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

---

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

• itkConstantPadImageFilter.h

---