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 | Private Attributes
elastix::OpenCLFixedGenericPyramid< TElastix > Class Template Reference

#include <elxOpenCLFixedGenericPyramid.h>

Detailed Description

template<class TElastix>
class elastix::OpenCLFixedGenericPyramid< TElastix >

A pyramid based on the itk::GenericMultiResolutionPyramidImageFilter. The parameters used in this class are:

Parameters:

Pyramid: Select this pyramid as follows:
(FixedImagePyramid "OpenCLFixedGenericImagePyramid")

Pyramid: Enable the OpenCL pyramid as follows:
(OpenCLFixedGenericImagePyramidUseOpenCL "true")

Author
Denis P. Shamonin and Marius Staring. Division of Image Processing, Department of Radiology, Leiden, The Netherlands
Note
This work was funded by the Netherlands Organisation for Scientific Research (NWO NRG-2010.02 and NWO 639.021.124).
See also
FixedGenericPyramid

Definition at line 48 of file elxOpenCLFixedGenericPyramid.h.

+ Inheritance diagram for elastix::OpenCLFixedGenericPyramid< TElastix >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef GPUInputImageType::Pointer GPUInputImagePointer
 
typedef itk::GPUImage< InputImagePixelType, InputImageType::ImageDimension > GPUInputImageType
 
typedef itk::GPUImage< OutputImagePixelType, OutputImageType::ImageDimension > GPUOutputImageType
 
typedef GPUPyramidType::Pointer GPUPyramidPointer
 
typedef itk::GenericMultiResolutionPyramidImageFilter< GPUInputImageType, GPUOutputImageType, floatGPUPyramidType
 
typedef Superclass1::InputImageType::PixelType InputImagePixelType
 
typedef Superclass1::InputImageType InputImageType
 
typedef itk::ObjectFactoryBase::Pointer ObjectFactoryBasePointer
 
typedef Superclass1::OutputImageType::PixelType OutputImagePixelType
 
typedef Superclass1::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef OpenCLFixedGenericPyramid Self
 
typedef FixedGenericPyramid< TElastix > Superclass
 
typedef FixedGenericPyramid< TElastix >::Superclass1 Superclass1
 
typedef FixedGenericPyramid< TElastix >::Superclass2 Superclass2
 
- Public Types inherited from elastix::FixedGenericPyramid< TElastix >
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 FixedGenericPyramid Self
 
typedef Superclass1::SmoothingScheduleType SmoothingScheduleType
 
typedef itk::GenericMultiResolutionPyramidImageFilter< typename FixedImagePyramidBase< TElastix >::InputImageType, typename FixedImagePyramidBase< TElastix >::OutputImageTypeSuperclass1
 
typedef FixedImagePyramidBase< TElastix > Superclass2
 
- Public Types inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< 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 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< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageTypeSuperclass
 
typedef Superclass::Superclass SuperSuperclass
 
- Public Types inherited from elastix::FixedImagePyramidBase< TElastix >
typedef Superclass::ConfigurationPointer ConfigurationPointer
 
typedef Superclass::ConfigurationType ConfigurationType
 
typedef Superclass::ElastixPointer ElastixPointer
 
typedef Superclass::ElastixType ElastixType
 
typedef ElastixType::FixedImageType InputImageType
 
typedef itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageTypeITKBaseType
 
typedef ElastixType::FixedImageType OutputImageType
 
typedef Superclass::RegistrationPointer RegistrationPointer
 
typedef Superclass::RegistrationType RegistrationType
 
typedef ITKBaseType::ScheduleType ScheduleType
 
typedef FixedImagePyramidBase Self
 
typedef BaseComponentSE< TElastix > Superclass
 
- Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef Configuration::Pointer ConfigurationPointer
 
typedef Configuration ConfigurationType
 
typedef itk::WeakPointer< ElastixTypeElastixPointer
 
typedef TElastix ElastixType
 
