#include <itkGenericMultiResolutionPyramidImageFilter.h>

Detailed Description

template<class TInputImage, class TOutputImage, class TPrecisionType = double>
class itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >

Framework for creating images in a multi-resolution pyramid.

GenericMultiResolutionPyramidImageFilter provides a generic framework to to create a image pyramid according to a user defined multi-resolution rescale and smoothing schedules.

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

The rescale schedule is stored as an unsigned int matrix. An element of the table can be access via the double bracket notation: schedule[level][dimension] For example: 8 4 4 4 4 2

is a rescale 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 rescale 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 rescale schedule via GetRescaleSchedule() They may make alteration and reset it using SetRescaleSchedule()

To generate each output image, recursive Gaussian smoothing is performed using a SmoothingRecursiveGaussianImageFilter.

The user can make alteration on smoothing schedule via SetSmoothingSchedule() For example, for 4 levels smoothing schedule would be: 3 4 5 2 2 2 0 1 2 0 0 0

In the first level all sigma are set to the same value 2 across each axis. Sigma is measured in the units of image spacing. Use different values along each axis if you would like perform nonidentical smoothing (see level 1) Although for the level 2 no smoothing will be performed because all sigma values are equal zeros. For the last level 3 smoothing will be performed with sigma 0 for x axis.

The default smoothing schedule is derived from the rescale schedule, where each element is computed as: 0.5 * rescale_factor * image_spacing.

The user can get a copy of the schedule via GetSmoothingSchedule()

The smoothed image is then downsampled using a ResampleImageFilter or ShrinkImageFilter depending on SetUseShrinkImageFilter().

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

The user can influence whether or not rescale schedule or smoothing schedule will be used via SetRescaleScheduleToUnity() and SetSmoothingScheduleToZero() methods.

The GenericMultiResolutionPyramidImageFilter provides direct control to compute only single level of the pyramid via SetCurrentLevel() and SetComputeOnlyForCurrentLevel() methods.

Author: Denis P. Shamonin and Marius Staring. Division of Image Processing, Department of Radiology, Leiden, The Netherlands

This implementation was taken from elastix (http://elastix.dev/).

Note: This work was funded by the Netherlands Organisation for Scientific Research (NWO NRG-2010.02 and NWO 639.021.124).

See also: SmoothingRecursiveGaussianImageFilter; ResampleImageFilter; ShrinkImageFilter

Definition at line 117 of file itkGenericMultiResolutionPyramidImageFilter.h.

Inheritance diagram for itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >:

[legend]

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	RescaleFactorArrayType = SigmaArrayType

using	RescaleScheduleType = ScheduleType

using	ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType

using	Self = GenericMultiResolutionPyramidImageFilter

using	SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>

using	SmoothingScheduleType = vnl_matrix<ScalarRealType>

using	SpacingType = typename Superclass::InputImageType::SpacingType

using	Superclass = MultiResolutionPyramidImageFilter<TInputImage, TOutputImage>

using	SuperSuperclass = typename Superclass::Superclass

Public Member Functions
virtual void	ComputeOnlyForCurrentLevelOff ()

virtual void	ComputeOnlyForCurrentLevelOn ()

virtual const char *	GetClassName () const

virtual bool	GetComputeOnlyForCurrentLevel () const

virtual const unsigned int &	GetCurrentLevel ()

const RescaleScheduleType &	GetRescaleSchedule () const

virtual const SmoothingScheduleType &	GetSmoothingSchedule ()

	ITK_DISALLOW_COPY_AND_MOVE (GenericMultiResolutionPyramidImageFilter)

	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)

	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)

virtual void	SetComputeOnlyForCurrentLevel (const bool _arg)

virtual void	SetCurrentLevel (unsigned int level)

void	SetNumberOfLevels (unsigned int num) override

virtual void	SetRescaleSchedule (const RescaleScheduleType &schedule)

virtual void	SetRescaleScheduleToUnity ()

void	SetSchedule (const ScheduleType &schedule) override

virtual void	SetSmoothingSchedule (const SmoothingScheduleType &schedule)

virtual void	SetSmoothingScheduleToZero ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

void	GenerateOutputRequestedRegion (DataObject *output) override

	GenericMultiResolutionPyramidImageFilter ()

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

void	ReleaseOutputs ()

	~GenericMultiResolutionPyramidImageFilter () override=default

Protected Attributes
bool	m_ComputeOnlyForCurrentLevel {}

unsigned int	m_CurrentLevel {}

SmoothingScheduleType	m_SmoothingSchedule {}

bool	m_SmoothingScheduleDefined {}

Private Types
using	ImageToImageFilterDifferentTypes = ImageToImageFilter<InputImageType, OutputImageType>

using	ImageToImageFilterSameTypes = ImageToImageFilter<OutputImageType, OutputImageType>

using	SmootherType = SmoothingRecursiveGaussianImageFilter<InputImageType, OutputImageType>

Private Member Functions
bool	AreRescaleFactorsAllOnes (const RescaleFactorArrayType &rescaleFactorArray) const

bool	AreSigmasAllZeros (const SigmaArrayType &sigmaArray) const

bool	ComputeForCurrentLevel (const unsigned int level) const

void	DefineShrinkerOrResampler (const bool sameType, const RescaleFactorArrayType &shrinkFactors, const OutputImagePointer &outputPtr, typename ImageToImageFilterSameTypes::Pointer &rescaleSameTypes, typename ImageToImageFilterDifferentTypes::Pointer &rescaleDifferentTypes)

double	GetDefaultSigma (const unsigned int level, const unsigned int dim, const unsigned int *factors, const SpacingType &spacing) const

void	GetShrinkFactors (const unsigned int level, RescaleFactorArrayType &shrinkFactors) const

void	GetSigma (const unsigned int level, SigmaArrayType &sigmaArray) const

bool	IsRescaleUsed () const

bool	IsSmoothingUsed () const

void	SetSmoothingScheduleToDefault ()

int	SetupShrinkerOrResampler (const unsigned int level, typename SmootherType::Pointer &smoother, const bool sameType, const InputImageConstPointer &input, const OutputImagePointer &outputPtr, typename ImageToImageFilterSameTypes::Pointer &rescaleSameTypes, typename ImageToImageFilterDifferentTypes::Pointer &rescaleDifferentTypes)

bool	SetupSmoother (const unsigned int level, typename SmootherType::Pointer &smoother, const InputImageConstPointer &input)