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 Member Functions
elastix::MovingGenericPyramid< TElastix > Class Template Reference

#include <elxMovingGenericPyramid.h>

Detailed Description

template<class TElastix>
class elastix::MovingGenericPyramid< TElastix >

A pyramid based on the itk::GenericMultiResolutionPyramidImageFilter.

It is generic since it has all functionality that the MovingRecursivePyramid, MovingShrinkingPyramid and MovingSmoothingPyramid 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:

MovingImagePyramid: Select this pyramid as follows:
(MovingImagePyramid "MovingGenericImagePyramid")

MovingImagePyramidRescaleSchedule: downsampling factors for the moving image pyramid.
For each dimension, for each resolution level, the downsampling factor of the moving image can be specified.
Syntax for 2D images:
(MovingImagePyramidRescaleSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (MovingImagePyramidRescaleSchedule 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 moving and moving image pyramid.

ImagePyramidRescaleSchedule: rescale schedule for both pyramids

ImagePyramidSchedule: same as ImagePyramidRescaleSchedule

MovingImagePyramidSchedule: same as MovingImagePyramidRescaleSchedule

MovingImagePyramidSmoothingSchedule: sigma's for smoothing the moving image pyramid.
For each dimension, for each resolution level, the sigma of the moving image can be specified.
Syntax for 2D images:
(MovingImagePyramidSmoothingSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (MovingImagePyramidSmoothingSchedule 4 4 2 2 1 1)
Default: 0.5 x rescale_factor x moving_image_spacing.
If ImagePyramidSmoothingSchedule is specified, that schedule is used for both moving 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. Shrinker is faster.
example: (ImagePyramidUseShrinkImageFilter "true")
Default false, so by default the resampler is used.

Definition at line 73 of file elxMovingGenericPyramid.h.

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

Public Types

typedef Superclass2::ConfigurationPointer ConfigurationPointer
 
typedef Superclass2::ConfigurationType ConfigurationType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass2::ElastixPointer ElastixPointer
 
typedef Superclass2::ElastixType ElastixType
 
typedef Superclass1::InputImageConstPointer InputImageConstPointer
 
typedef Superclass1::InputImagePointer InputImagePointer
 
typedef Superclass1::InputImageType InputImageType
 
typedef Superclass2::ITKBaseType ITKBaseType
 
typedef Superclass1::OutputImagePointer OutputImagePointer
 
typedef Superclass1::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass2::RegistrationPointer RegistrationPointer
 
typedef Superclass2::RegistrationType RegistrationType
 
typedef Superclass1::RescaleScheduleType RescaleScheduleType
 
typedef Superclass1::ScheduleType ScheduleType
 
typedef MovingGenericPyramid Self
 
typedef Superclass1::SmoothingScheduleType SmoothingScheduleType
 
typedef itk::GenericMultiResolutionPyramidImageFilter< typename MovingImagePyramidBase< TElastix >::InputImageType, typename MovingImagePyramidBase< TElastix >::OutputImageTypeSuperclass1
 
typedef MovingImagePyramidBase< TElastix > Superclass2
 
- Public Types inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputImageConstPointer InputImageConstPointer
 
typedef Superclass::InputImagePointer InputImagePointer
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::OutputImagePointer OutputImagePointer
 
typedef Superclass::OutputImageType OutputImageType
 
typedef InputImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef SigmaArrayType RescaleFactorArrayType
 
typedef ScheduleType RescaleScheduleType
 
typedef NumericTraits< PixelType >::ScalarRealType ScalarRealType
 
typedef Superclass::ScheduleType ScheduleType
 
typedef GenericMultiResolutionPyramidImageFilter Self
 
typedef FixedArray< ScalarRealType, itkGetStaticConstMacro(ImageDimension) > SigmaArrayType
 
typedef Array2D< ScalarRealTypeSmoothingScheduleType
 
typedef Superclass::InputImageType::SpacingType SpacingType
 
typedef MultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageTypeSuperclass
 
typedef Superclass::Superclass SuperSuperclass
 
- Public Types inherited from elastix::MovingImagePyramidBase< TElastix >
typedef Superclass::ConfigurationPointer ConfigurationPointer
 
typedef Superclass::ConfigurationType ConfigurationType
 
typedef Superclass::ElastixPointer ElastixPointer
 
typedef Superclass::ElastixType ElastixType
 
typedef ElastixType::MovingImageType InputImageType
 
typedef itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageTypeITKBaseType
 
typedef ElastixType::MovingImageType OutputImageType
 
typedef Superclass::RegistrationPointer RegistrationPointer
 
typedef Superclass::RegistrationType RegistrationType
 
typedef ITKBaseType::ScheduleType ScheduleType
 
typedef MovingImagePyramidBase Self
 
typedef BaseComponentSE< TElastix > Superclass
 
- Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef ElastixType::ConfigurationPointer ConfigurationPointer
 
typedef ElastixType::ConfigurationType ConfigurationType
 
typedef ElastixType::Pointer ElastixPointer
 
typedef TElastix ElastixType
 
typedef RegistrationTypeRegistrationPointer
 
typedef ElastixType::RegistrationBaseType RegistrationType
 
typedef BaseComponentSE Self
 
typedef BaseComponent Superclass
 

Public Member Functions

virtual void BeforeEachResolution (void)
 
 elxClassNameMacro ("MovingGenericImagePyramid")
 
virtual const char * GetClassName () const
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
 
virtual void SetMovingSchedule (void)
 
- Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
virtual void ComputeOnlyForCurrentLevelOff ()
 
virtual void ComputeOnlyForCurrentLevelOn ()
 
virtual bool GetComputeOnlyForCurrentLevel () const
 
virtual const unsigned intGetCurrentLevel ()
 
const RescaleScheduleTypeGetRescaleSchedule (void) const
 
virtual const SmoothingScheduleTypeGetSmoothingSchedule ()
 
 itkStaticConstMacro (ImageDimension, unsigned int, MovingImagePyramidBase< TElastix >::InputImageType::ImageDimension)
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, MovingImagePyramidBase< TElastix >::OutputImageType::ImageDimension)
 
virtual void SetComputeOnlyForCurrentLevel (const bool _arg)
 
virtual void SetCurrentLevel (unsigned int level)
 
virtual void SetNumberOfLevels (unsigned int num)
 
virtual void SetRescaleSchedule (const RescaleScheduleType &schedule)
 
virtual void SetRescaleScheduleToUnity (void)
 
virtual void SetSchedule (const ScheduleType &schedule)
 
virtual void SetSmoothingSchedule (const SmoothingScheduleType &schedule)
 
virtual void SetSmoothingScheduleToZero (void)
 
- Public Member Functions inherited from elastix::MovingImagePyramidBase< TElastix >
virtual void BeforeEachResolutionBase (void)
 
virtual void BeforeRegistrationBase (void)
 
virtual ITKBaseTypeGetAsITKBaseType (void)
 
virtual const ITKBaseTypeGetAsITKBaseType (void) const
 
virtual void WritePyramidImage (const std::string &filename, const unsigned int &level)
 
- Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
virtual ConfigurationTypeGetConfiguration (void) const
 
virtual ElastixTypeGetElastix (void) const
 
virtual RegistrationPointer GetRegistration (void) const
 
virtual void SetConfiguration (ConfigurationType *_arg)
 
virtual void SetElastix (ElastixType *_arg)
 
- Public Member Functions inherited from elastix::BaseComponent
virtual void AfterEachIteration (void)
 
virtual void AfterEachIterationBase (void)
 
virtual void AfterEachResolution (void)
 
virtual void AfterEachResolutionBase (void)
 
virtual void AfterRegistration (void)
 
virtual void AfterRegistrationBase (void)
 
virtual int BeforeAll (void)
 
virtual int BeforeAllBase (void)
 
virtual void BeforeRegistration (void)
 
std::string ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision) const
 
virtual const char * elxGetClassName (void) const
 
virtual const char * GetComponentLabel (void) const
 
virtual void SetComponentLabel (const char *label, unsigned int idx)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

 MovingGenericPyramid (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Attributes inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< 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
 
ElastixPointer m_Elastix
 
RegistrationPointer m_Registration
 

Member Typedef Documentation

Definition at line 119 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass2::ConfigurationType elastix::MovingGenericPyramid< TElastix >::ConfigurationType

Definition at line 118 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef itk::SmartPointer< const Self > elastix::MovingGenericPyramid< TElastix >::ConstPointer

Definition at line 88 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass2::ElastixPointer elastix::MovingGenericPyramid< TElastix >::ElastixPointer

Definition at line 117 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass2::ElastixType elastix::MovingGenericPyramid< TElastix >::ElastixType

Typedefs inherited from Elastix.

Definition at line 116 of file elxMovingGenericPyramid.h.

Definition at line 110 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass1::InputImagePointer elastix::MovingGenericPyramid< TElastix >::InputImagePointer

Definition at line 108 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass1::InputImageType elastix::MovingGenericPyramid< TElastix >::InputImageType

Typedefs inherited from the superclass.

Definition at line 106 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass2::ITKBaseType elastix::MovingGenericPyramid< TElastix >::ITKBaseType

Definition at line 122 of file elxMovingGenericPyramid.h.

Definition at line 109 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass1::OutputImageType elastix::MovingGenericPyramid< TElastix >::OutputImageType

Definition at line 107 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef itk::SmartPointer< Self > elastix::MovingGenericPyramid< TElastix >::Pointer

Definition at line 87 of file elxMovingGenericPyramid.h.

Definition at line 121 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass2::RegistrationType elastix::MovingGenericPyramid< TElastix >::RegistrationType

Definition at line 120 of file elxMovingGenericPyramid.h.

Definition at line 112 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef Superclass1::ScheduleType elastix::MovingGenericPyramid< TElastix >::ScheduleType

Definition at line 111 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef MovingGenericPyramid elastix::MovingGenericPyramid< TElastix >::Self

Standard ITK-stuff.

Definition at line 82 of file elxMovingGenericPyramid.h.

Definition at line 113 of file elxMovingGenericPyramid.h.

Definition at line 85 of file elxMovingGenericPyramid.h.

template<class TElastix >
typedef MovingImagePyramidBase< TElastix > elastix::MovingGenericPyramid< TElastix >::Superclass2

Definition at line 86 of file elxMovingGenericPyramid.h.

Constructor & Destructor Documentation

template<class TElastix >
elastix::MovingGenericPyramid< TElastix >::MovingGenericPyramid ( )
inlineprotected

The constructor.

Definition at line 135 of file elxMovingGenericPyramid.h.

template<class TElastix >
virtual elastix::MovingGenericPyramid< TElastix >::~MovingGenericPyramid ( )
inlineprotectedvirtual

The destructor.

Definition at line 137 of file elxMovingGenericPyramid.h.

template<class TElastix >
elastix::MovingGenericPyramid< TElastix >::MovingGenericPyramid ( const Self )
private

The private constructor.

Member Function Documentation

template<class TElastix >
virtual void elastix::MovingGenericPyramid< TElastix >::BeforeEachResolution ( void  )
virtual

Update the current resolution level.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::MovingGenericPyramid< TElastix >::elxClassNameMacro ( "MovingGenericImagePyramid"  )

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

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

Run-time type information (and related methods).

Reimplemented from elastix::MovingImagePyramidBase< TElastix >.

Reimplemented in elastix::OpenCLMovingGenericPyramid< TElastix >.

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

Get the ImageDimension.

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

Method for creation through the object factory.

template<class TElastix >
void elastix::MovingGenericPyramid< TElastix >::operator= ( const Self )
private

The private copy constructor.

template<class TElastix >
virtual void elastix::MovingGenericPyramid< TElastix >::SetMovingSchedule ( void  )
virtual

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

Reimplemented from elastix::MovingImagePyramidBase< TElastix >.



Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo