ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Private Attributes | 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

OptimizerParametersHelperTypeGetHelper ()
 
void Initialize ()
 
virtual void MoveDataPointer (TParametersValueType *pointer)
 
const Selfoperator= (const ArrayType &rhs)
 
const Selfoperator= (const Self &rhs)
 
const Selfoperator= (const VnlVectorType &rhs)
 
 OptimizerParameters ()
 
 OptimizerParameters (const ArrayType &array)
 
 OptimizerParameters (const OptimizerParameters &rhs)
 
 OptimizerParameters (SizeValueType dimension)
 
virtual void SetHelper (OptimizerParametersHelperType *helper)
 
virtual void SetParametersObject (LightObject *object)
 
virtual ~OptimizerParameters ()
 
- 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 ()
 
void Swap (Array &other)
 

Private Attributes

OptimizerParametersHelperTypem_Helper
 

Detailed Description

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

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

Definition at line 34 of file itkOptimizerParameters.h.

Member Typedef Documentation

◆ ArrayType

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

Definition at line 41 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 47 of file itkOptimizerParameters.h.

◆ Self

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

Definition at line 39 of file itkOptimizerParameters.h.

◆ SizeValueType

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

Definition at line 43 of file itkOptimizerParameters.h.

◆ Superclass

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

Definition at line 40 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 38 of file itkOptimizerParameters.h.

◆ VnlVectorType

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

Definition at line 42 of file itkOptimizerParameters.h.

Constructor & Destructor Documentation

◆ OptimizerParameters() [1/4]

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

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)

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.

◆ OptimizerParameters() [3/4]

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

Constructor with size. Size can only be changed by assignment

◆ OptimizerParameters() [4/4]

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

Constructor with Array assignment

◆ ~OptimizerParameters()

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

Member Function Documentation

◆ GetHelper()

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

Get the helper in use.

Definition at line 95 of file itkOptimizerParameters.h.

◆ Initialize()

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

Initialize. Initialization called by constructors.

◆ MoveDataPointer()

template<typename TParametersValueType>
virtual void itk::OptimizerParameters< TParametersValueType >::MoveDataPointer ( TParametersValueType *  pointer)
virtual

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.

◆ operator=() [1/3]

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

◆ operator=() [2/3]

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

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?

◆ operator=() [3/3]

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

◆ SetHelper()

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

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.

◆ SetParametersObject()

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

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.

Member Data Documentation

◆ m_Helper

template<typename TParametersValueType>
OptimizerParametersHelperType* itk::OptimizerParameters< TParametersValueType >::m_Helper
private

Definition at line 117 of file itkOptimizerParameters.h.


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