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

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

#include <itkVectorResampleImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef VectorResampleImageFilter	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 VectorInterpolateImageFunction< 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 PixelType::ValueType	PixelComponentType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage::SpacingType	SpacingType
typedef TOutputImage::PointType	OriginPointType
Public Member Functions
virtual const char *	GetNameOfClass () 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 const SpacingType &	GetOutputSpacing ()
virtual const PointType &	GetOutputOrigin ()
virtual void	SetOutputStartIndex (IndexType _arg)
virtual const IndexType &	GetOutputStartIndex ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	BeforeThreadedGenerateData ()
virtual void	AfterThreadedGenerateData ()
unsigned long	GetMTime (void) const
virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetOutputSpacing (const double *values)
virtual void	SetOutputOrigin (PointType _arg)
virtual void	SetOutputOrigin (const double *values)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	VectorResampleImageFilter ()
	~VectorResampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Resample an image via a coordinate transform.

VectorResampleImageFilter 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::VectorLinearInterpolateImageFunction<InputImageType, double>, which is reasonable for ordinary medical images.

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 56 of file itkVectorResampleImageFilter.h.

---

Member Typedef Documentation

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

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

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

Image index typedef. Definition at line 97 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

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

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

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

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

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

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

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

Definition at line 91 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

template<class TInputImage, class TOutputImage> typedef VectorInterpolateImageFunction<InputImageType, double> itk::VectorResampleImageFilter< TInputImage, TOutputImage >::InterpolatorType

Interpolator typedef. Definition at line 90 of file itkVectorResampleImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PointType itk::VectorResampleImageFilter< TInputImage, TOutputImage >::OriginPointType

Definition at line 111 of file itkVectorResampleImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 68 of file itkVectorResampleImageFilter.h.

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

Typedef to describe the output image region type. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 107 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

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

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

template<class TInputImage, class TOutputImage> typedef PixelType::ValueType itk::VectorResampleImageFilter< TInputImage, TOutputImage >::PixelComponentType

Definition at line 104 of file itkVectorResampleImageFilter.h.

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

Image pixel value typedef. Definition at line 103 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

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

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

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

Image point typedef. Definition at line 100 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

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

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

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

Image size typedef. Definition at line 94 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

template<class TInputImage, class TOutputImage> typedef TOutputImage::SpacingType itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SpacingType

Image spacing typedef Definition at line 110 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

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

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

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

Definition at line 87 of file itkVectorResampleImageFilter.h. Referenced by itk::VectorResampleImageFilter< TInputImage, TOutputImage >::~VectorResampleImageFilter().

template<class TInputImage, class TOutputImage> typedef Transform<double, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) itk::VectorResampleImageFilter< 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 86 of file itkVectorResampleImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 193 of file itkVectorResampleImageFilter.h. References itk::VectorResampleImageFilter< TInputImage, TOutputImage >::IndexType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::InterpolatorPointerType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::OutputImageRegionType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::PixelType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::PointType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::Self, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SizeType, itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SpacingType, and itk::VectorResampleImageFilter< TInputImage, TOutputImage >::TransformPointerType.

---

Member Function Documentation

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

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

template<class TInputImage, class TOutputImage> virtual void itk::VectorResampleImageFilter< 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::VectorResampleImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [virtual]

VectorResampleImageFilter needs a different input requested region than the output requested region. As such, VectorResampleImageFilter 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::VectorResampleImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (   )  [virtual]

VectorResampleImageFilter 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 PixelType itk::VectorResampleImageFilter< 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::VectorResampleImageFilter< TInputImage, TOutputImage >::GetInterpolator (   )  [virtual]

Get a pointer to the interpolator function.

template<class TInputImage, class TOutputImage> unsigned long itk::VectorResampleImageFilter< 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> virtual const char* itk::VectorResampleImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

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

template<class TInputImage, class TOutputImage> virtual const PointType& itk::VectorResampleImageFilter< TInputImage, TOutputImage >::GetOutputOrigin (   )  [virtual]

Get the output image origin.

template<class TInputImage, class TOutputImage> virtual const SpacingType& itk::VectorResampleImageFilter< TInputImage, TOutputImage >::GetOutputSpacing (   )  [virtual]

Get the output image spacing.

template<class TInputImage, class TOutputImage> virtual const IndexType& itk::VectorResampleImageFilter< TInputImage, TOutputImage >::GetOutputStartIndex (   )  [virtual]

Get the start index of the output largest possible region.

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

Get the size of the output image.

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

Get a pointer to the coordinate transform.

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

Number of dimensions.

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

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

template<class TInputImage, class TOutputImage> void itk::VectorResampleImageFilter< 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::VectorResampleImageFilter< 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::VectorResampleImageFilter< TInputImage, TOutputImage >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual]

Set the interpolator function. The default is itk::VectorLinearInterpolateImageFunction<InputImageType, double>.

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

Set the output image origin.

template<class TInputImage, class TOutputImage> virtual void itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SetOutputOrigin (  PointType  _arg  )  [virtual]

Set the output image origin.

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

Set the output image spacing.

template<class TInputImage, class TOutputImage> virtual void itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SetOutputSpacing (  SpacingType  _arg  )  [virtual]

Set the output image spacing.

template<class TInputImage, class TOutputImage> virtual void itk::VectorResampleImageFilter< TInputImage, TOutputImage >::SetOutputStartIndex (  IndexType  _arg  )  [virtual]

Set the start index of the output largest possible region. The default is an index of all zeros.

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

Set the size of the output image.

template<class TInputImage, class TOutputImage> virtual void itk::VectorResampleImageFilter< 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::VectorResampleImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

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

• itkVectorResampleImageFilter.h

---