ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension > Class Template Reference

#include <itkImageVectorOptimizerParametersHelper.h>

+ Inheritance diagram for itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >:
+ Collaboration diagram for itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >:

Public Types

using CommonContainerType = typename Superclass::CommonContainerType
 
using ParameterImagePointer = typename ParameterImageType::Pointer
 
using ParameterImageType = Image< Vector< TValue, NVectorDimension >, 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 ()
 
void MoveDataPointer (CommonContainerType *container, TValue *pointer) override
 
void SetParametersObject (CommonContainerType *container, LightObject *) override
 
 ~ImageVectorOptimizerParametersHelper () override=default
 
- Public Member Functions inherited from itk::OptimizerParametersHelper< TValue >
virtual void MoveDataPointer (CommonContainerType *container, TValue *pointer)
 
 OptimizerParametersHelper ()=default
 
virtual void SetParametersObject (CommonContainerType *, LightObject *)
 
virtual ~OptimizerParametersHelper ()=default
 

Private Attributes

ParameterImagePointer m_ParameterImage
 

Detailed Description

template<typename TValue, unsigned int NVectorDimension, unsigned int VImageDimension>
class itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, 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.

Member Typedef Documentation

◆ CommonContainerType

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::CommonContainerType = typename Superclass::CommonContainerType

Type of the common data object used in OptimizerParameters

Definition at line 50 of file itkImageVectorOptimizerParametersHelper.h.

◆ ParameterImagePointer

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::ParameterImagePointer = typename ParameterImageType::Pointer

Definition at line 47 of file itkImageVectorOptimizerParametersHelper.h.

◆ ParameterImageType

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::ParameterImageType = Image<Vector<TValue, NVectorDimension>, VImageDimension>

Image type that this class expects.

Definition at line 46 of file itkImageVectorOptimizerParametersHelper.h.

◆ Self

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::Self = ImageVectorOptimizerParametersHelper

Definition at line 42 of file itkImageVectorOptimizerParametersHelper.h.

◆ Superclass

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::Superclass = OptimizerParametersHelper<TValue>

Definition at line 43 of file itkImageVectorOptimizerParametersHelper.h.

◆ ValueType

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
using itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, 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 NVectorDimension, unsigned int VImageDimension>
itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::ImageVectorOptimizerParametersHelper ( )

Default constructor.

◆ ~ImageVectorOptimizerParametersHelper()

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::~ImageVectorOptimizerParametersHelper ( )
overridedefault

Member Function Documentation

◆ MoveDataPointer()

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
void itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::MoveDataPointer ( CommonContainerType container,
TValue *  pointer 
)
override

Set a new data pointer for both the Array and parameter image, pointing both to a different memory block. The size of the new memroy 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.

◆ SetParametersObject()

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
void itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, VImageDimension >::SetParametersObject ( CommonContainerType container,
LightObject  
)
override

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.

Member Data Documentation

◆ m_ParameterImage

template<typename TValue , unsigned int NVectorDimension, unsigned int VImageDimension>
ParameterImagePointer itk::ImageVectorOptimizerParametersHelper< TValue, NVectorDimension, 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: