#include <itkQuaternionRigidTransformGradientDescentOptimizer.h>

Inheritance diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

Collaboration diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef QuaternionRigidTransformGradientDescentOptimizer	Self
typedef GradientDescentOptimizer	Superclass
Public Types inherited from itk::GradientDescentOptimizer
enum	StopConditionType { MaximumNumberOfIterations, MetricError }
Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::DerivativeType	DerivativeType
typedef CostFunctionType::MeasureType	MeasureType
Public Types inherited from itk::NonLinearOptimizer
typedef Superclass::ScalesType	ScalesType
Public Types inherited from itk::Optimizer
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	AdvanceOneStep (void)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::GradientDescentOptimizer
virtual SizeValueType	GetCurrentIteration () const
virtual const double &	GetLearningRate ()
virtual const SizeValueType &	GetNumberOfIterations ()
virtual const double &	GetValue ()
void	ResumeOptimization (void)
virtual void	SetLearningRate (double _arg)
virtual void	SetNumberOfIterations (SizeValueType _arg)
void	StartOptimization (void)
void	StopOptimization (void)
virtual const bool &	GetMaximize ()
virtual void	SetMaximize (bool _arg)
virtual void	MaximizeOn ()
virtual void	MaximizeOff ()
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn ()
void	MinimizeOff ()
virtual const StopConditionType &	GetStopCondition ()
const std::string	GetStopConditionDescription () const
virtual const DerivativeType &	GetGradient ()
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual const CostFunctionType *	GetCostFunction ()
MeasureType	GetValue (const ParametersType &parameters) const
virtual void	SetCostFunction (CostFunctionType *costFunction)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	QuaternionRigidTransformGradientDescentOptimizer ()
virtual	~QuaternionRigidTransformGradientDescentOptimizer ()
	GradientDescentOptimizer ()
virtual	~GradientDescentOptimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
	SingleValuedNonLinearOptimizer ()
virtual	~SingleValuedNonLinearOptimizer ()
	NonLinearOptimizer ()
virtual	~NonLinearOptimizer ()
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~Optimizer ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	QuaternionRigidTransformGradientDescentOptimizer (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::GradientDescentOptimizer
DerivativeType	m_Gradient
double	m_LearningRate
bool	m_Maximize
Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Detailed Description

Implement a gradient descent optimizer.

QuaternionRigidTransformGradientDescentOptimizer is an extension to the simple gradient descent optimizer implmented in GradientDescentOptimizer. At each iteration the current position is updated according to

p(n+1) = p(n) + learningRate * d f(p(n)) / d p(n)

$p_{n+1} = p_n + \mbox{learningRate} \, \frac{\partial f(p_n) }{\partial p_n}$

The learning rate is a fixed scalar defined via SetLearningRate(). The optimizer steps through a user defined number of iterations; no convergence checking is done. The first four components of p are assumed to be the four components of the quaternion. After each update, the quaternion is normalized to have a magnitude of one. This ensures the the transform is purely rigid.

See also:: GradientDescentOptimizer

Definition at line 51 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

Member Typedef Documentation

typedef SmartPointer< const Self > itk::QuaternionRigidTransformGradientDescentOptimizer::ConstPointer

Reimplemented from itk::GradientDescentOptimizer.

Definition at line 59 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef Superclass::ParametersType itk::QuaternionRigidTransformGradientDescentOptimizer::ParametersType

Parameters type. It defines a position in the optimization search space.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Definition at line 66 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef SmartPointer< Self > itk::QuaternionRigidTransformGradientDescentOptimizer::Pointer

Reimplemented from itk::GradientDescentOptimizer.

Definition at line 58 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef QuaternionRigidTransformGradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Self

Standard class typedefs.

Reimplemented from itk::GradientDescentOptimizer.

Definition at line 56 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef GradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Superclass

Reimplemented from itk::GradientDescentOptimizer.

Definition at line 57 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

Constructor & Destructor Documentation

itk::QuaternionRigidTransformGradientDescentOptimizer::QuaternionRigidTransformGradientDescentOptimizer ( )

inlineprotected

Definition at line 76 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

virtual itk::QuaternionRigidTransformGradientDescentOptimizer::~QuaternionRigidTransformGradientDescentOptimizer ( )

inlineprotectedvirtual

Definition at line 77 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

itk::QuaternionRigidTransformGradientDescentOptimizer::QuaternionRigidTransformGradientDescentOptimizer ( const Self & )

private

Member Function Documentation

virtual void itk::QuaternionRigidTransformGradientDescentOptimizer::AdvanceOneStep ( void )

virtual

Advance one step following the gradient direction.

Reimplemented from itk::GradientDescentOptimizer.

virtual::itk::LightObject::Pointer itk::QuaternionRigidTransformGradientDescentOptimizer::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::GradientDescentOptimizer.

virtual const char* itk::QuaternionRigidTransformGradientDescentOptimizer::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::GradientDescentOptimizer.

static Pointer itk::QuaternionRigidTransformGradientDescentOptimizer::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::GradientDescentOptimizer.

void itk::QuaternionRigidTransformGradientDescentOptimizer::operator= ( const Self & )

private

Types inherited from the superclass