ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::OptimizerParameters< TParametersValueType > Class Template Reference

#include <itkOptimizerParameters.h>

+ Inheritance diagram for itk::OptimizerParameters< TParametersValueType >:
+ Collaboration diagram for itk::OptimizerParameters< TParametersValueType >:

Public Types

using ArrayType = Superclass
 
using OptimizerParametersHelperType = OptimizerParametersHelper< TParametersValueType >
 
using Self = OptimizerParameters
 
using SizeValueType = typename Superclass::SizeValueType
 
using Superclass = Array< TParametersValueType >
 
using ValueType = TParametersValueType
 
using VnlVectorType = typename Superclass::VnlVectorType
 
- Public Types inherited from itk::Array< TParametersValueType >
using Self = Array
 
using SizeValueType = typename vnl_vector< TParametersValueType >::size_type
 
using ValueType = TParametersValueType
 
using VnlVectorType = vnl_vector< TParametersValueType >
 

Public Member Functions

void Initialize ()
 
 OptimizerParameters ()=default
 
 OptimizerParameters (const ArrayType &array)
 
 OptimizerParameters (const OptimizerParameters &rhs)
 
 OptimizerParameters (SizeValueType dimension)
 
- Public Member Functions inherited from itk::Array< TParametersValueType >
 Array ()
 
 Array (const Array &)
 
 Array (const ValueType *datain, SizeValueType sz)
 
 Array (const VnlVectorType &)
 
 Array (SizeValueType dimension)
 
 Array (ValueType *datain, SizeValueType sz, bool LetArrayManageMemory=false)
 
 Array (const Array< TArrayValue > &r)
 
void Fill (TParametersValueType const &v)
 
const Selfoperator= (const Self &rhs)
 
const Selfoperator= (const VnlVectorType &rhs)
 
SizeValueType Size () const
 
unsigned int GetNumberOfElements () const
 
const TParametersValueType & GetElement (SizeValueType i) const
 
void SetElement (SizeValueType i, const TParametersValueType &value)
 
void SetSize (SizeValueType sz)
 
SizeValueType GetSize () const
 
void SetDataSameSize (TParametersValueType *datain, bool LetArrayManageMemory=false)
 
void SetData (TParametersValueType *datain, SizeValueType sz, bool LetArrayManageMemory=false)
 
 ~Array () override
 
void Swap (Array &other)
 
std::unique_ptr< OptimizerParametersHelperTypem_Helper
 
virtual void MoveDataPointer (TParametersValueType *pointer)
 
virtual void SetParametersObject (LightObject *object)
 
virtual void SetHelper (OptimizerParametersHelperType *helper)
 
OptimizerParametersHelperTypeGetHelper ()
 
const Selfoperator= (const Self &rhs)
 
const Selfoperator= (const ArrayType &rhs)
 
const Selfoperator= (const VnlVectorType &rhs)
 
 ~OptimizerParameters () override=default
 

Detailed Description

template<typename TParametersValueType>
class itk::OptimizerParameters< TParametersValueType >

Class to hold and manage different parameter types used during optimization.

Definition at line 36 of file itkOptimizerParameters.h.

Member Typedef Documentation

◆ ArrayType

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::ArrayType = Superclass

Definition at line 43 of file itkOptimizerParameters.h.

◆ OptimizerParametersHelperType

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::OptimizerParametersHelperType = OptimizerParametersHelper<TParametersValueType>

Helper class for managing different types of parameter data.

Definition at line 49 of file itkOptimizerParameters.h.

◆ Self

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::Self = OptimizerParameters

Definition at line 41 of file itkOptimizerParameters.h.

◆ SizeValueType

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::SizeValueType = typename Superclass::SizeValueType

Definition at line 45 of file itkOptimizerParameters.h.

◆ Superclass

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::Superclass = Array<TParametersValueType>

Definition at line 42 of file itkOptimizerParameters.h.

◆ ValueType

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::ValueType = TParametersValueType

The element type stored at each location in the Array.

Definition at line 40 of file itkOptimizerParameters.h.

◆ VnlVectorType

template<typename TParametersValueType>
using itk::OptimizerParameters< TParametersValueType >::VnlVectorType = typename Superclass::VnlVectorType

Definition at line 44 of file itkOptimizerParameters.h.

Constructor & Destructor Documentation

◆ OptimizerParameters() [1/4]

template<typename TParametersValueType>
itk::OptimizerParameters< TParametersValueType >::OptimizerParameters ( )
default

Default constructor. It is created with an empty array it has to be allocated later by assignment

◆ OptimizerParameters() [2/4]

template<typename TParametersValueType>
itk::OptimizerParameters< TParametersValueType >::OptimizerParameters ( const OptimizerParameters< TParametersValueType > &  rhs)
inline

