go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
elastix::FixedGenericPyramid< TElastix > Class Template Reference

#include <elxFixedGenericPyramid.h>

Detailed Description

template<class TElastix>
class elastix::FixedGenericPyramid< TElastix >

A pyramid based on the itk::GenericMultiResolutionPyramidImageFilter.

It is generic since it has all functionality that the FixedRecursivePyramid, FixedShrinkingPyramid and FixedSmoothingPyramid have together. This pyramid has two separate schedules: one for size rescaling and one for the Gaussian smoothing factor sigma. In addition, it has an option to compute pyramid output per resolution, and not all at once, to reduce memory consumption.

The parameters used in this class are:

Parameters:

FixedImagePyramid: Select this pyramid as follows:
(FixedImagePyramid "FixedGenericImagePyramid")

FixedImagePyramidRescaleSchedule: downsampling factors for the fixed image pyramid.
For each dimension, for each resolution level, the downsampling factor of the fixed image can be specified.
Syntax for 2D images:
(FixedImagePyramidRescaleSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (FixedImagePyramidRescaleSchedule 4 4 2 2 1 1)
Default: isotropic, halved in each resolution, so, like in the example. If ImagePyramidRescaleSchedule is specified, that schedule is used for both fixed and moving image pyramid.

ImagePyramidRescaleSchedule: rescale schedule for both pyramids

ImagePyramidSchedule: same as ImagePyramidRescaleSchedule

FixedImagePyramidSchedule: same as FixedImagePyramidRescaleSchedule

FixedImagePyramidSmoothingSchedule: sigma's for smoothing the fixed image pyramid.
For each dimension, for each resolution level, the sigma of the fixed image can be specified.
Syntax for 2D images:
(FixedImagePyramidSmoothingSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (FixedImagePyramidSmoothingSchedule 4 4 2 2 1 1)
Default: 0.5 x rescale_factor x fixed_image_spacing.
If ImagePyramidSmoothingSchedule is specified, that schedule is used for both fixed and moving image pyramid.

ImagePyramidSmoothingSchedule: smoothing schedule for both pyramids

ComputePyramidImagesPerResolution: Flag to specify if all resolution levels are computed at once, or per resolution. Latter saves memory.
example: (ComputePyramidImagesPerResolution "true")
Default false.

ImagePyramidUseShrinkImageFilter: Flag to specify if the ShrinkingImageFilter is used for rescaling the image, or the ResampleImageFilter. Skrinker is faster.
example: (ImagePyramidUseShrinkImageFilter "true")
Default false, so by default the resampler is used.

Definition at line 68 of file elxFixedGenericPyramid.h.

Inheritance diagram for elastix::FixedGenericPyramid< TElastix >:
Inheritance graph
[legend]

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using ITKBaseType = typename Superclass2::ITKBaseType
 
using Pointer = itk::SmartPointer< Self >
 
using RescaleScheduleType = ScheduleType
 
using Self = FixedGenericPyramid
 
using SmoothingScheduleType = Array2D< ScalarRealType >
 
using Superclass1 = itk::GenericMultiResolutionPyramidImageFilter< typename FixedImagePyramidBase< TElastix >::InputImageType, typename FixedImagePyramidBase< TElastix >::OutputImageType >
 
using Superclass2 = FixedImagePyramidBase< TElastix >
 
- Public Types inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RescaleFactorArrayType = SigmaArrayType
 
using RescaleScheduleType = ScheduleType
 
using ScalarRealType = typename NumericTraits< PixelType >::ScalarRealType
 
using Self = GenericMultiResolutionPyramidImageFilter
 
using SigmaArrayType = FixedArray< ScalarRealType, Self::ImageDimension >
 
using SmoothingScheduleType = Array2D< ScalarRealType >
 
using SpacingType = typename Superclass::InputImageType::SpacingType
 
using Superclass = MultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
 
using SuperSuperclass = typename Superclass::Superclass
 
- Public Types inherited from elastix::FixedImagePyramidBase< TElastix >
using ElastixType = TElastix
 
using InputImageType = typename ElastixType::FixedImageType
 
using ITKBaseType = itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageType >
 
using OutputImageType = typename ElastixType::FixedImageType
 
using RegistrationType = typename ElastixType::RegistrationBaseType
 
using ScheduleType = typename ITKBaseType::ScheduleType
 
using Self = FixedImagePyramidBase
 
using Superclass = BaseComponentSE< TElastix >
 
- Public Types inherited from elastix::BaseComponentSE< TElastix >
using ConfigurationPointer = Configuration::Pointer
 
using ElastixType = TElastix
 
using RegistrationType = typename ElastixType::RegistrationBaseType
 
using Self = BaseComponentSE
 
using Superclass = BaseComponent
 

Public Member Functions

void BeforeEachResolution () override
 
 elxClassNameMacro ("FixedGenericImagePyramid")
 
virtual const char * GetClassName () const
 
 ITK_DISALLOW_COPY_AND_MOVE (FixedGenericPyramid)
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
 
void SetFixedSchedule () override
 
- Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
virtual void ComputeOnlyForCurrentLevelOff ()
 
virtual void ComputeOnlyForCurrentLevelOn ()
 
virtual const char * GetClassName () const
 
virtual bool GetComputeOnlyForCurrentLevel () const
 
virtual const unsigned intGetCurrentLevel ()
 
const RescaleScheduleTypeGetRescaleSchedule () const
 
virtual const SmoothingScheduleTypeGetSmoothingSchedule ()
 
 ITK_DISALLOW_COPY_AND_MOVE (GenericMultiResolutionPyramidImageFilter)
 
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
 
virtual void SetComputeOnlyForCurrentLevel (const bool _arg)
 
virtual void SetCurrentLevel (unsigned int level)
 
void SetNumberOfLevels (unsigned int num) override
 
virtual void SetRescaleSchedule (const RescaleScheduleType &schedule)
 
virtual void SetRescaleScheduleToUnity ()
 
void SetSchedule (const ScheduleType &schedule) override
 
virtual void SetSmoothingSchedule (const SmoothingScheduleType &schedule)
 
virtual void SetSmoothingScheduleToZero ()
 
- Public Member Functions inherited from elastix::FixedImagePyramidBase< TElastix >
void BeforeEachResolutionBase () override
 
void BeforeRegistrationBase () override
 
ITKBaseTypeGetAsITKBaseType ()
 
const ITKBaseTypeGetAsITKBaseType () const
 
virtual const char * GetClassName () const
 
 ITK_DISALLOW_COPY_AND_MOVE (FixedImagePyramidBase)
 
virtual void SetFixedSchedule ()
 
void WritePyramidImage (const std::string &filename, const unsigned int level)
 
- Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
void AddTargetCellToIterationInfo (const char *const name)
 
ConfigurationGetConfiguration () const
 
ElastixTypeGetElastix () const
 
xl::xoutbaseGetIterationInfoAt (const char *const name)
 
RegistrationTypeGetRegistration () const
 
 ITK_DISALLOW_COPY_AND_MOVE (BaseComponentSE)
 
int RemoveTargetCellFromIterationInfo (const char *const name)
 
void SetConfiguration (Configuration *_arg)
 
void SetElastix (ElastixType *_arg)
 
- Public Member Functions inherited from elastix::BaseComponent
virtual void AfterEachIteration ()
 
virtual void AfterEachIterationBase ()
 
virtual void AfterEachResolution ()
 
virtual void AfterEachResolutionBase ()
 
virtual void AfterRegistration ()
 
virtual void AfterRegistrationBase ()
 
virtual int BeforeAll ()
 
virtual int BeforeAllBase ()
 
virtual void BeforeEachResolution ()
 
virtual void BeforeEachResolutionBase ()
 
virtual void BeforeRegistration ()
 
virtual void BeforeRegistrationBase ()
 
virtual const char * elxGetClassName () const
 
const char * GetComponentLabel () const
 
 ITK_DISALLOW_COPY_AND_MOVE (BaseComponent)
 
 itkTypeMacroNoParent (BaseComponent)
 
void SetComponentLabel (const char *label, unsigned int idx)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
static Pointer New ()
 
- Static Public Member Functions inherited from elastix::BaseComponent
template<typename TBaseComponent >
static auto AsITKBaseType (TBaseComponent *const baseComponent) -> decltype(baseComponent->GetAsITKBaseType())
 
static void InitializeElastixExecutable ()
 
static bool IsElastixLibrary ()
 

Protected Member Functions

 FixedGenericPyramid ()=default
 
 ~FixedGenericPyramid () override=default
 
- Protected Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
 GenericMultiResolutionPyramidImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReleaseOutputs ()
 
 ~GenericMultiResolutionPyramidImageFilter () override=default
 
- Protected Member Functions inherited from elastix::FixedImagePyramidBase< TElastix >
 FixedImagePyramidBase ()=default
 
 ~FixedImagePyramidBase () override=default
 
- Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
 BaseComponentSE ()=default
 
 ~BaseComponentSE () override=default
 
- Protected Member Functions inherited from elastix::BaseComponent
 BaseComponent ()=default
 
virtual ~BaseComponent ()=default
 

Private Attributes

 elxOverrideGetSelfMacro
 

Additional Inherited Members

- Protected Attributes inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
bool m_ComputeOnlyForCurrentLevel
 
unsigned int m_CurrentLevel
 
SmoothingScheduleType m_SmoothingSchedule
 
bool m_SmoothingScheduleDefined
 
- Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer m_Configuration {}
 
itk::WeakPointer< TElastix > m_Elastix {}
 
RegistrationTypem_Registration {}
 

Member Typedef Documentation

◆ ConstPointer

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 83 of file elxFixedGenericPyramid.h.

◆ ITKBaseType

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType

Definition at line 113 of file elxFixedGenericPyramid.h.

◆ Pointer

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::Pointer = itk::SmartPointer<Self>

Definition at line 82 of file elxFixedGenericPyramid.h.

◆ RescaleScheduleType

template<class TElastix >
using itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >::RescaleScheduleType = ScheduleType

◆ Self

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::Self = FixedGenericPyramid

Standard ITK-stuff.

Definition at line 77 of file elxFixedGenericPyramid.h.

◆ SmoothingScheduleType

template<class TElastix >
using itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >::SmoothingScheduleType = Array2D<ScalarRealType>

SmoothingScheduleType typedef support.

Definition at line 152 of file itkGenericMultiResolutionPyramidImageFilter.h.

◆ Superclass1

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::Superclass1 = itk::GenericMultiResolutionPyramidImageFilter<typename FixedImagePyramidBase<TElastix>::InputImageType, typename FixedImagePyramidBase<TElastix>::OutputImageType>

Definition at line 78 of file elxFixedGenericPyramid.h.

◆ Superclass2

template<class TElastix >
using elastix::FixedGenericPyramid< TElastix >::Superclass2 = FixedImagePyramidBase<TElastix>

Definition at line 81 of file elxFixedGenericPyramid.h.

Constructor & Destructor Documentation

◆ FixedGenericPyramid()

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::FixedGenericPyramid ( )
protecteddefault

The constructor.

◆ ~FixedGenericPyramid()

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::~FixedGenericPyramid ( )
overrideprotecteddefault

The destructor.

Member Function Documentation

◆ BeforeEachResolution()

template<class TElastix >
void elastix::FixedGenericPyramid< TElastix >::BeforeEachResolution ( )
overridevirtual

Update the current resolution level.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::elxClassNameMacro ( "FixedGenericImagePyramid"  )

Name of this class. Use this name in the parameter file to select this specific pyramid.
example: (FixedImagePyramid "FixedGenericImagePyramid")

◆ GetClassName()

template<class TElastix >
virtual const char * elastix::FixedGenericPyramid< TElastix >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from elastix::FixedImagePyramidBase< TElastix >.

Reimplemented in elastix::OpenCLFixedGenericPyramid< TElastix >.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::ITK_DISALLOW_COPY_AND_MOVE ( FixedGenericPyramid< TElastix >  )

◆ itkStaticConstMacro()

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::itkStaticConstMacro ( ImageDimension  ,
unsigned int  ,
Superclass1::ImageDimension   
)

Get the ImageDimension.

◆ New()

template<class TElastix >
static Pointer elastix::FixedGenericPyramid< TElastix >::New ( )
static

Method for creation through the object factory.

◆ SetFixedSchedule()

template<class TElastix >
void elastix::FixedGenericPyramid< TElastix >::SetFixedSchedule ( )
overridevirtual

Method for setting the schedule. Override from FixedImagePyramidBase, since we now have two schedules, rescaling and smoothing.

Reimplemented from elastix::FixedImagePyramidBase< TElastix >.

Field Documentation

◆ elxOverrideGetSelfMacro

template<class TElastix >
elastix::FixedGenericPyramid< TElastix >::elxOverrideGetSelfMacro
private

Definition at line 132 of file elxFixedGenericPyramid.h.



Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo