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

#include <itkRecursiveMultiResolutionPyramidImageFilter.h>

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

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

List of all members.

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 RecursiveMultiResolutionPyramidImageFilter	Self
typedef MultiResolutionPyramidImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >
typedef Array2D< unsigned int >	ScheduleType
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	GenerateInputRequestedRegion ()
virtual const char *	GetNameOfClass () const
virtual void	GenerateOutputRequestedRegion (DataObject *output)
Public Member Functions inherited from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >
virtual void	GenerateOutputInformation ()
virtual const double &	GetMaximumError ()
virtual unsigned int	GetNumberOfLevels () const
virtual const ScheduleType &	GetSchedule ()
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)
	typedef (Concept::SameDimension< ImageDimension, OutputImageDimension >) SameDimensionCheck
	typedef (Concept::HasNumericTraits< typename TOutputImage::PixelType >) OutputHasNumericTraitsCheck
virtual void	UseShrinkImageFilterOff ()
virtual void	UseShrinkImageFilterOn ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
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)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 Pointer	New ()
Static Public Member Functions inherited from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >
static bool	IsScheduleDownwardDivisible (const ScheduleType &schedule)

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

Protected Member Functions
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	RecursiveMultiResolutionPyramidImageFilter ()
	~RecursiveMultiResolutionPyramidImageFilter ()
Protected Member Functions inherited from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >
	MultiResolutionPyramidImageFilter ()
	~MultiResolutionPyramidImageFilter ()
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 ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) 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 ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) 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 ()
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 ()

Private Member Functions
void	operator= (const Self &)
	RecursiveMultiResolutionPyramidImageFilter (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >
double	m_MaximumError
unsigned int	m_NumberOfLevels
ScheduleType	m_Schedule
bool	m_UseShrinkImageFilter

---

Detailed Description

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

Creates a multi-resolution pyramid using a recursive implementation.

RecursiveMultiResolutionPyramidImageFilter creates an image pryamid according to a user defined multi-resolution schedule.

If a schedule is downward divisible, a fast recursive implementation is used to generate the output images. If the schedule is not downward divisible the superclass (MultiResolutionPyramidImageFilter) implementation is used instead. A schedule is downward divisible if at every level, the shrink factors are divisible by the shrink factors at the next level for the same dimension.

See documentation of MultiResolutionPyramidImageFilter for information on how to specify a multi-resolution schedule.

Note that unlike the MultiResolutionPyramidImageFilter, RecursiveMultiResolutionPyramidImageFilter will not smooth the output at the finest level if the shrink factors are all one and the schedule is downward divisible.

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:

MultiResolutionPyramidImageFilter

Wiki Examples:

• All Examples

• Construct a multiresolution pyramid from an image

Definition at line 67 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 76 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 94 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 92 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Inherit types from the superclass..

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 90 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 93 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Some convenient typedefs.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 91 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 75 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 72 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 74 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

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

protected

template<class TInputImage , class TOutputImage >

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

inlineprotected

Definition at line 114 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::RecursiveMultiResolutionPyramidImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) 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::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

protectedvirtual

Generate the output data.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

virtual

RecursiveMultiResolutionPyramidImageFilter 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::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

virtual

Given one output whose requested region has been set, this method sets the requtested region for the remaining output images. The original documentation of this method is below.

See also:

ProcessObject::GenerateOutputRequestedRegion();

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual const char* itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

protectedvirtual

End concept checking

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

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

static

ImageDimension enumeration.

Reimplemented from itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 87 of file itkRecursiveMultiResolutionPyramidImageFilter.h.

---

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

• itkRecursiveMultiResolutionPyramidImageFilter.h