typedef RegistrationTypeRegistrationPointer
 
typedef ElastixType::RegistrationBaseType RegistrationType
 
typedef BaseComponentSE Self
 
typedef BaseComponent Superclass
 

Public Member Functions

virtual void BeforeRegistration (void)
 
 elxClassNameMacro ("OpenCLFixedGenericImagePyramid")
 
virtual const char * GetClassName () const
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
 
virtual void ReadFromFile (void)
 
- Public Member Functions inherited from elastix::FixedGenericPyramid< TElastix >
void BeforeEachResolution (void) override
 
 elxClassNameMacro ("FixedGenericImagePyramid")
 
virtual const char * GetClassName () const
 
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
 
void SetFixedSchedule (void) 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 (void) const
 
virtual const SmoothingScheduleTypeGetSmoothingSchedule ()
 
 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)
 
void SetSchedule (const ScheduleType &schedule) override
 
virtual void SetSmoothingSchedule (const SmoothingScheduleType &schedule)
 
virtual void SetSmoothingScheduleToZero (void)
 
- Public Member Functions inherited from elastix::FixedImagePyramidBase< TElastix >
void BeforeEachResolutionBase (void) override
 
void BeforeRegistrationBase (void) override
 
virtual ITKBaseTypeGetAsITKBaseType (void)
 
virtual const ITKBaseTypeGetAsITKBaseType (void) const
 
virtual const char * GetClassName () const
 
virtual void SetFixedSchedule (void)
 
virtual void WritePyramidImage (const std::string &filename, const unsigned int &level)
 
- Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
ConfigurationTypeGetConfiguration (void) const
 
ElastixTypeGetElastix (void) const
 
RegistrationPointer GetRegistration (void) const
 
 ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponentSE)
 
void SetConfiguration (ConfigurationType *_arg)
 
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 BeforeEachResolution (void)
 
virtual void BeforeEachResolutionBase (void)
 
virtual void BeforeRegistration (void)
 
virtual void BeforeRegistrationBase (void)
 
virtual const char * elxGetClassName (void) const
 
const char * GetComponentLabel (void) const
 
 ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponent)
 
 itkTypeMacroNoParent (BaseComponent)
 
void SetComponentLabel (const char *label, unsigned int idx)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from elastix::FixedGenericPyramid< TElastix >
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
static std::string ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)
 
static void InitializeElastixExecutable ()
 
static bool IsElastixLibrary ()
 

Protected Member Functions

void BeforeGenerateData (void)
 
virtual void GenerateData (void)
 
 OpenCLFixedGenericPyramid ()
 
virtual ~OpenCLFixedGenericPyramid ()
 
- Protected Member Functions inherited from elastix::FixedGenericPyramid< TElastix >
 FixedGenericPyramid ()
 
 ~FixedGenericPyramid () override
 
- Protected Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< FixedImagePyramidBase< TElastix >::InputImageType, FixedImagePyramidBase< TElastix >::OutputImageType >
void GenerateData (void) override
 
void GenerateInputRequestedRegion (void) override
 
void GenerateOutputInformation (void) override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
 GenericMultiResolutionPyramidImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReleaseOutputs (void)
 
 ~GenericMultiResolutionPyramidImageFilter () override
 
- Protected Member Functions inherited from elastix::FixedImagePyramidBase< TElastix >
 FixedImagePyramidBase ()
 
 ~FixedImagePyramidBase () override
 
- 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 Member Functions

 OpenCLFixedGenericPyramid (const Self &)
 
void operator= (const Self &)
 
void RegisterFactories (void)
 
void ReportToLog (void)
 
void SwitchingToCPUAndReport (const bool configError)
 
void UnregisterFactories (void)
 

Private Attributes

bool m_ContextCreated
 
std::vector< ObjectFactoryBasePointerm_Factories
 
GPUPyramidPointer m_GPUPyramid
 
