Framework for creating images in a multi-resolution pyramid. More...

Inheritance diagram for itk::UCLMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TScheduleElement >:

Collaboration diagram for itk::UCLMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TScheduleElement >:

Public Types
typedef UCLMultiResolutionPyramidImageFilter	Self

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef Array2D< TScheduleElement >	ScheduleType

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)

virtual void	SetNumberOfLevels (unsigned int num)

virtual unsigned int	GetNumberOfLevels () const

virtual void	SetSchedule (const ScheduleType &schedule)

virtual const ScheduleType &	GetSchedule ()

virtual void	SetStartingShrinkFactors (TScheduleElement factor)

virtual void	SetStartingShrinkFactors (TScheduleElement *factors)

const unsigned int *	GetStartingShrinkFactors () const

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateInputRequestedRegion ()

virtual void	SetMaximumError (double _arg)

virtual const double &	GetMaximumError ()

virtual void	SetUseShrinkImageFilter (bool _arg)

virtual bool	GetUseShrinkImageFilter () const

virtual void	UseShrinkImageFilterOn ()

virtual void	UseShrinkImageFilterOff ()

Static Public Member Functions
static Pointer	New ()

static bool	IsScheduleDownwardDivisible (const ScheduleType &schedule)

Protected Member Functions
	UCLMultiResolutionPyramidImageFilter ()

	~UCLMultiResolutionPyramidImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const

void	GenerateData ()

Protected Attributes
double	m_MaximumError

unsigned int	m_NumberOfLevels

ScheduleType	m_Schedule

bool	m_UseShrinkImageFilter

Detailed Description

template<class TInputImage, class TOutputImage, class TScheduleElement>
class itk::UCLMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TScheduleElement >

Framework for creating images in a multi-resolution pyramid.

Originally copied from ITK. Adapted to allow non-integer levels.

UCLMultiResolutionPyramidImageFilter provides a generic framework to to create a image pryamid according to a user defined multi-resolution schedule.

The multi-resolution schedule is specified in terms for shrink factors at each multi-resolution level for each dimension.

A user can either use the default schedules or specify each factor in the schedules directly.

The schedule is stored as an unsigned int matrix. An element of the table can be access via the double bracket notation: table[resLevel][dimension]

For example: 8 4 4 4 4 2

is a schedule for two computation level. In the first (coarest) level the image is reduce by a factor of 8 in the column dimension, factor of 4 in the row dimension and factor of 4 in the slice dimension. In the second level, the image is reduce by a factor of 4 in the column dimension, 4 is the row dimension and 2 in the slice dimension.

The method SetNumberOfLevels() set the number of computation levels in the pyramid. This method will allocate memory for the multi-resolution schedule table. This method generates defaults tables with the starting shrink factor for all dimension set to 2^(NumberOfLevel - 1). All factors are halved for all subsequent levels. For example if the number of levels was set to 4, the default table is:

8 8 8 4 4 4 2 2 2 1 1 1

The user can get a copy of the schedule via GetSchedule() They may make alteration and reset it using SetSchedule().

A user can create a default table by specifying the starting shrink factors via methods SetStartingShrinkFactors() The factors for subsequent level is generated by halving the factor or setting to one, depending on which is larger.

For example, for 4 levels and starting factors of 8,8,4 the default table would be:

8 8 4 4 4 2 2 2 1 1 1 1

When this filter is updated, NumberOfLevels outputs are produced. The N'th output correspond to the N'th level of the pyramid.

To generate each output image, Gaussian smoothing is first performed using a DiscreteGaussianImageFilter with variance (shrink factor / 2)^2. The smoothed image is then downsampled using a ResampleImageFilter.

Note that even if the shrink factors are all equal to one, a smoothing will still be applied. The output at the finest level of the pyramid will thus typically be a smoothed version of the input.

This class is templated over the input image type and the output image type.

This filter uses multithreaded filters to perform the smoothing and downsampling.

This filter supports streaming.

See also: DiscreteGaussianImageFilter; ShrinkImageFilter