itk::SubsampleImageFilter< TInputImage, TOutputImage > Class Template Reference

Filter to subsample an image by a certain factor and apply the appropriate blurring (equivalent to voxel averaging for integer subsampling factors). More...

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

Collaboration diagram for itk::SubsampleImageFilter< TInputImage, TOutputImage >:

Public Types
typedef SubsampleImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer

Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
void	SetSubsamplingFactors (double data[])
void	SetSubsamplingFactors (double factor)
void	SetSubsamplingFactors (itk::Array< double > &sampling)
virtual const double *	GetSubsamplingFactors () const
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	SetMaximumError (double _arg)
virtual const double &	GetMaximumError ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	SubsampleImageFilter ()
	~SubsampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()

Protected Attributes
double	m_MaximumError
double	m_SubsamplingFactors [TInputImage::ImageDimension]

Detailed Description

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

Filter to subsample an image by a certain factor and apply the appropriate blurring (equivalent to voxel averaging for integer subsampling factors).

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageConstPointer itk::SubsampleImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePointer itk::SubsampleImageFilter< TInputImage, TOutputImage >::InputImagePointer

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageType itk::SubsampleImageFilter< TInputImage, TOutputImage >::InputImageType

Inherit types from Superclass.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePointer itk::SubsampleImageFilter< TInputImage, TOutputImage >::OutputImagePointer

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageType itk::SubsampleImageFilter< TInputImage, TOutputImage >::OutputImageType

template<class TInputImage , class TOutputImage >

typedef SmartPointer<Self> itk::SubsampleImageFilter< TInputImage, TOutputImage >::Pointer

template<class TInputImage , class TOutputImage >

typedef SubsampleImageFilter itk::SubsampleImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

template<class TInputImage , class TOutputImage >

typedef ImageToImageFilter<TInputImage,TOutputImage> itk::SubsampleImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::SubsampleImageFilter< TInputImage, TOutputImage >::SubsampleImageFilter ( )

protected

template<class TInputImage , class TOutputImage >

itk::SubsampleImageFilter< TInputImage, TOutputImage >::~SubsampleImageFilter ( )

inlineprotected

Member Function Documentation

template<class TInputImage , class TOutputImage >

void itk::SubsampleImageFilter< TInputImage, TOutputImage >::GenerateData ( )

protected

Generate the output data.

template<class TInputImage , class TOutputImage >

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

virtual

SubsampleImageFilter requires a larger input requested region than the output requested regions to accomdate the shrinkage and smoothing operations. As such, SubsampleImageFilter needs to provide an implementation for GenerateInputRequestedRegion(). The original documentation of this method is below.

See also

ProcessObject::GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >

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

virtual

SubsampleImageFilter produces images which are of different resolution and different pixel spacing than its input image. As such, SubsampleImageFilter 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 >

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

virtual

Run-time type information (and related methods).

template<class TInputImage , class TOutputImage >

virtual const double& itk::SubsampleImageFilter< TInputImage, TOutputImage >::GetMaximumError ( )

virtual

template<class TInputImage , class TOutputImage >

virtual const double* itk::SubsampleImageFilter< TInputImage, TOutputImage >::GetSubsamplingFactors ( ) const

virtual

template<class TInputImage , class TOutputImage >

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

ImageDimension enumeration.

template<class TInputImage , class TOutputImage >

itk::SubsampleImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro	(	OutputImageDimension	,
		unsigned	int,
		TOutputImage::ImageDimension
	)

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >

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

protected

template<class TInputImage , class TOutputImage >

virtual void itk::SubsampleImageFilter< TInputImage, TOutputImage >::SetMaximumError ( double  _arg )

virtual

template<class TInputImage , class TOutputImage >

void itk::SubsampleImageFilter< TInputImage, TOutputImage >::SetSubsamplingFactors

(

double

data[]

)

Directly Set/Get the array of subsampling factors for each image dimension

template<class TInputImage , class TOutputImage >

void itk::SubsampleImageFilter< TInputImage, TOutputImage >::SetSubsamplingFactors

(

double

factor

)

template<class TInputImage , class TOutputImage >

void itk::SubsampleImageFilter< TInputImage, TOutputImage >::SetSubsamplingFactors

(

itk::Array< double > &

sampling

)

Member Data Documentation

template<class TInputImage , class TOutputImage >

double itk::SubsampleImageFilter< TInputImage, TOutputImage >::m_MaximumError

protected

template<class TInputImage , class TOutputImage >

double itk::SubsampleImageFilter< TInputImage, TOutputImage >::m_SubsamplingFactors[TInputImage::ImageDimension]

protected

---

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

• itkSubsampleImageFilter.h