bool m_GPUPyramidCreated
 
bool m_GPUPyramidReady
 
bool m_UseOpenCL
 

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 {}
 
ElastixPointer m_Elastix {}
 
RegistrationPointer m_Registration {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file elxOpenCLFixedGenericPyramid.h.

◆ GPUInputImagePointer

template<class TElastix >
typedef GPUInputImageType::Pointer elastix::OpenCLFixedGenericPyramid< TElastix >::GPUInputImagePointer

Definition at line 88 of file elxOpenCLFixedGenericPyramid.h.

◆ GPUInputImageType

template<class TElastix >
typedef itk::GPUImage< InputImagePixelType, InputImageType::ImageDimension > elastix::OpenCLFixedGenericPyramid< TElastix >::GPUInputImageType

GPU Typedefs for GPU image and GPU filter.

Definition at line 87 of file elxOpenCLFixedGenericPyramid.h.

◆ GPUOutputImageType

template<class TElastix >
typedef itk::GPUImage< OutputImagePixelType, OutputImageType::ImageDimension > elastix::OpenCLFixedGenericPyramid< TElastix >::GPUOutputImageType

Definition at line 90 of file elxOpenCLFixedGenericPyramid.h.

◆ GPUPyramidPointer

template<class TElastix >
typedef GPUPyramidType::Pointer elastix::OpenCLFixedGenericPyramid< TElastix >::GPUPyramidPointer

Definition at line 95 of file elxOpenCLFixedGenericPyramid.h.

◆ GPUPyramidType

Definition at line 94 of file elxOpenCLFixedGenericPyramid.h.

◆ InputImagePixelType

template<class TElastix >
typedef Superclass1::InputImageType::PixelType elastix::OpenCLFixedGenericPyramid< TElastix >::InputImagePixelType

Definition at line 79 of file elxOpenCLFixedGenericPyramid.h.

◆ InputImageType

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

Typedefs inherited from the superclass.

Definition at line 77 of file elxOpenCLFixedGenericPyramid.h.

◆ ObjectFactoryBasePointer

template<class TElastix >
typedef itk::ObjectFactoryBase::Pointer elastix::OpenCLFixedGenericPyramid< TElastix >::ObjectFactoryBasePointer

Typedefs for factory.

Definition at line 83 of file elxOpenCLFixedGenericPyramid.h.

◆ OutputImagePixelType

template<class TElastix >
typedef Superclass1::OutputImageType::PixelType elastix::OpenCLFixedGenericPyramid< TElastix >::OutputImagePixelType

Definition at line 80 of file elxOpenCLFixedGenericPyramid.h.

◆ OutputImageType

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

Definition at line 78 of file elxOpenCLFixedGenericPyramid.h.

◆ Pointer

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

Definition at line 58 of file elxOpenCLFixedGenericPyramid.h.

◆ Self

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

Standard ITK-stuff.

Definition at line 54 of file elxOpenCLFixedGenericPyramid.h.

◆ Superclass

template<class TElastix >
typedef FixedGenericPyramid< TElastix > elastix::OpenCLFixedGenericPyramid< TElastix >::Superclass

Definition at line 55 of file elxOpenCLFixedGenericPyramid.h.

◆ Superclass1

template<class TElastix >
typedef FixedGenericPyramid<TElastix>::Superclass1 elastix::OpenCLFixedGenericPyramid< TElastix >::Superclass1

Definition at line 56 of file elxOpenCLFixedGenericPyramid.h.

◆ Superclass2

template<class TElastix >
typedef FixedGenericPyramid<TElastix>::Superclass2 elastix::OpenCLFixedGenericPyramid< TElastix >::Superclass2

Definition at line 57 of file elxOpenCLFixedGenericPyramid.h.

Constructor & Destructor Documentation

◆ OpenCLFixedGenericPyramid() [1/2]

template<class TElastix >
elastix::OpenCLFixedGenericPyramid< TElastix >::OpenCLFixedGenericPyramid ( )
protected

The constructor.

◆ ~OpenCLFixedGenericPyramid()

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

The destructor.

Definition at line 114 of file elxOpenCLFixedGenericPyramid.h.

◆ OpenCLFixedGenericPyramid() [2/2]

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

The private constructor.

Member Function Documentation

◆ BeforeGenerateData()

template<class TElastix >
void elastix::OpenCLFixedGenericPyramid< TElastix >::BeforeGenerateData ( void  )
protected

This method performs all configuration for GPU pyramid.

◆ BeforeRegistration()

template<class TElastix >
virtual void elastix::OpenCLFixedGenericPyramid< TElastix >::BeforeRegistration ( void  )
virtual

Do some things before registration.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >
elastix::OpenCLFixedGenericPyramid< TElastix >::elxClassNameMacro ( "OpenCLFixedGenericImagePyramid"  )

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

◆ GenerateData()

template<class TElastix >
virtual void elastix::OpenCLFixedGenericPyramid< TElastix >::GenerateData ( void  )
protectedvirtual

Executes GPU pyramid.

◆ GetClassName()

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

Run-time type information (and related methods).

Reimplemented from elastix::FixedGenericPyramid< TElastix >.

◆ itkStaticConstMacro()

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

Get the ImageDimension.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

The private copy constructor.

◆ ReadFromFile()

template<class TElastix >
virtual void elastix::OpenCLFixedGenericPyramid< TElastix >::ReadFromFile ( void  )
virtual

Function to read parameters from a file.

◆ RegisterFactories()

template<class TElastix >
void elastix::OpenCLFixedGenericPyramid< TElastix >::RegisterFactories ( void  )
private

Register/Unregister factories.

◆ ReportToLog()

template<class TElastix >
void elastix::OpenCLFixedGenericPyramid< TElastix >::ReportToLog ( void  )
private

Helper method to report to elastix log.

◆ SwitchingToCPUAndReport()

template<class TElastix >
void elastix::OpenCLFixedGenericPyramid< TElastix >::SwitchingToCPUAndReport ( const bool  configError)
private

Helper method to report switching to CPU mode.

◆ UnregisterFactories()

template<class TElastix >
void elastix::OpenCLFixedGenericPyramid< TElastix >::UnregisterFactories ( void  )
private

Field Documentation

◆ m_ContextCreated

template<class TElastix >
bool elastix::OpenCLFixedGenericPyramid< TElastix >::m_ContextCreated
private

Definition at line 137 of file elxOpenCLFixedGenericPyramid.h.

◆ m_Factories

template<class TElastix >
std::vector< ObjectFactoryBasePointer > elastix::OpenCLFixedGenericPyramid< TElastix >::m_Factories
private

Definition at line 139 of file elxOpenCLFixedGenericPyramid.h.

◆ m_GPUPyramid

template<class TElastix >
GPUPyramidPointer elastix::OpenCLFixedGenericPyramid< TElastix >::m_GPUPyramid
private

Definition at line 134 of file elxOpenCLFixedGenericPyramid.h.

◆ m_GPUPyramidCreated

template<class TElastix >
bool elastix::OpenCLFixedGenericPyramid< TElastix >::m_GPUPyramidCreated
private

Definition at line 136 of file elxOpenCLFixedGenericPyramid.h.

◆ m_GPUPyramidReady

template<class TElastix >
bool elastix::OpenCLFixedGenericPyramid< TElastix >::m_GPUPyramidReady
private

Definition at line 135 of file elxOpenCLFixedGenericPyramid.h.

◆ m_UseOpenCL

template<class TElastix >
bool elastix::OpenCLFixedGenericPyramid< TElastix >::m_UseOpenCL
private

Definition at line 138 of file elxOpenCLFixedGenericPyramid.h.



Generated on 1667476801 for elastix by doxygen 1.9.4 elastix logo