itk::OptimizerParametersHelper< TValue > Class Template Reference

#include <itkOptimizerParametersHelper.h>

Inheritance diagram for itk::OptimizerParametersHelper< TValue >:

Public Types
using	CommonContainerType = Array< TValue >
using	Self = OptimizerParametersHelper
using	ValueType = TValue

Public Member Functions
virtual void	MoveDataPointer (CommonContainerType *container, TValue *pointer)
	OptimizerParametersHelper ()=default
virtual void	SetParametersObject (CommonContainerType *, LightObject *)
virtual	~OptimizerParametersHelper ()=default

Detailed Description

template<typename TValue>
class itk::OptimizerParametersHelper< TValue >

Basic helper class to manage parameter data as an Array type, the default type.

Definition at line 34 of file itkOptimizerParametersHelper.h.

Member Typedef Documentation

CommonContainerType

template<typename TValue >

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

Type of common data object used by OptimizerParameters.

Definition at line 42 of file itkOptimizerParametersHelper.h.

Self

template<typename TValue >

using itk::OptimizerParametersHelper< TValue >::Self = OptimizerParametersHelper

Definition at line 39 of file itkOptimizerParametersHelper.h.

ValueType

template<typename TValue >

using itk::OptimizerParametersHelper< TValue >::ValueType = TValue

The element type stored at each location in the Array.

Definition at line 38 of file itkOptimizerParametersHelper.h.

Constructor & Destructor Documentation

OptimizerParametersHelper()

template<typename TValue >

itk::OptimizerParametersHelper< TValue >::OptimizerParametersHelper ( )

default

Default constructor. Nothing to do.

~OptimizerParametersHelper()

template<typename TValue >

virtual itk::OptimizerParametersHelper< TValue >::~OptimizerParametersHelper ( )

virtualdefault

Member Function Documentation

MoveDataPointer()

template<typename TValue >

virtual void itk::OptimizerParametersHelper< TValue >::MoveDataPointer ( CommonContainerType *  container, TValue *  pointer  )

inlinevirtual

Set a new data pointer for the parameter data, pointing it to a different memory block. The size of the new memory block must equal the current size, in elements of TValue. This call is passed to the assigned OptimizerParametersHelper.

Warning

Memory must be managed by caller after this call. container is the OptimizerParameters object to which this helper is assigned. Generally this will be called from the OptimizerParameters object to which this helper is assigned.

Definition at line 58 of file itkOptimizerParametersHelper.h.

References itk::Array< TValue >::GetSize(), and itk::Array< TValue >::SetData().

SetParametersObject()

template<typename TValue >

virtual void itk::OptimizerParametersHelper< TValue >::SetParametersObject ( CommonContainerType *  , LightObject *    )

inlinevirtual

Set an object that holds the parameters. Used by derived classes that use an object other than itkArray to hold parameter data. The derived class must check that the object is the correct type. Generally this will be called from the OptimizerParameters object to which this helper is assigned. container is the OptimizerParameters object to which this helper is assigned.

Definition at line 72 of file itkOptimizerParametersHelper.h.

---

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

• itkOptimizerParametersHelper.h