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

Resample an image via a coordinate transform. More...

#include <itkResampleImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef ResampleImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef OutputImageType::Pointer	OutputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Transform< double, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension)	TransformType )
typedef TransformType::Pointer	TransformPointerType
typedef InterpolateImageFunction< InputImageType, double >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointerType
typedef Size< itkGetStaticConstMacro(ImageDimension)	SizeType )
typedef TOutputImage::IndexType	IndexType
typedef InterpolatorType::PointType	PointType
typedef TOutputImage::PixelType	PixelType
typedef TOutputImage::RegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetTransform ()
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()
virtual void	SetSize (SizeType _arg)
virtual const SizeType &	GetSize ()
virtual void	SetDefaultPixelValue (PixelType _arg)
virtual PixelType	GetDefaultPixelValue ()
virtual void	SetOutputSpacing (const double values[ImageDimension])
const double *	GetOutputSpacing ()
virtual void	SetOutputOrigin (const double values[ImageDimension])
const double *	GetOutputOrigin ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	BeforeThreadedGenerateData ()
unsigned long	GetMTime (void) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ResampleImageFilter ()
	~ResampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Resample an image via a coordinate transform.

ResampleImageFilter resamples an existing image through some coordinate transform, interpolating via some image function. The class is templated over the types of the input and output images.

Note that the choice of interpolator function can be important. This function is set via SetInterpolator(). The default is itk::LinearInterpolateImageFunction<InputImageType, double>, which is reasonable for ordinary medical images. However, some synthetic images have pixels drawn from a finite prescribed set. An example would be a mask indicating the segmentation of a brain into a small number of tissue types. For such an image, one does not want to interpolate between different pixel values, and so itk::NearestNeighborInterpolateImageFunction< InputImageType, TCoordRep > would be a better choice.

Since this filter produces an image which is a different size than its input, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateInputRequestedRegion() and ProcessObject::GenerateOutputInformation().

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

Definition at line 61 of file itkResampleImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 69 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::IndexType itk::ResampleImageFilter< TInputImage, TOutputImage >::IndexType

Image index typedef. Definition at line 102 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 72 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::RegionType itk::ResampleImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 74 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::ResampleImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 70 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InterpolatorType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage >::InterpolatorPointerType

Definition at line 96 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InterpolateImageFunction<InputImageType, double> itk::ResampleImageFilter< TInputImage, TOutputImage >::InterpolatorType

Interpolator typedef. Definition at line 95 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 73 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::RegionType itk::ResampleImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

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

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::ResampleImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 71 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PixelType itk::ResampleImageFilter< TInputImage, TOutputImage >::PixelType

Image pixel value typedef. Definition at line 108 of file itkResampleImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InterpolatorType::PointType itk::ResampleImageFilter< TInputImage, TOutputImage >::PointType

Image point typedef. Definition at line 105 of file itkResampleImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 66 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Size<itkGetStaticConstMacro(ImageDimension) itk::ResampleImageFilter< TInputImage, TOutputImage >::SizeType)

Image size typedef. Definition at line 99 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::ResampleImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 67 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TransformType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage >::TransformPointerType

Definition at line 92 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Transform<double, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) itk::ResampleImageFilter< TInputImage, TOutputImage >::TransformType)

Transform typedef. Todo: Check that input and output images have the same number of dimensions; this is required by the current implementation of AffineTransform. Definition at line 91 of file itkResampleImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 185 of file itkResampleImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData (   )  [virtual]

This method is used to set the state of the filter before multi-threading. Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [virtual]

ResampleImageFilter needs a different input requested region than the output requested region. As such, ResampleImageFilter 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 >.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (   )  [virtual]

ResampleImageFilter produces an image which is a different size than its input. As such, it 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::ResampleImageFilter< TInputImage, TOutputImage >::GetClassName (   )  const [virtual]

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

template<class TInputImage, class TOutputImage> virtual PixelType itk::ResampleImageFilter< TInputImage, TOutputImage >::GetDefaultPixelValue (   )  [virtual]

Get the pixel value when a transformed pixel is outside of the image

template<class TInputImage, class TOutputImage> virtual InterpolatorType* itk::ResampleImageFilter< TInputImage, TOutputImage >::GetInterpolator (   )  [virtual]

Get a pointer to the interpolator function.

template<class TInputImage, class TOutputImage> unsigned long itk::ResampleImageFilter< TInputImage, TOutputImage >::GetMTime (  void   )  const [virtual]

Method Compute the Modified Time based on changed to the components. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> const double* itk::ResampleImageFilter< TInputImage, TOutputImage >::GetOutputOrigin (   )  [inline]

Get the output image origin. Definition at line 158 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> const double* itk::ResampleImageFilter< TInputImage, TOutputImage >::GetOutputSpacing (   )  [inline]

Get the output image spacing. Definition at line 151 of file itkResampleImageFilter.h.

template<class TInputImage, class TOutputImage> virtual const SizeType& itk::ResampleImageFilter< TInputImage, TOutputImage >::GetSize (   )  [virtual]

Get the size of the output image.

template<class TInputImage, class TOutputImage> virtual TransformType* itk::ResampleImageFilter< TInputImage, TOutputImage >::GetTransform (   )  [virtual]

Get a pointer to the coordinate transform.

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

Number of dimensions.

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

Method for creation through the object factory. Reimplemented from itk::Object.

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

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetDefaultPixelValue (  PixelType  _arg  )  [virtual]

Set the pixel value when a transformed pixel is outside of the image. The default default pixel value is 0.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual]

Set the interpolator function. The default is itk::LinearInterpolateImageFunction<InputImageType, double>. Some other options are itk::NearestNeighborInterpolateImageFunction (useful for binary masks and other images with a small number of possible pixel values), and itk::BSplineInterpolateImageFunction (which provides a higher order of interpolation).

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetOutputOrigin (  const double  values[ImageDimension]  )  [virtual]

Set the output image origin.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetOutputSpacing (  const double  values[ImageDimension]  )  [virtual]

Set the output image spacing.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetSize (  SizeType  _arg  )  [virtual]

Set the size of the output image.

template<class TInputImage, class TOutputImage> virtual void itk::ResampleImageFilter< TInputImage, TOutputImage >::SetTransform (  TransformType *  _arg  )  [virtual]

Set the coordinate transformation. Set the coordinate transform to use for resampling. Note that this must be in index coordinates and is the output-to-input transform, NOT the input-to-output transform that you might naively expect. The default is itk::AffineTransform<double, ImageDimension>.

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

ResampleImageFilter 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:

• itkResampleImageFilter.h

---