Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

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

#include <itkWrapPadImageFilter.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::WrapPadImageFilter< TInputImage, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef WrapPadImageFilter Self
typedef PadImageFilter< TInputImage,
TOutputImage > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef Superclass::InputImageType InputImageType
typedef Superclass::OutputImageType OutputImageType
typedef Superclass::InputImagePointer InputImagePointer
typedef Superclass::OutputImagePointer OutputImagePointer
typedef Superclass::InputImageConstPointer InputImageConstPointer
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 Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)

Static Public Member Functions

Pointer New ()

Protected Member Functions

 WrapPadImageFilter ()
 ~WrapPadImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
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 FindRegionsInArea (long start, long end, long size, long offset)
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 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)
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)
virtual void GenerateInputRequestedRegion ()

Detailed Description

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

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

WrapPadImageFilter changes the image bounds of an image. Added pixels are filled in with a wrapped 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 right boundary of the LargestPossibleRegion. The image bounds of the output must be specified.

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

See also:
MirrorPadImageFilter, ConstantPadImageFilter

Definition at line 45 of file itkWrapPadImageFilter.h.


Member Typedef Documentation

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

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

Definition at line 53 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageConstPointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageConstPointer
 

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

Definition at line 65 of file itkWrapPadImageFilter.h.

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

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

Definition at line 77 of file itkWrapPadImageFilter.h.

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

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

Definition at line 73 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImagePointer
 

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

Definition at line 63 of file itkWrapPadImageFilter.h.

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

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

Definition at line 69 of file itkWrapPadImageFilter.h.

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

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

Definition at line 79 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageType
 

Some convenient typedefs.

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

Definition at line 61 of file itkWrapPadImageFilter.h.

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

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

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

Definition at line 76 of file itkWrapPadImageFilter.h.

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

Typedef to describe the type of pixel.

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

Definition at line 72 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImagePointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkWrapPadImageFilter.h.

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

Typedef to describe the output image region type.

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

Definition at line 68 of file itkWrapPadImageFilter.h.

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

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

Definition at line 78 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 62 of file itkWrapPadImageFilter.h.

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

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

Definition at line 52 of file itkWrapPadImageFilter.h.

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

Standard class typedefs.

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

Definition at line 50 of file itkWrapPadImageFilter.h.

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

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

Definition at line 51 of file itkWrapPadImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::WrapPadImageFilter< TInputImage, TOutputImage >::WrapPadImageFilter  )  [inline, protected]
 

Definition at line 86 of file itkWrapPadImageFilter.h.

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

Definition at line 87 of file itkWrapPadImageFilter.h.


Member Function Documentation

template<class TInputImage, class TOutputImage>
int itk::WrapPadImageFilter< 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::WrapPadImageFilter< 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::WrapPadImageFilter< 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>
int itk::WrapPadImageFilter< 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::WrapPadImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion  )  [protected, virtual]
 

WrapPadImageFilter needs a different input requested region than output requested region. As such, WrapPadImageFilter 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::WrapPadImageFilter< 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::WrapPadImageFilter< 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::WrapPadImageFilter< TInputImage, TOutputImage >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

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

template<class TInputImage, class TOutputImage>
itk::WrapPadImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
TInputImage::ImageDimension 
 

ImageDimension enumeration.

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

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

Method for creation through the object factory.

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

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

WrapPadImageFilter 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:
Generated at Thu May 25 02:45:34 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000