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

#include <itkResampleImageFilter.h>

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

Collaboration diagram for itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >:

Public Types
typedef InterpolatorConvertType::ComponentType	ComponentType
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < TInterpolatorPrecisionType, ImageDimension >	ContinuousInputIndexType
typedef TOutputImage::DirectionType	DirectionType
typedef ExtrapolatorType::Pointer	ExtrapolatorPointerType
typedef ExtrapolateImageFunction < InputImageType, TInterpolatorPrecisionType >	ExtrapolatorType
typedef ImageBase < itkGetStaticConstMacro(ImageDimension) >	ImageBaseType
typedef TOutputImage::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef DefaultConvertPixelTraits < InterpolatorOutputType >	InterpolatorConvertType
typedef InterpolatorType::OutputType	InterpolatorOutputType
typedef InterpolatorType::Pointer	InterpolatorPointerType
typedef InterpolateImageFunction < InputImageType, TInterpolatorPrecisionType >	InterpolatorType
typedef LinearInterpolatorType::Pointer	LinearInterpolatorPointerType
typedef LinearInterpolateImageFunction < InputImageType, TInterpolatorPrecisionType >	LinearInterpolatorType
typedef TOutputImage::PointType	OriginPointType
typedef OutputImageType::Pointer	OutputImagePointer
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef PixelConvertType::ComponentType	PixelComponentType
typedef DefaultConvertPixelTraits < PixelType >	PixelConvertType
typedef TOutputImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef InterpolatorType::PointType	PointType
typedef ResampleImageFilter	Self
typedef Size < itkGetStaticConstMacro(ImageDimension) >	SizeType
typedef TOutputImage::SpacingType	SpacingType
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

typedef Transform < TInterpolatorPrecisionType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >	TransformType
typedef TransformType::ConstPointer	TransformPointerType
Public Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual const PixelType &	GetDefaultPixelValue ()
virtual const ExtrapolatorType *	GetExtrapolator ()
virtual const InterpolatorType *	GetInterpolator ()
unsigned long	GetMTime (void) const
virtual const char *	GetNameOfClass () const
virtual const OriginPointType &	GetOutputOrigin ()
virtual const SpacingType &	GetOutputSpacing ()
virtual const IndexType &	GetOutputStartIndex ()
const TOutputImage *	GetReferenceImage () const
virtual const SizeType &	GetSize ()
virtual const TransformType *	GetTransform ()
virtual bool	GetUseReferenceImage () const
virtual void	SetDefaultPixelValue (PixelType _arg)
virtual void	SetExtrapolator (ExtrapolatorType *_arg)
virtual void	SetInterpolator (InterpolatorType *_arg)
void	SetOutputParametersFromImage (const ImageBaseType *image)
virtual void	SetOutputStartIndex (IndexType _arg)
void	SetReferenceImage (const TOutputImage *image)
virtual void	SetSize (SizeType _arg)
virtual void	SetTransform (const TransformType *_arg)
virtual void	SetUseReferenceImage (bool _arg)
	typedef (Concept::HasNumericTraits< PixelComponentType >) OutputHasNumericTraitsCheck
virtual void	UseReferenceImageOff ()
virtual void	UseReferenceImageOn ()

virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetOutputSpacing (const double *values)

virtual void	SetOutputOrigin (OriginPointType _arg)
virtual void	SetOutputOrigin (const double *values)

virtual void	SetOutputDirection (DirectionType _arg)
virtual const DirectionType &	GetOutputDirection ()
Static Public Member Functions
static Pointer	New ()
Static Public Attributes

static const unsigned int	ImageDimension = TOutputImage::ImageDimension
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
Protected Member Functions
virtual PixelType	CastPixelWithBoundsChecking (const InterpolatorOutputType value, const ComponentType minComponent, const ComponentType maxComponent) const
virtual void	LinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	NonlinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	VerifyInputInformation ()

	ResampleImageFilter ()
	~ResampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
Private Member Functions
void	operator= (const Self &)
	ResampleImageFilter (const Self &)