Copy constructor. Uses VNL copy constructor with correct setting for memory management. The vnl vector copy constructor creates new memory no matter the setting of let array manage memory of rhs.

Definition at line 60 of file itkOptimizerParameters.h.

◆ OptimizerParameters() [3/4]

template<typename TParametersValueType>
itk::OptimizerParameters< TParametersValueType >::OptimizerParameters ( SizeValueType  dimension)
inlineexplicit

Constructor with size. Size can only be changed by assignment

Definition at line 71 of file itkOptimizerParameters.h.

◆ OptimizerParameters() [4/4]

template<typename TParametersValueType>
itk::OptimizerParameters< TParametersValueType >::OptimizerParameters ( const ArrayType array)
inline

Constructor with Array assignment

Definition at line 76 of file itkOptimizerParameters.h.

◆ ~OptimizerParameters()

template<typename TParametersValueType>
itk::OptimizerParameters< TParametersValueType >::~OptimizerParameters ( )
overridedefault

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 TParametersValueType. This call is passed to the assigned OptimizerParametersHelper.

Warning
Memory must be managed by caller after this call.

Member Function Documentation

◆ GetHelper()

template<typename TParametersValueType>
OptimizerParametersHelperType* itk::OptimizerParameters< TParametersValueType >::GetHelper ( )
inline

Get the helper in use.

Definition at line 135 of file itkOptimizerParameters.h.

◆ Initialize()

template<typename TParametersValueType>
void itk::OptimizerParameters< TParametersValueType >::Initialize ( )
inline

Initialize. Initialization called by constructors.

Definition at line 82 of file itkOptimizerParameters.h.

◆ MoveDataPointer()

template<typename TParametersValueType>
virtual void itk::OptimizerParameters< TParametersValueType >::MoveDataPointer ( TParametersValueType *  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 TParametersValueType. This call is passed to the assigned OptimizerParametersHelper.

Warning
Memory must be managed by caller after this call.

Definition at line 95 of file itkOptimizerParameters.h.

◆ operator=() [1/3]

template<typename TParametersValueType>
const Self& itk::OptimizerParameters< TParametersValueType >::operator= ( const ArrayType rhs)
inline

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 TParametersValueType. This call is passed to the assigned OptimizerParametersHelper.

Warning
Memory must be managed by caller after this call.

Definition at line 156 of file itkOptimizerParameters.h.

◆ operator=() [2/3]

template<typename TParametersValueType>
const Self& itk::OptimizerParameters< TParametersValueType >::operator= ( const Self rhs)
inline

Copy operators

TODO Determine behavior when copying from obj pointing to image parameters.
 By default should copy image param data into Array portion of new object,
 i.e. into data_block. Is that what we want? 

Definition at line 146 of file itkOptimizerParameters.h.

◆ operator=() [3/3]

template<typename TParametersValueType>
const Self& itk::OptimizerParameters< TParametersValueType >::operator= ( const VnlVectorType rhs)
inline

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 TParametersValueType. This call is passed to the assigned OptimizerParametersHelper.

Warning
Memory must be managed by caller after this call.

Definition at line 164 of file itkOptimizerParameters.h.

◆ SetHelper()

template<typename TParametersValueType>
virtual void itk::OptimizerParameters< TParametersValueType >::SetHelper ( OptimizerParametersHelperType helper)
inlinevirtual

Assign a helper. OptimizerParameters manages the helper once its been assigned. The generic helper, OptimizerParametersHelper, is set in constructor. Classes that need a specialized helper should allocate one themselves and assign it with this method.

Definition at line 128 of file itkOptimizerParameters.h.

◆ SetParametersObject()

template<typename TParametersValueType>
virtual void itk::OptimizerParameters< TParametersValueType >::SetParametersObject ( LightObject object)
inlinevirtual

Set an object that holds the parameters. Used by the helper of derived classes that use an object other than itkArray to hold parameter data. The helper class must check that the object is the correct type. The call is passed to the assigned OptimizerParametersHelper.

Definition at line 111 of file itkOptimizerParameters.h.

Member Data Documentation

◆ m_Helper

template<typename TParametersValueType>
std::unique_ptr<OptimizerParametersHelperType> itk::OptimizerParameters< TParametersValueType >::m_Helper
private
Initial value:
=
std::unique_ptr<OptimizerParametersHelperType>{ new OptimizerParametersHelperType }

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 TParametersValueType. This call is passed to the assigned OptimizerParametersHelper.

Warning
Memory must be managed by caller after this call.

Definition at line 174 of file itkOptimizerParameters.h.


The documentation for this class was generated from the following file:
itk::OptimizerParameters::OptimizerParametersHelperType
OptimizerParametersHelper< TParametersValueType > OptimizerParametersHelperType
Definition: itkOptimizerParameters.h:49