#include <itkOptimizerParameters.h>

Inheritance diagram for itk::OptimizerParameters< TValue >:

Collaboration diagram for itk::OptimizerParameters< TValue >:

Detailed Description

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

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

Definition at line 34 of file itkOptimizerParameters.h.

Public Types
typedef Superclass	ArrayType

typedef OptimizerParametersHelper < TValue >	OptimizerParametersHelperType

typedef OptimizerParameters	Self

typedef Superclass::SizeValueType	SizeValueType

typedef Array< TValue >	Superclass

typedef TValue	ValueType

typedef Superclass::VnlVectorType	VnlVectorType

Public Types inherited from itk::Array< TValue >
typedef Array	Self

typedef vnl_vector< TValue > ::size_type	SizeValueType

typedef TValue	ValueType

typedef vnl_vector< TValue >	VnlVectorType

Public Member Functions
OptimizerParametersHelperType *	GetHelper ()

void	Initialize ()

virtual void	MoveDataPointer (TValue *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 ()

Public Member Functions inherited from itk::Array< TValue >
	Array ()

	Array (const Array &)

	Array (SizeValueType dimension)

	Array (ValueType *data, SizeValueType sz, bool LetArrayManageMemory=false)

	Array (const ValueType *data, SizeValueType sz, bool LetArrayManageMemory=false)

void	Fill (TValue const &v)

const TValue &	GetElement (SizeValueType i) const

SizeValueType	GetSize (void) const

const Self &	operator= (const Self &rhs)

const Self &	operator= (const VnlVectorType &rhs)

void	SetData (TValue *data, bool LetArrayManageMemory=false)

void	SetData (TValue *data, SizeValueType sz, bool LetArrayManageMemory=false)

void	SetElement (SizeValueType i, const TValue &value)

void	SetSize (SizeValueType sz)

void	swap (Array &other)

	~Array ()

template<typename TArrayValue >
	Array (const Array< TArrayValue > &r)

SizeValueType	Size (void) const

unsigned int	GetNumberOfElements (void) const

Private Attributes
OptimizerParametersHelperType *	m_Helper

Member Typedef Documentation

template<typename TValue>

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

Definition at line 42 of file itkOptimizerParameters.h.

template<typename TValue>

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

Helper class for managing different types of parameter data.

Definition at line 48 of file itkOptimizerParameters.h.

template<typename TValue>

typedef OptimizerParameters itk::OptimizerParameters< TValue >::Self

Definition at line 40 of file itkOptimizerParameters.h.

template<typename TValue>

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

Definition at line 44 of file itkOptimizerParameters.h.

template<typename TValue>

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

Definition at line 41 of file itkOptimizerParameters.h.

template<typename TValue>

typedef TValue itk::OptimizerParameters< TValue >::ValueType

The element type stored at each location in the Array.

Definition at line 39 of file itkOptimizerParameters.h.

template<typename TValue>

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

Definition at line 43 of file itkOptimizerParameters.h.

Constructor & Destructor Documentation

template<typename TValue>

itk::OptimizerParameters< TValue >::OptimizerParameters ( )

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

template<typename TValue>

itk::OptimizerParameters< TValue >::OptimizerParameters ( const OptimizerParameters< TValue > & 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 TValue>

itk::OptimizerParameters< TValue >::OptimizerParameters ( SizeValueType dimension )

explicit

Constructor with size. Size can only be changed by assignment

template<typename TValue>

itk::OptimizerParameters< TValue >::OptimizerParameters ( const ArrayType & array )

Constructor with Array assignment

template<typename TValue>

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

virtual

Member Function Documentation

template<typename TValue>

OptimizerParametersHelperType* itk::OptimizerParameters< TValue >::GetHelper ( )

inline

Get the helper in use.

Definition at line 91 of file itkOptimizerParameters.h.

template<typename TValue>

void itk::OptimizerParameters< TValue >::Initialize ( )

Initialize. Initialization called by constructors.

template<typename TValue>

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

Warning: Memory must be managed by caller after this call.

template<typename TValue>

const Self& itk::OptimizerParameters< TValue >::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?

template<typename TValue>

const Self& itk::OptimizerParameters< TValue >::operator= ( const ArrayType & rhs )

template<typename TValue>

const Self& itk::OptimizerParameters< TValue >::operator= ( const VnlVectorType & rhs )

template<typename TValue>

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

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