itk::InterpolateImageFilter< TInputImage, TOutputImage > Class Template Reference
[Multithreaded Filters]

Interpolate an image from two N-D images. More...

#include <itkInterpolateImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef InterpolateImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageType	InputImageType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TInputImage::PixelType	InputPixelType
typedef Image< InputPixelType, itkGetStaticConstMacro(IntermediateImageDimension)	IntermediateImageType )
typedef InterpolateImageFunction< IntermediateImageType >	InterpolatorType
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()
void	BeforeThreadedGenerateData ()
void	AfterThreadedGenerateData ()
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
	itkStaticConstMacro (IntermediateImageDimension, unsigned int, TOutputImage::ImageDimension+1)
void	SetInput1 (const InputImageType *image)
const InputImageType *	GetInput1 ()
void	SetInput2 (const InputImageType *image)
const InputImageType *	GetInput2 ()
virtual void	SetDistance (double _arg)
virtual double	GetDistance ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	InterpolateImageFilter ()
	~InterpolateImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Interpolate an image from two N-D images.

Interpolates an image from two input images of the same type and same dimension (N). In particular, this filter forms an intermediate (N+1)D image by concatenating the two input images and interpolating an image a distance away from the first image.

The interpolation is delegated to a user specified InterpolateImageFunction. By default, linear interpolation is used.

The filter is templated over the input image type and output image type. It assumes that the input and output have the same number of dimensions.

Definition at line 45 of file itkInterpolateImageFilter.h.

---

Member Typedef Documentation

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

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

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

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

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

Inherit typedefs from Superclass Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 62 of file itkInterpolateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::PixelType itk::InterpolateImageFilter< TInputImage, TOutputImage >::InputPixelType

Interpolator typedef. Definition at line 76 of file itkInterpolateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Image<InputPixelType,itkGetStaticConstMacro(IntermediateImageDimension) itk::InterpolateImageFilter< TInputImage, TOutputImage >::IntermediateImageType)

Definition at line 77 of file itkInterpolateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InterpolateImageFunction<IntermediateImageType> itk::InterpolateImageFilter< TInputImage, TOutputImage >::InterpolatorType

Definition at line 78 of file itkInterpolateImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 65 of file itkInterpolateImageFilter.h.

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

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 66 of file itkInterpolateImageFilter.h. Referenced by itk::InterpolateImageFilter< TInputImage, TOutputImage >::~InterpolateImageFilter().

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

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

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

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

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 50 of file itkInterpolateImageFilter.h. Referenced by itk::InterpolateImageFilter< TInputImage, TOutputImage >::~InterpolateImageFilter().

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 113 of file itkInterpolateImageFilter.h. References itk::InterpolateImageFilter< TInputImage, TOutputImage >::OutputImageRegionType, and itk::InterpolateImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::InterpolateImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData (   )  [virtual]

This method is used to run after multi-threading. Reimplemented from itk::ImageSource< TOutputImage >.

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

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

template<class TInputImage, class TOutputImage> virtual double itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetDistance (   )  [virtual]

Set/Get the distance from the first image from which to generate interpolated image. The default value is 0.5

template<class TInputImage, class TOutputImage> const InputImageType* itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetInput1 (  void   )  [inline]

Set/Get the first image Definition at line 83 of file itkInterpolateImageFilter.h.

template<class TInputImage, class TOutputImage> const InputImageType* itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetInput2 (   )

Set/Get the second image

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

Get a pointer to the interpolator function.

template<class TInputImage, class TOutputImage> itk::InterpolateImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  IntermediateImageDimension  , unsigned  int, TOutputImage::ImageDimension+  1 )

Number of dimensions.

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

Number of dimensions.

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

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

template<class TInputImage, class TOutputImage> void itk::InterpolateImageFilter< 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::InterpolateImageFilter< TInputImage, TOutputImage >::SetDistance (  double  _arg  )  [virtual]

Set/Get the distance from the first image from which to generate interpolated image. The default value is 0.5

template<class TInputImage, class TOutputImage> void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetInput1 (  const InputImageType *  image  )  [inline]

Set/Get the first image Definition at line 81 of file itkInterpolateImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetInput2 (  const InputImageType *  image  )

Set/Get the second image

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

Set the interpolator function

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

InterpolateImageFilter can be implemented as a multithreaded filter. Reimplemented from itk::ImageSource< TOutputImage >.

---

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

• itkInterpolateImageFilter.h

---