itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Pyramid Filters, Multithreaded Filters, Filters supporting Streaming]

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

#include <itkMultiResolutionPyramidImageFilter.h>

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

[legend]Collaboration diagram for itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef MultiResolutionPyramidImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Array2D< unsigned int >	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 *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
void	SetNumberOfLevels (unsigned int num)
virtual unsigned int	GetNumberOfLevels ()
void	SetSchedule (const ScheduleType &schedule)
virtual const ScheduleType &	GetSchedule ()
const unsigned int *	GetStartingShrinkFactors () const
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	SetMaximumError (double _arg)
virtual const double &	GetMaximumError ()
void	SetStartingShrinkFactors (unsigned int factor)
void	SetStartingShrinkFactors (unsigned int *factors)
virtual void	GenerateOutputRequestedRegion (DataObject *output)
Static Public Member Functions
Pointer	New ()
bool	IsScheduleDownwardDivisible (const ScheduleType &schedule)
Protected Member Functions
	MultiResolutionPyramidImageFilter ()
	~MultiResolutionPyramidImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()
Protected Attributes
double	m_MaximumError
unsigned int	m_NumberOfLevels
ScheduleType	m_Schedule

---

Detailed Description

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

Framework for creating images in a multi-resolution pyramid.

MultiResolutionPyramidImageFilter 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 ShrinkImageFiter.

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

Definition at line 107 of file itkMultiResolutionPyramidImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 115 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageConstPointer itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 135 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImagePointer itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 133 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageType itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImageType

Inherit types from Superclass. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 131 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImagePointer itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 134 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageType itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 132 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 114 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Array2D<unsigned int> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ScheduleType

ScheduleType typedef support. Definition at line 124 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef MultiResolutionPyramidImageFilter itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 112 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >. Definition at line 113 of file itkMultiResolutionPyramidImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::MultiResolutionPyramidImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::~MultiResolutionPyramidImageFilter (   )  [inline, protected]

Definition at line 203 of file itkMultiResolutionPyramidImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

Generate the output data. Reimplemented from itk::ImageSource< TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [virtual]

MultiResolutionPyramidImageFilter requires a larger input requested region than the output requested regions to accomdate the shrinkage and smoothing operations. As such, MultiResolutionPyramidImageFilter needs to provide an implementation for GenerateInputRequestedRegion(). The original documentation of this method is below. See also: ProcessObject::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (   )  [virtual]

MultiResolutionPyramidImageFilter produces images which are of different resolution and different pixel spacing than its input image. As such, MultiResolutionPyramidImageFilter 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> virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion (  DataObject *  output  )  [virtual]

Given one output whose requested region has been set, this method sets the requested region for the remaining output images. The original documentation of this method is below. See also: ProcessObject::GenerateOutputRequestedRegion(); Reimplemented from itk::ProcessObject. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const double& itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetMaximumError (   )  [virtual]

template<class TInputImage, class TOutputImage> virtual const char* itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetNumberOfLevels (   )  [virtual]

Get the number of multi-resolution levels.

template<class TInputImage, class TOutputImage> virtual const ScheduleType& itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetSchedule (   )  [virtual]

Get the multi-resolution schedule.

template<class TInputImage, class TOutputImage> const unsigned int* itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetStartingShrinkFactors (   )  const

Get the starting shrink factors

template<class TInputImage, class TOutputImage> bool itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::IsScheduleDownwardDivisible (  const ScheduleType &  schedule  )  [static]

Test if the schedule is downward divisible. This method returns true if at every level, the shrink factors are divisble by the shrink factors at the next level.

template<class TInputImage, class TOutputImage> itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension enumeration.

template<class TInputImage, class TOutputImage> Pointer itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetMaximumError (  double  _arg  )  [virtual]

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetNumberOfLevels (  unsigned int  num  )

Set the number of multi-resolution levels. The matrix containing the schedule will be resized accordingly. The schedule is populated with default values. At the coarset (0) level, the shrink factors are set 2^(nlevel - 1) for all dimension. These shrink factors are halved for subsequent levels. The number of levels is clamped to a minimum value of 1. All shrink factors are also clamped to a minimum value of 1.

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetSchedule (  const ScheduleType &  schedule  )

Set a multi-resolution schedule. The input schedule must have only ImageDimension number of columns and NumberOfLevels number of rows. For each dimension, the shrink factor must be non-increasing with respect to subsequent levels. This function will clamp shrink factors to satisify this condition. All shrink factors less than one will also be clamped to the value of 1.

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetStartingShrinkFactors (  unsigned int *  factors  )

Set the starting shrink factor for the coarset (0) resolution level. The schedule is then populated with defaults values obtained by halving the factors at the previous level. All shrink factors are clamped to a minimum value of 1.

template<class TInputImage, class TOutputImage> void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetStartingShrinkFactors (  unsigned int  factor  )

Set the starting shrink factor for the coarset (0) resolution level. The schedule is then populated with defaults values obtained by halving the factors at the previous level. All shrink factors are clamped to a minimum value of 1.

---

Member Data Documentation

template<class TInputImage, class TOutputImage> double itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_MaximumError [protected]

Definition at line 209 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_NumberOfLevels [protected]

Definition at line 210 of file itkMultiResolutionPyramidImageFilter.h.

template<class TInputImage, class TOutputImage> ScheduleType itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_Schedule [protected]

Definition at line 211 of file itkMultiResolutionPyramidImageFilter.h.

---

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

• itkMultiResolutionPyramidImageFilter.h

---