Private Attributes
PixelType	m_DefaultPixelValue
ExtrapolatorPointerType	m_Extrapolator
InterpolatorPointerType	m_Interpolator
DirectionType	m_OutputDirection
OriginPointType	m_OutputOrigin
SpacingType	m_OutputSpacing
IndexType	m_OutputStartIndex
SizeType	m_Size
TransformPointerType	m_Transform
bool	m_UseReferenceImage

Detailed Description

template<class TInputImage, class TOutputImage, class TInterpolatorPrecisionType = double>
class itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >

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 LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>, 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 NearestNeighborInterpolateImageFunction< InputImageType, TCoordRep > would be a better choice.

If an sample is taken from outside the image domain, the default behavior is to use a default pixel value. If different behavior is desired, an extrapolator function can be set with SetExtrapolator().

Output information (spacing, size and direction) for the output image should be set. This information has the normal defaults of unit spacing, zero origin and identity direction. Optionally, the output information can be obtained from a reference image. If the reference image is provided and UseReferenceImage is On, then the spacing, origin and direction of the reference image will be used.

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.

Warning:: For multithreading, the TransformPoint method of the user-designated coordinate transform must be threadsafe.

Wiki Examples:

All Examples

Translate an image

Upsampling an image

Resample (stretch or compress) an image

Definition at line 86 of file itkResampleImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef InterpolatorConvertType::ComponentType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ComponentType

Definition at line 137 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

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

Definition at line 94 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ContinuousIndex< TInterpolatorPrecisionType, ImageDimension > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ContinuousInputIndexType

Input pixel continous index typdef

Definition at line 169 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::DirectionType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::DirectionType

Definition at line 177 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ExtrapolatorType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ExtrapolatorPointerType

Definition at line 147 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ExtrapolateImageFunction< InputImageType, TInterpolatorPrecisionType > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ExtrapolatorType

Extrapolator typedef.

Definition at line 146 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ImageBaseType

base type for images of the current ImageDimension

Definition at line 117 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::IndexType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::IndexType

Image index typedef.

Definition at line 153 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef InputImageType::ConstPointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InputImageConstPointer

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

Definition at line 99 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

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

Definition at line 98 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

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

Definition at line 101 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TInputImage itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InputImageType

Some convenient typedefs.

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

Definition at line 96 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TInputImage::PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InputPixelType

Definition at line 161 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef DefaultConvertPixelTraits< InterpolatorOutputType > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InterpolatorConvertType

Definition at line 135 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef InterpolatorType::OutputType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InterpolatorOutputType

Definition at line 133 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Definition at line 131 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef InterpolateImageFunction< InputImageType, TInterpolatorPrecisionType > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InterpolatorType

Interpolator typedef.

Definition at line 130 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef LinearInterpolatorType::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::LinearInterpolatorPointerType

Definition at line 142 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef LinearInterpolateImageFunction< InputImageType, TInterpolatorPrecisionType > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::LinearInterpolatorType

Definition at line 140 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::PointType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::OriginPointType

Definition at line 176 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 100 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::RegionType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::OutputImageRegionType

Typedef to describe the output image region type.

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

Definition at line 172 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 97 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef PixelConvertType::ComponentType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PixelComponentType

Definition at line 165 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef DefaultConvertPixelTraits<PixelType> itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PixelConvertType

Definition at line 163 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PixelType

Image pixel value typedef.

Definition at line 160 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

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

Definition at line 93 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef InterpolatorType::PointType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PointType

Image point typedef.

Definition at line 156 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ResampleImageFilter itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::Self

Standard class typedefs.

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

Definition at line 91 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Image size typedef.

Definition at line 150 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TOutputImage::SpacingType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SpacingType

Image spacing,origin and direction typedef

Definition at line 175 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::Superclass

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

Definition at line 92 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef TransformType::ConstPointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::TransformPointerType

Transform typedef.

Definition at line 125 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

typedef Transform< TInterpolatorPrecisionType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) > itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::TransformType

Transform typedef.

Definition at line 124 of file itkResampleImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

End concept checking

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

End concept checking

Definition at line 302 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ResampleImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

virtual PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::CastPixelWithBoundsChecking	(	const InterpolatorOutputType	value,
		const ComponentType	minComponent,
		const ComponentType	maxComponent
	)		const `[protected, virtual]`

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual::itk::LightObject::Pointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

