ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Geometric Transformation Filters » Image Pyramid FiltersSupport for MultiThreading » | MultiThreaded FiltersProcessing images region by region » | Filters supporting StreamingGroup Registration » | Module ITKRegistrationCommon

#include <itkMultiResolutionPyramidImageFilter.h>

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

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GenerateOutputInformation () override
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfLevels () const
 
virtual const ScheduleType & GetSchedule () const
 
const unsigned int * GetStartingShrinkFactors () const
 
virtual void SetNumberOfLevels (unsigned int num)
 
virtual void SetSchedule (const ScheduleType &schedule)
 
virtual void SetStartingShrinkFactors (const unsigned int *factors)
 
virtual void SetStartingShrinkFactors (unsigned int factor)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
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 ()
 
const OutputImageType * GetOutput () const
 
OutputImageType * GetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
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 ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
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)
 
virtual void SetReleaseDataFlag (bool val)
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
MultiThreaderType * GetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
double m_MaximumError
 
unsigned int m_NumberOfLevels
 
ScheduleType m_Schedule
 
bool m_UseShrinkImageFilter
 
void GenerateOutputRequestedRegion (DataObject *refOutput) override
 
void GenerateInputRequestedRegion () override
 
virtual void SetMaximumError (double _arg)
 
virtual const double & GetMaximumError () const
 
virtual void SetUseShrinkImageFilter (bool _arg)
 
virtual bool GetUseShrinkImageFilter () const
 
virtual void UseShrinkImageFilterOn ()
 
virtual void UseShrinkImageFilterOff ()
 
 MultiResolutionPyramidImageFilter ()
 
 ~MultiResolutionPyramidImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *object)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *object)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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 (coarsest) 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/RegistrationITKv4/MultiResImageRegistration3.cxx.

Definition at line 109 of file itkMultiResolutionPyramidImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 118 of file itkMultiResolutionPyramidImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename Superclass::InputImageConstPointer

Definition at line 138 of file itkMultiResolutionPyramidImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename Superclass::InputImagePointer

Definition at line 136 of file itkMultiResolutionPyramidImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::InputImageType = typename Superclass::InputImageType

Inherit types from Superclass.

Definition at line 134 of file itkMultiResolutionPyramidImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename Superclass::OutputImagePointer

Definition at line 137 of file itkMultiResolutionPyramidImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImageType = typename Superclass::OutputImageType

Definition at line 135 of file itkMultiResolutionPyramidImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 117 of file itkMultiResolutionPyramidImageFilter.h.

◆ ScheduleType

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ScheduleType = Array2D<unsigned int>

ScheduleType type alias support

Definition at line 127 of file itkMultiResolutionPyramidImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Self = MultiResolutionPyramidImageFilter

Standard class type aliases.

Definition at line 115 of file itkMultiResolutionPyramidImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 116 of file itkMultiResolutionPyramidImageFilter.h.

Constructor & Destructor Documentation

◆ MultiResolutionPyramidImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::MultiResolutionPyramidImageFilter ( )
protected

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();

◆ ~MultiResolutionPyramidImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::~MultiResolutionPyramidImageFilter ( )
overrideprotecteddefault

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();

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateData()

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

◆ GenerateInputRequestedRegion()

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

◆ GenerateOutputInformation()

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

◆ GenerateOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion ( DataObject *  refOutput)
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 >.

◆ GetMaximumError()

template<typename TInputImage , typename TOutputImage >
virtual const double& itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetMaximumError ( ) const
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();

◆ GetNameOfClass()

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

◆ GetNumberOfLevels()

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

Get the number of multi-resolution levels.

◆ GetSchedule()

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

Get the multi-resolution schedule.

◆ GetStartingShrinkFactors()

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

Get the starting shrink factors

◆ GetUseShrinkImageFilter()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GetUseShrinkImageFilter ( ) const
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();

◆ IsScheduleDownwardDivisible()

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 divisible by the shrink factors at the next level.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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

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

◆ SetMaximumError()

template<typename TInputImage , typename TOutputImage >
virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetMaximumError ( double  _arg)
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();

◆ SetNumberOfLevels()

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.

◆ SetSchedule()

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 satisfy this condition. All shrink factors less than one will also be clamped to the value of 1.

◆ SetStartingShrinkFactors() [1/2]

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

◆ SetStartingShrinkFactors() [2/2]

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.

◆ SetUseShrinkImageFilter()

template<typename TInputImage , typename TOutputImage >
virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::SetUseShrinkImageFilter ( bool  _arg)
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();

◆ UseShrinkImageFilterOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::UseShrinkImageFilterOff ( )
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();

◆ UseShrinkImageFilterOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::UseShrinkImageFilterOn ( )
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();

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension enumeration.

Definition at line 130 of file itkMultiResolutionPyramidImageFilter.h.

◆ m_MaximumError

template<typename TInputImage , typename TOutputImage >
double itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_MaximumError
protected

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();

Definition at line 234 of file itkMultiResolutionPyramidImageFilter.h.

◆ m_NumberOfLevels

template<typename TInputImage , typename TOutputImage >
unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_NumberOfLevels
protected

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();

Definition at line 236 of file itkMultiResolutionPyramidImageFilter.h.

◆ m_Schedule

template<typename TInputImage , typename TOutputImage >
ScheduleType itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_Schedule
protected

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();

Definition at line 237 of file itkMultiResolutionPyramidImageFilter.h.

◆ m_UseShrinkImageFilter

template<typename TInputImage , typename TOutputImage >
bool itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::m_UseShrinkImageFilter
protected

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();

Definition at line 239 of file itkMultiResolutionPyramidImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 131 of file itkMultiResolutionPyramidImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:29:35 for ITK by   doxygen 1.8.16