itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension > Class Template Reference

#include <itkImageVectorOptimizerParametersHelper.h>

Detailed Description

template<typename TValue, unsigned int VVectorDimension, unsigned int VImageDimension>
class itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >

Class to hold and manage parameters of type Image<Vector<...>,...>, used in Transforms, etc.

See also

OptimizerParametersHelper

Definition at line 37 of file itkImageVectorOptimizerParametersHelper.h.

Inheritance diagram for itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >:

Collaboration diagram for itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >:

Public Types
using	CommonContainerType = Array< TValue >
using	ParameterImagePointer = typename ParameterImageType::Pointer
using	ParameterImageType = Image< Vector< TValue, VVectorDimension >, VImageDimension >
using	Self = ImageVectorOptimizerParametersHelper
using	Superclass = OptimizerParametersHelper< TValue >
using	ValueType = TValue
Public Types inherited from itk::OptimizerParametersHelper< TValue >
using	CommonContainerType = Array< TValue >
using	Self = OptimizerParametersHelper
using	ValueType = TValue

Public Member Functions
	ImageVectorOptimizerParametersHelper ()=default
void	MoveDataPointer (CommonContainerType *container, TValue *pointer) override
void	SetParametersObject (CommonContainerType *container, LightObject *) override
	~ImageVectorOptimizerParametersHelper () override=default
Public Member Functions inherited from itk::OptimizerParametersHelper< TValue >
	OptimizerParametersHelper ()=default
virtual	~OptimizerParametersHelper ()=default

Private Attributes
ParameterImagePointer	m_ParameterImage {}

Member Typedef Documentation

CommonContainerType

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::OptimizerParametersHelper< TValue >::CommonContainerType = Array<TValue>

Type of common data object used by OptimizerParameters.

Definition at line 42 of file itkOptimizerParametersHelper.h.

ParameterImagePointer

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::ParameterImagePointer = typename ParameterImageType::Pointer

Definition at line 47 of file itkImageVectorOptimizerParametersHelper.h.

ParameterImageType

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::ParameterImageType = Image<Vector<TValue, VVectorDimension>, VImageDimension>

Image type that this class expects.

Definition at line 46 of file itkImageVectorOptimizerParametersHelper.h.

Self

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::Self = ImageVectorOptimizerParametersHelper

Definition at line 42 of file itkImageVectorOptimizerParametersHelper.h.

Superclass

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::Superclass = OptimizerParametersHelper<TValue>

Definition at line 43 of file itkImageVectorOptimizerParametersHelper.h.

ValueType

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

using itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::ValueType = TValue

The element type stored at each location in the Array.

Definition at line 41 of file itkImageVectorOptimizerParametersHelper.h.

Constructor & Destructor Documentation

ImageVectorOptimizerParametersHelper()

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::ImageVectorOptimizerParametersHelper ( )

default

Default constructor.

~ImageVectorOptimizerParametersHelper()

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::~ImageVectorOptimizerParametersHelper ( )

overridedefault

Member Function Documentation

MoveDataPointer()

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

void itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::MoveDataPointer ( CommonContainerType *  container, TValue *  pointer  )

overridevirtual

Set a new data pointer for both the Array and parameter image, pointing both to a different memory block. The size of the new memory block must be the same as current size of Array and the parameter image's buffer, in elements of TValue. Memory must be managed by caller afterwards.

Reimplemented from itk::OptimizerParametersHelper< TValue >.

SetParametersObject()

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

void itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::SetParametersObject ( CommonContainerType *  container, LightObject *    )

overridevirtual

Set an image that holds the parameter data. container is a pointer of type itkArray to the object to which this helper is assigned. container will be pointed to the image data buffer, and set not to manage memory, so the image still manages its memory. A dynamic cast is performed on object to make sure its of proper type. Generally this will be called from OptimizerParameters::SetParameterObject.

Reimplemented from itk::OptimizerParametersHelper< TValue >.

Member Data Documentation

m_ParameterImage

template<typename TValue , unsigned int VVectorDimension, unsigned int VImageDimension>

ParameterImagePointer itk::ImageVectorOptimizerParametersHelper< TValue, VVectorDimension, VImageDimension >::m_ParameterImage {}

private

The parameter image used by the class

Definition at line 77 of file itkImageVectorOptimizerParametersHelper.h.

---

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

• itkImageVectorOptimizerParametersHelper.h