itk::OptimizerParameters< TValueType > Class Template Reference

#include <itkOptimizerParameters.h>

Inheritance diagram for itk::OptimizerParameters< TValueType >:

Collaboration diagram for itk::OptimizerParameters< TValueType >:

List of all members.

Public Types
typedef Superclass	ArrayType
typedef OptimizerParametersHelper < TValueType >	OptimizerParametersHelperType
typedef OptimizerParameters	Self
typedef Superclass::SizeValueType	SizeValueType
typedef Array< TValueType >	Superclass
typedef TValueType	ValueType
typedef Superclass::VnlVectorType	VnlVectorType
Public Member Functions
OptimizerParametersHelperType *	GetHelper ()
void	Initialize ()
virtual void	MoveDataPointer (TValueType *pointer)
const Self &	operator= (const Self &rhs)
const Self &	operator= (const ArrayType &rhs)
const Self &	operator= (const VnlVectorType &rhs)
	OptimizerParameters ()
	OptimizerParameters (const OptimizerParameters &rhs)
	OptimizerParameters (SizeValueType dimension)
	OptimizerParameters (const ArrayType &array)
virtual void	SetHelper (OptimizerParametersHelperType *helper)
virtual void	SetParametersObject (LightObject *object)
virtual	~OptimizerParameters ()
Private Attributes
OptimizerParametersHelperType *	m_Helper

---

Detailed Description

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

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

Definition at line 34 of file itkOptimizerParameters.h.

---

Member Typedef Documentation

template<typename TValueType>

typedef Superclass itk::OptimizerParameters< TValueType >::ArrayType

Definition at line 42 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef OptimizerParametersHelper< TValueType > itk::OptimizerParameters< TValueType >::OptimizerParametersHelperType

Helper class for managing different types of parameter data.

Definition at line 48 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef OptimizerParameters itk::OptimizerParameters< TValueType >::Self

Reimplemented from itk::Array< TValueType >.

Definition at line 40 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef Superclass::SizeValueType itk::OptimizerParameters< TValueType >::SizeValueType

Reimplemented from itk::Array< TValueType >.

Definition at line 44 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef Array< TValueType > itk::OptimizerParameters< TValueType >::Superclass

Definition at line 41 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef TValueType itk::OptimizerParameters< TValueType >::ValueType

The element type stored at each location in the Array.

Reimplemented from itk::Array< TValueType >.

Definition at line 39 of file itkOptimizerParameters.h.

template<typename TValueType>

typedef Superclass::VnlVectorType itk::OptimizerParameters< TValueType >::VnlVectorType

Reimplemented from itk::Array< TValueType >.

Definition at line 43 of file itkOptimizerParameters.h.

---

Constructor & Destructor Documentation

template<typename TValueType>

itk::OptimizerParameters< TValueType >::OptimizerParameters

(

)

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

template<typename TValueType>

itk::OptimizerParameters< TValueType >::OptimizerParameters

(

const OptimizerParameters< TValueType > &

rhs

)

Copy constructor. Uses VNL copy construtor 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.

template<typename TValueType>

itk::OptimizerParameters< TValueType >::OptimizerParameters

(

SizeValueType

dimension

)

[explicit]

Constructor with size. Size can only be changed by assignment

template<typename TValueType>

itk::OptimizerParameters< TValueType >::OptimizerParameters

(

const ArrayType &

array

)

Constructor with Array assignment

template<typename TValueType>

virtual itk::OptimizerParameters< TValueType >::~OptimizerParameters

(

)

[virtual]

---

Member Function Documentation

template<typename TValueType>

OptimizerParametersHelperType* itk::OptimizerParameters< TValueType >::GetHelper

(

)

[inline]

Get the helper in use.

Definition at line 91 of file itkOptimizerParameters.h.

template<typename TValueType>

void itk::OptimizerParameters< TValueType >::Initialize

(

)

Initialize. Initialization called by constructors.

template<typename TValueType>

virtual void itk::OptimizerParameters< TValueType >::MoveDataPointer

(

TValueType *

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

Warning:

Memory must be managed by caller after this call.

template<typename TValueType>

const Self& itk::OptimizerParameters< TValueType >::operator=

(

const Self &

rhs

)

Copy opertors

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?

Reimplemented from itk::Array< TValueType >.

template<typename TValueType>

const Self& itk::OptimizerParameters< TValueType >::operator=

(

const ArrayType &

rhs

)

Copy opertor

Reimplemented from itk::Array< TValueType >.

template<typename TValueType>

const Self& itk::OptimizerParameters< TValueType >::operator=

(

const VnlVectorType &

rhs

)

Reimplemented from itk::Array< TValueType >.

template<typename TValueType>

virtual void itk::OptimizerParameters< TValueType >::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.

template<typename TValueType>

virtual void itk::OptimizerParameters< TValueType >::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

template<typename TValueType>

OptimizerParametersHelperType* itk::OptimizerParameters< TValueType >::m_Helper [private]

Definition at line 107 of file itkOptimizerParameters.h.

Referenced by itk::OptimizerParameters< double >::GetHelper().

---

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

• itkOptimizerParameters.h