#include <itkQuaternionRigidTransformGradientDescentOptimizer.h>

Inheritance diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

Collaboration diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

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.

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
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef GradientDescentOptimizer	Self

enum	StopConditionType { MaximumNumberOfIterations, MetricError }

typedef SingleValuedNonLinearOptimizer	Superclass

Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer

typedef CostFunctionType::Pointer	CostFunctionPointer

typedef SingleValuedCostFunction	CostFunctionType

typedef CostFunctionType::DerivativeType	DerivativeType

typedef CostFunctionType::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedNonLinearOptimizer	Self

typedef NonLinearOptimizer	Superclass

Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef NonLinearOptimizer	Self

typedef Optimizer	Superclass

Public Types inherited from itk::Optimizer
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < double >	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Array< double >	ScalesType

typedef Optimizer	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	AdvanceOneStep (void) ITK_OVERRIDE

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 DerivativeType &	GetGradient () const

virtual const double &	GetLearningRate () const

virtual const SizeValueType &	GetNumberOfIterations () const

virtual const double &	GetValue () const

void	ResumeOptimization (void)

virtual void	SetLearningRate (double _arg)

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	StartOptimization (void) ITK_OVERRIDE

void	StopOptimization (void)

virtual const bool &	GetMaximize () const

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

virtual const std::string	GetStopConditionDescription () const ITK_OVERRIDE

Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetInitialPosition () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GradientDescentOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Optimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	QuaternionRigidTransformGradientDescentOptimizer ()

virtual	~QuaternionRigidTransformGradientDescentOptimizer ()

Protected Member Functions inherited from itk::GradientDescentOptimizer
	GradientDescentOptimizer ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

virtual	~GradientDescentOptimizer ()

Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
	SingleValuedNonLinearOptimizer ()

virtual	~SingleValuedNonLinearOptimizer ()

Protected Member Functions inherited from itk::NonLinearOptimizer
	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 Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::GradientDescentOptimizer
DerivativeType	m_Gradient

double	m_LearningRate

bool	m_Maximize

Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition

bool	m_ScalesInitialized

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

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

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.

Definition at line 66 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

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

Definition at line 58 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef QuaternionRigidTransformGradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Self

Standard class typedefs.

Definition at line 56 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef GradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Superclass

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.

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

private

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