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

itk::ImageToImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Filters]

Base class for filters that take an image as input and produce an image as output. More...

#include <itkImageToImageFilter.h>

Inheritance diagram for itk::ImageToImageFilter:

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

[legend]List of all members.

Public Types
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
Public Methods
virtual const char *	GetClassName () const

	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)

virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)
Static Public Methods
Pointer	New ()
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)	RegionCopierType )
Protected Methods
	ImageToImageFilter ()
	~ImageToImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateInputRequestedRegion ()
virtual void	CallCopyRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

Detailed Description

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

Base class for filters that take an image as input and produce an image as output.

ImageToImageFilter is the base class for all process objects that output image data and require image data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

This class provides the infrastructure for supporting multithreaded processing of images. If a filter provides an implementation of GenerateData(), the image processing will run in a single thread and the implementation is responsible for allocating its output data. If a filter provides an implementation of ThreadedGenerateData() instead, the image will be divided into a number of pieces, a number of threads will be spawned, and ThreadedGenerateData() will be called in each thread. Here, the output memory will be allocated by this superclass prior to calling ThreadedGenerateData().

ImageToImageFilter provides an implementation of GenerateInputRequestedRegion(). The base assumption to this point in the heirarchy is that a process object would ask for the largest possible region on input in order to produce any output. Imaging filters, however, can usually answer this question more precisely. The default implementation of GenerateInputRequestedRegion() in this class is to request an input that matches the size of the requested output. If a filter requires more input (say a filter that uses neighborhood information) or less input (for instance a magnify filter), then these filters will have to provide another implmentation of this method. By convention, such implementations should call the Superclass' method first.

Definition at line 63 of file itkImageToImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) itk::ImageToImageFilter< TInputImage, TOutputImage >::RegionCopierType) [protected]

Typedef for the region copier function object.
Definition at line 128 of file itkImageToImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>

itk::ImageToImageFilter< TInputImage, TOutputImage >::ImageToImageFilter ( ) [protected]

template<class TInputImage, class TOutputImage>

itk::ImageToImageFilter< TInputImage, TOutputImage >::~ImageToImageFilter ( ) [protected]

Member Function Documentation

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyRegion ( InputImageRegionType & destRegion,

const OutputImageRegionType & srcRegion

) [protected, virtual]

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.
This function object is used by the default implementation of GenerateInputRequestedRegion(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map the the output region for a particular thread to an input region.
The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.
For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.
If a filter needs a different default behavior, it can call the SetRegionCopier() method passing in a subclass of the ImageToImageDetail::RegionCopier function object. This would typically be done in the constructor of the filter. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).
Reimplemented in itk::ExtractImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

const InputImageType* itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( unsigned int idx )

Set/Get the image input of this process object.
Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage>

const InputImageType* itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( void )

Set/Get the image input of this process object.

template<class TInputImage, class TOutputImage>

itk::ImageToImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension ,

unsigned int,

TOutputImage::ImageDimension

)

ImageDimension constants
Reimplemented in itk::BinaryMedianImageFilter< TInputImage, TOutputImage >, itk::ExtractImageFilter< TInputImage, TOutputImage >, itk::MeanImageFilter< TInputImage, TOutputImage >, itk::MedianImageFilter< TInputImage, TOutputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput ( unsigned int,

const TInputImage * image

) [virtual]

Set/Get the image input of this process object.
Reimplemented in itk::WatershedImageFilter< TInputImage >, and itk::BSplineDecompositionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput ( const InputImageType * image ) [virtual]

Set/Get the image input of this process object.
Reimplemented in itk::VoronoiSegmentationRGBImageFilter< TInputImage, TOutputImage >, and itk::WatershedImageFilter< TInputImage >.

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

itkImageToImageFilter.h

Generated at Wed Mar 12 01:18:13 2003 for ITK by

itk::ImageToImageFilter< TInputImage, TOutputImage > Class Template Reference [Image Filters]

Public Types

Public Methods

Static Public Methods

Protected Types