virtual const PixelType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetDefaultPixelValue ( ) [virtual]

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

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const ExtrapolatorType* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetExtrapolator ( ) [virtual]

Get a pointer to the extrapolator function.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Get a pointer to the interpolator function.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Method Compute the Modified Time based on changed to the components.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const char* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const DirectionType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputDirection ( ) [virtual]

Set the output direciton cosine matrix.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const OriginPointType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputOrigin ( ) [virtual]

Get the output image origin.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const SpacingType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputSpacing ( ) [virtual]

Get the output image spacing.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual const IndexType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputStartIndex ( ) [virtual]

Get the start index of the output largest possible region.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

const TOutputImage* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetReferenceImage ( ) const

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Get the size of the output image.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Get a pointer to the coordinate transform.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual bool itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetUseReferenceImage ( ) const [virtual]

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::LinearThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected, virtual]`

Implementation for resampling that works for with linear transformation types.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::NonlinearThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected, virtual]`

Default implementation for resampling that works for any transformation type.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::operator= ( const Self & ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

End concept checking

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

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetExtrapolator ( ExtrapolatorType * _arg ) [virtual]

Set the extrapolator function. The default behavior when sampling outside of the input image is to use the DefaultPixelValue. Some other options include NearestNeighborExtrapolateImageFunction.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

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

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputDirection ( DirectionType _arg ) [virtual]

Set the output direciton cosine matrix.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputOrigin ( const double * values ) [virtual]

Set the output image origin.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputOrigin ( OriginPointType _arg ) [virtual]

Set the output image origin.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage ( const ImageBaseType * image )

Helper method to set the output parameters based on this image

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputSpacing ( const double * values ) [virtual]

Set the output image spacing.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputSpacing ( SpacingType _arg ) [virtual]

Set the output image spacing.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::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 , class TInterpolatorPrecisionType = double>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetReferenceImage ( const TOutputImage * image )

Copy the output information from another Image. By default, the information is specified with the SetOutputSpacing, Origin, and Direction methods. UseReferenceImage must be On and a Reference image must be present to override the defaul behavior.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Set the size of the output image.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

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

Set the coordinate transformation. Set the coordinate transform to use for resampling. Note that this must be in physical coordinates and it is the output-to-input transform, NOT the input-to-output transform that you might naively expect. By default the filter uses an Identity transform. You must provide a different transform here, before attempting to run the filter, if you do not want to use the default Identity transform.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetUseReferenceImage ( bool _arg ) [virtual]

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	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 >.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::typedef ( Concept::HasNumericTraits< PixelComponentType > )

Begin concept checking This class requires OutputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< PixelComponentType > )

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::UseReferenceImageOff ( ) [virtual]

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::UseReferenceImageOn ( ) [virtual]

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::VerifyInputInformation ( ) [inline, protected, virtual]

Override VeriyInputInformation() since this filter's inputs do not need to occoupy the same physical space.

See also:: ProcessObject::VerifyInputInformation

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

Definition at line 312 of file itkResampleImageFilter.h.

Member Data Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

const unsigned int itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ImageDimension = TOutputImage::ImageDimension [static]

Number of dimensions.

Definition at line 111 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

const unsigned int itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InputImageDimension = TInputImage::ImageDimension [static]

Number of dimensions.

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

Definition at line 113 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_DefaultPixelValue [private]

Definition at line 353 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

ExtrapolatorPointerType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_Extrapolator [private]

Definition at line 351 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

InterpolatorPointerType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_Interpolator [private]

Definition at line 349 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

DirectionType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_OutputDirection [private]

Definition at line 358 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

OriginPointType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_OutputOrigin [private]

Definition at line 357 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

SpacingType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_OutputSpacing [private]

Definition at line 356 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

IndexType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_OutputStartIndex [private]

Definition at line 359 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

SizeType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_Size [private]

Definition at line 347 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

TransformPointerType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_Transform [private]

Definition at line 348 of file itkResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>

bool itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_UseReferenceImage [private]

Definition at line 360 of file itkResampleImageFilter.h.

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

itkResampleImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<class TInputImage, class TOutputImage, class TInterpolatorPrecisionType = double> class itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage, class TOutputImage, class TInterpolatorPrecisionType = double>
class itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >