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

#include <itkMultiResolutionPyramidImageFilter.h>

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

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

Detailed Description

template<typename TInputImage, typename 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 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

Examples:

Examples/RegistrationITKv3/MultiResImageRegistration1.cxx, Examples/RegistrationITKv3/MultiResImageRegistration3.cxx, and Examples/RegistrationITKv4/MultiResImageRegistration3.cxx.

Definition at line 112 of file itkMultiResolutionPyramidImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageType	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef Array2D< unsigned int >	ScheduleType
typedef MultiResolutionPyramidImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef MultiThreader	MultiThreaderType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void	GenerateInputRequestedRegion () override
virtual void	GenerateOutputInformation () override
virtual const double &	GetMaximumError () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfLevels () const
virtual const ScheduleType &	GetSchedule () const
const unsigned int *	GetStartingShrinkFactors () const
virtual bool	GetUseShrinkImageFilter () const
virtual void	SetMaximumError (double _arg)
virtual void	SetNumberOfLevels (unsigned int num)
virtual void	SetSchedule (const ScheduleType &schedule)
virtual void	SetStartingShrinkFactors (unsigned int factor)
virtual void	SetStartingShrinkFactors (unsigned int *factors)
virtual void	SetUseShrinkImageFilter (bool _arg)
virtual void	UseShrinkImageFilterOff ()
virtual void	UseShrinkImageFilterOn ()
virtual void	GenerateOutputRequestedRegion (DataObject *output) override
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput () override
virtual void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static bool	IsScheduleDownwardDivisible (const ScheduleType &schedule)
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	GenerateData () override
	MultiResolutionPyramidImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~MultiResolutionPyramidImageFilter () override
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation () override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource () override
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
double	m_MaximumError
unsigned int	m_NumberOfLevels
ScheduleType	m_Schedule
bool	m_UseShrinkImageFilter
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >

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

Definition at line 120 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 143 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 141 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Inherit types from Superclass.

Definition at line 139 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 142 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 140 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 119 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

ScheduleType typedef support.

Definition at line 126 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Standard class typedefs.

Definition at line 117 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

Definition at line 118 of file itkMultiResolutionPyramidImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >

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

protected

template<typename TInputImage , typename TOutputImage >

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

inlineoverrideprotected

Definition at line 224 of file itkMultiResolutionPyramidImageFilter.h.

Member Function Documentation

template<typename TInputImage , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

Generate the output data.

Reimplemented from itk::ImageSource< TOutputImage >.

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

template<typename TInputImage , typename TOutputImage >

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

overridevirtual

MultiResolutionPyramidImageFilter requires a larger input requested region than the output requested regions to accommodate 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<typename TInputImage , typename TOutputImage >

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

overridevirtual

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<typename TInputImage , typename TOutputImage >

virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion ( DataObject *  output )

overridevirtual

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<typename TInputImage , typename TOutputImage >

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

virtual

template<typename TInputImage , typename 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<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetNumberOfLevels ( ) const

virtual

Get the number of multi-resolution levels.

template<typename TInputImage , typename TOutputImage >

virtual const ScheduleType& itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetSchedule ( ) const

virtual

Get the multi-resolution schedule.

template<typename TInputImage , typename TOutputImage >

const unsigned int* itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetStartingShrinkFactors

(

)

const

Get the starting shrink factors

template<typename TInputImage , typename TOutputImage >

virtual bool itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetUseShrinkImageFilter ( ) const

virtual

template<typename TInputImage , typename TOutputImage >

static 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<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

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<typename TInputImage , typename TOutputImage >

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

virtual

template<typename TInputImage , typename TOutputImage >

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

virtual

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 coarsest (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<typename TInputImage , typename TOutputImage >

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

virtual

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<typename TInputImage , typename TOutputImage >

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

virtual

Set the starting shrink factor for the coarsest (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<typename TInputImage , typename TOutputImage >

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

virtual

template<typename TInputImage , typename TOutputImage >

virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetUseShrinkImageFilter ( bool  _arg )

virtual

template<typename TInputImage , typename TOutputImage >

virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::UseShrinkImageFilterOff ( )

virtual

template<typename TInputImage , typename TOutputImage >

virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::UseShrinkImageFilterOn ( )

virtual

Member Data Documentation

template<typename TInputImage , typename TOutputImage >

const unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

static

ImageDimension enumeration.

Definition at line 133 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

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

protected

Definition at line 230 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_NumberOfLevels

protected

Definition at line 232 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

ScheduleType itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_Schedule

protected

Definition at line 233 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

bool itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_UseShrinkImageFilter

protected

Definition at line 235 of file itkMultiResolutionPyramidImageFilter.h.

template<typename TInputImage , typename TOutputImage >

const unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension enumeration.

Definition at line 135 of file itkMultiResolutionPyramidImageFilter.h.

---

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

• itkMultiResolutionPyramidImageFilter.h