itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType > Class Template Reference

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

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

Public Types
typedef InvResampleImageFilter	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 InputImageType::ConstPointer	InputImageConstPointer
typedef OutputImageType::Pointer	OutputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Transform < TInterpolatorPrecisionType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension)>	TransformType
typedef TransformType::ConstPointer	TransformPointerType
typedef InterpolateImageFunction < InputImageType, TInterpolatorPrecisionType >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointerType
typedef Size < itkGetStaticConstMacro(ImageDimension)>	SizeType
typedef TOutputImage::IndexType	IndexType
typedef InterpolatorType::PointType	PointType
typedef TOutputImage::PixelType	PixelType
typedef TInputImage::PixelType	InputPixelType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage::SpacingType	SpacingType
typedef TOutputImage::PointType	OriginPointType
typedef TOutputImage::DirectionType	DirectionType
typedef ImageBase < itkGetStaticConstMacro(ImageDimension)>	ImageBaseType

Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetTransform (const TransformType *_arg)
virtual const TransformType *	GetTransform ()
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual const InterpolatorType *	GetInterpolator ()
virtual void	SetSize (SizeType _arg)
virtual const SizeType &	GetSize ()
virtual void	SetDefaultPixelValue (PixelType _arg)
virtual const PixelType &	GetDefaultPixelValue ()
virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetOutputSpacing (const double *values)
virtual const SpacingType &	GetOutputSpacing ()
virtual void	SetOutputOrigin (OriginPointType _arg)
virtual void	SetOutputOrigin (const double *values)
virtual const OriginPointType &	GetOutputOrigin ()
virtual void	SetOutputDirection (DirectionType _arg)
virtual const DirectionType &	GetOutputDirection ()
void	SetOutputParametersFromImage (const ImageBaseType *image)
	itkLegacyMacro (void SetOutputParametersFromConstImage(const ImageBaseType *image))
virtual void	SetOutputStartIndex (IndexType _arg)
virtual const IndexType &	GetOutputStartIndex ()
void	SetReferenceImage (const TOutputImage *image)
const TOutputImage *	GetReferenceImage (void) const
virtual void	SetUseReferenceImage (bool _arg)
virtual void	UseReferenceImageOn ()
virtual void	UseReferenceImageOff ()
virtual bool	GetUseReferenceImage () const
virtual void	GenerateOutputInformation (void)
virtual void	GenerateInputRequestedRegion (void)
virtual void	BeforeThreadedGenerateData (void)
virtual void	AfterThreadedGenerateData (void)
unsigned long	GetMTime (void) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	InvResampleImageFilter (void)
	~InvResampleImageFilter (void)
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
void	NonlinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void	LinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

Member Typedef Documentation

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

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

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

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

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

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

base type for images of the current ImageDimension

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

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

Image index typedef.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Interpolator typedef.

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

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

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

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

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

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

Typedef to describe the output image region type.

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

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

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

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

Image pixel value typedef.

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

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

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

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

Image point typedef.

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

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

Standard class typedefs.

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

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

Image size typedef.

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

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

Image spacing,origin and direction typedef

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

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

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

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

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

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

Transform typedef.

Constructor & Destructor Documentation

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

itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InvResampleImageFilter ( void  )

protected

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

itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::~InvResampleImageFilter ( void  )

inlineprotected

Member Function Documentation

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::AfterThreadedGenerateData ( void  )

virtual

This method is used to set the state of the filter after multi-threading.

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::BeforeThreadedGenerateData ( void  )

virtual

This method is used to set the state of the filter before multi-threading.

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateInputRequestedRegion ( void  )

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()

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateOutputInformation ( void  )

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()

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

virtual const char* itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

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

virtual const PixelType& itk::InvResampleImageFilter< 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 InterpolatorType* itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetInterpolator ( )

virtual

Get a pointer to the interpolator function.

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

unsigned long itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime

(

void

)

const

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

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

virtual const DirectionType& itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputDirection ( )

virtual

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

virtual const OriginPointType& itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputOrigin ( )

virtual

Get the output image origin.

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

virtual const SpacingType& itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputSpacing ( )

virtual

Get the output image spacing.

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

virtual const IndexType& itk::InvResampleImageFilter< 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::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetReferenceImage

(

void

)

const

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

virtual const SizeType& itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetSize ( )

virtual

Get the size of the output image.

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

virtual const TransformType* itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetTransform ( )

virtual

Get a pointer to the coordinate transform.

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

virtual bool itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetUseReferenceImage ( ) const

virtual

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

itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::itkLegacyMacro

(

void

SetOutputParametersFromConstImageconst ImageBaseType *image

)

Deprecated:

in ITK 3.14, Please use SetOutputParametersFromImage(). Helper method to set the output parameters based on this image.

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

itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TOutputImage::ImageDimension
	)

Number of dimensions.

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

itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)

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

void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::LinearThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, int  threadId  )

protected

Implementation for resampling that works for with linear transformation types.

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

static Pointer itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::New ( )

static

Method for creation through the object factory.

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

void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::NonlinearThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, int  threadId  )

protected

Default implementation for resampling that works for any transformation type.

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

void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protected

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

virtual void itk::InvResampleImageFilter< 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::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetInterpolator ( InterpolatorType *  _arg )

virtual

Set the interpolator function. The default is itk::LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>. 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 , class TInterpolatorPrecisionType = double>

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputDirection ( DirectionType  _arg )

virtual

Set the output direciton cosine matrix.

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputOrigin ( OriginPointType  _arg )

virtual

Set the output image origin.

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

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

virtual

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

void itk::InvResampleImageFilter< 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::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputSpacing ( SpacingType  _arg )

virtual

Set the output image spacing.

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

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

virtual

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

virtual void itk::InvResampleImageFilter< 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::InvResampleImageFilter< 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. NOTE: This function seems redundant with the SetOutputParametersFromImage( image ) function

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

virtual void itk::InvResampleImageFilter< 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::InvResampleImageFilter< 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::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetUseReferenceImage ( bool  _arg )

virtual

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

void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

protected

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()

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::UseReferenceImageOff ( )

virtual

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

virtual void itk::InvResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::UseReferenceImageOn ( )

virtual

---

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

• itkInvResampleImageFilter.h