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

Filter to sub- or super-sample an image by a certain factor and apply the appropriate blurring (equivalent to voxel averaging for integer subsampling factors) when subsampling. More...

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

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

Public Types
typedef SampleImageFilter	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	SetDebug (bool b)
	Set the debugging output. More...
void	DebugOn ()
	Set debugging output on. More...
void	DebugOff ()
	Set debugging output off. More...
virtual void	VerboseOn ()
virtual void	VerboseOff ()
virtual bool	GetVerbose () const
virtual void	SetVerbose (bool _arg)
virtual void	IsotropicVoxelsOn ()
virtual void	IsotropicVoxelsOff ()
virtual bool	GetIsotropicVoxels () const
virtual void	SetIsotropicVoxels (bool _arg)
void	SetSamplingFactors (double data[])
void	SetSamplingFactors (itk::Array< double > &sampling)
virtual const double *	GetSamplingFactors () const
void	SetInterpolationType (InterpolationTypeEnum interp)
OutputImagePointer	GetSmoothedImage (unsigned int idim, OutputImagePointer image)
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()

Static Public Member Functions
static Pointer	New ()

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

Protected Attributes
bool	m_Verbose
bool	m_IsotropicVoxels
InterpolationTypeEnum	m_Interpolation
double	m_SamplingFactors [TInputImage::ImageDimension]

Detailed Description

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

Filter to sub- or super-sample an image by a certain factor and apply the appropriate blurring (equivalent to voxel averaging for integer subsampling factors) when subsampling.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

Inherit types from Superclass.

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

template<class TInputImage , class TOutputImage >

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

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

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

protected

template<class TInputImage , class TOutputImage >

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

inlineprotected

Member Function Documentation

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::DebugOff ( )

inline

Set debugging output off.

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::DebugOn ( )

inline

Set debugging output on.

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::GenerateData ( )

protectedvirtual

Generate the output data.

Reimplemented in itk::BinaryShapeBasedSuperSamplingFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

virtual

SampleImageFilter requires a larger input requested region than the output requested regions to accomdate the shrinkage and smoothing operations. As such, SampleImageFilter 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::SampleImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

virtual

SampleImageFilter produces images which are of different resolution and different pixel spacing than its input image. As such, SampleImageFilter 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::SampleImageFilter< TInputImage, TOutputImage >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in itk::BinaryShapeBasedSuperSamplingFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual bool itk::SampleImageFilter< TInputImage, TOutputImage >::GetIsotropicVoxels ( ) const

virtual

template<class TInputImage , class TOutputImage >

virtual const double* itk::SampleImageFilter< TInputImage, TOutputImage >::GetSamplingFactors ( ) const

virtual

template<class TInputImage , class TOutputImage >

OutputImagePointer itk::SampleImageFilter< TInputImage, TOutputImage >::GetSmoothedImage	(	unsigned int	idim,
		OutputImagePointer	image
	)

template<class TInputImage , class TOutputImage >

virtual bool itk::SampleImageFilter< TInputImage, TOutputImage >::GetVerbose ( ) const

virtual

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::IsotropicVoxelsOff ( )

virtual

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::IsotropicVoxelsOn ( )

virtual

template<class TInputImage , class TOutputImage >

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

ImageDimension enumeration.

template<class TInputImage , class TOutputImage >

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

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >

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

protected

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::SetDebug ( bool  b )

inline

Set the debugging output.

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::SetInterpolationType ( InterpolationTypeEnum  interp )

inline

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::SetIsotropicVoxels ( bool  _arg )

virtual

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::SetSamplingFactors

(

double

data[]

)

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

template<class TInputImage , class TOutputImage >

void itk::SampleImageFilter< TInputImage, TOutputImage >::SetSamplingFactors

(

itk::Array< double > &

sampling

)

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::SetVerbose ( bool  _arg )

virtual

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::VerboseOff ( )

virtual

template<class TInputImage , class TOutputImage >

virtual void itk::SampleImageFilter< TInputImage, TOutputImage >::VerboseOn ( )

virtual

Member Data Documentation

template<class TInputImage , class TOutputImage >

InterpolationTypeEnum itk::SampleImageFilter< TInputImage, TOutputImage >::m_Interpolation

protected

template<class TInputImage , class TOutputImage >

bool itk::SampleImageFilter< TInputImage, TOutputImage >::m_IsotropicVoxels

protected

template<class TInputImage , class TOutputImage >

double itk::SampleImageFilter< TInputImage, TOutputImage >::m_SamplingFactors[TInputImage::ImageDimension]

protected

template<class TInputImage , class TOutputImage >

bool itk::SampleImageFilter< TInputImage, TOutputImage >::m_Verbose

protected

---

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

• itkSampleImageFilter.h