itk::QuaternionRigidTransformGradientDescentOptimizer Class Reference
[Numerics]

#include <itkQuaternionRigidTransformGradientDescentOptimizer.h>

Inheritance diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

[legend]Collaboration diagram for itk::QuaternionRigidTransformGradientDescentOptimizer:

[legend]List of all members.

---

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)

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 Optimizers

Definition at line 50 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

Public Types
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 Superclass::ScalesType	ScalesType
typedef QuaternionRigidTransformGradientDescentOptimizer	Self
enum	StopConditionType {   MaximumNumberOfIterations,   MetricError }
typedef GradientDescentOptimizer	Superclass
Public Member Functions
virtual void	AdvanceOneStep (void)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual const CostFunctionType *	GetCostFunction ()
virtual unsigned int	GetCurrentIteration () const
virtual const ParametersType &	GetCurrentPosition ()
bool	GetDebug () const
virtual const DerivativeType &	GetGradient ()
virtual const ParametersType &	GetInitialPosition ()
virtual const double &	GetLearningRate ()
Methods to configure the cost function *virtual const bool &	GetMaximize ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
bool	GetMinimize () const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const unsigned long &	GetNumberOfIterations ()
virtual int	GetReferenceCount () const
virtual const ScalesType &	GetScales ()
virtual const StopConditionType &	GetStopCondition ()
MeasureType	GetValue (const ParametersType &parameters) const
virtual const double &	GetValue ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	MaximizeOff ()
virtual void	MaximizeOn ()
void	MinimizeOff ()
void	MinimizeOn ()
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	ResumeOptimization (void)
virtual void	SetCostFunction (CostFunctionType *costFunction)
void	SetDebug (bool debugFlag) const
virtual void	SetInitialPosition (const ParametersType &param)
virtual void	SetLearningRate (double _arg)
virtual void	SetMaximize (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMinimize (bool v)
virtual void	SetNumberOfIterations (unsigned long _arg)
virtual void	SetReferenceCount (int)
void	SetScales (const ScalesType &scales)
void	StartOptimization (void)
void	StopOptimization (void)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	QuaternionRigidTransformGradientDescentOptimizer ()
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~QuaternionRigidTransformGradientDescentOptimizer ()
Protected Attributes
CostFunctionPointer	m_CostFunction
DerivativeType	m_Gradient
double	m_LearningRate
bool	m_Maximize
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_ScalesInitialized
Methods invoked by virtual Print() to print information about the object *including superclasses.Typically not called by the user(use Print()*instead) but used in the hierarchical print process to combine the *output of several classes.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

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

Reimplemented from itk::GradientDescentOptimizer. Definition at line 58 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef CostFunctionType::Pointer itk::SingleValuedNonLinearOptimizer::CostFunctionPointer [inherited]

Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType [inherited]

Type of the Cost Function Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 55 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::DerivativeType itk::SingleValuedNonLinearOptimizer::DerivativeType [inherited]

Derivative type. It defines a type used to return the cost function derivative. Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::MeasureType itk::SingleValuedNonLinearOptimizer::MeasureType [inherited]

Measure type. It defines a type used to return the cost function value. Reimplemented in itk::LBFGSBOptimizer. Definition at line 60 of file itkSingleValuedNonLinearOptimizer.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 65 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

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

Reimplemented from itk::GradientDescentOptimizer. Definition at line 57 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType [inherited]

Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range. Reimplemented from itk::Optimizer. Definition at line 52 of file itkNonLinearOptimizer.h.

typedef QuaternionRigidTransformGradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Self

Standard class typedefs. Reimplemented from itk::GradientDescentOptimizer. Definition at line 55 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

typedef GradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Superclass

Reimplemented from itk::GradientDescentOptimizer. Definition at line 56 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

---

Member Enumeration Documentation

enum itk::GradientDescentOptimizer::StopConditionType [inherited]

Codes of stopping conditions Enumeration values: MaximumNumberOfIterations  MetricError  Definition at line 66 of file itkGradientDescentOptimizer.h.

---

Constructor & Destructor Documentation

itk::QuaternionRigidTransformGradientDescentOptimizer::QuaternionRigidTransformGradientDescentOptimizer (   )  [inline, protected]

Definition at line 75 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

virtual itk::QuaternionRigidTransformGradientDescentOptimizer::~QuaternionRigidTransformGradientDescentOptimizer (   )  [inline, protected, virtual]

Definition at line 76 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.

---

Member Function Documentation

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

Advance one step following the gradient direction. Reimplemented from itk::GradientDescentOptimizer.

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction (   )  [virtual, inherited]

Get the cost function.

virtual unsigned int itk::GradientDescentOptimizer::GetCurrentIteration (   )  const [virtual, inherited]

Get the current iteration number.

virtual const ParametersType& itk::Optimizer::GetCurrentPosition (   )  [virtual, inherited]

Get current position of the optimization.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

virtual const DerivativeType& itk::GradientDescentOptimizer::GetGradient (   )  [virtual, inherited]

Get Stop condition.

virtual const ParametersType& itk::Optimizer::GetInitialPosition (   )  [virtual, inherited]

Get the position to initialize the optimization.

virtual const double& itk::GradientDescentOptimizer::GetLearningRate (   )  [virtual, inherited]

Get the learning rate.

Methods to configure the cost function* virtual const bool& itk::GradientDescentOptimizer::GetMaximize (   )  [virtual, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

bool itk::GradientDescentOptimizer::GetMinimize (   )  const [inline, inherited]

Definition at line 75 of file itkGradientDescentOptimizer.h.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

Run-time type information (and related methods). Reimplemented from itk::GradientDescentOptimizer.

virtual const unsigned long& itk::GradientDescentOptimizer::GetNumberOfIterations (   )  [virtual, inherited]

Get the number of iterations.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

virtual const ScalesType& itk::Optimizer::GetScales (   )  [virtual, inherited]

Get current parameters scaling.

virtual const StopConditionType& itk::GradientDescentOptimizer::GetStopCondition (   )  [virtual, inherited]

Get Stop condition.

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue (  const ParametersType &  parameters  )  const [inherited]

Get the cost function value at the given parameters. Reimplemented in itk::SPSAOptimizer.

virtual const double& itk::GradientDescentOptimizer::GetValue (   )  [virtual, inherited]

Get the current value.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::GradientDescentOptimizer::MaximizeOff (   )  [virtual, inherited]

virtual void itk::GradientDescentOptimizer::MaximizeOn (   )  [virtual, inherited]

void itk::GradientDescentOptimizer::MinimizeOff (   )  [inline, inherited]

Definition at line 81 of file itkGradientDescentOptimizer.h.

void itk::GradientDescentOptimizer::MinimizeOn (   )  [inline, inherited]

Definition at line 79 of file itkGradientDescentOptimizer.h.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::QuaternionRigidTransformGradientDescentOptimizer::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::GradientDescentOptimizer.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

void itk::GradientDescentOptimizer::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::GradientDescentOptimizer::ResumeOptimization (  void   )  [inherited]

Resume previously stopped optimization with current parameters See also: StopOptimization.

virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction (  CostFunctionType *  costFunction  )  [virtual, inherited]

Set the cost function.

virtual void itk::Optimizer::SetCurrentPosition (  const ParametersType &  param  )  [protected, virtual, inherited]

Set the current position.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::Optimizer::SetInitialPosition (  const ParametersType &  param  )  [virtual, inherited]

Set the position to initialize the optimization.

virtual void itk::GradientDescentOptimizer::SetLearningRate (  double  _arg  )  [virtual, inherited]

Set the learning rate.

virtual void itk::GradientDescentOptimizer::SetMaximize (  bool  _arg  )  [virtual, inherited]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

void itk::GradientDescentOptimizer::SetMinimize (  bool  v  )  [inline, inherited]

Definition at line 77 of file itkGradientDescentOptimizer.h.

virtual void itk::GradientDescentOptimizer::SetNumberOfIterations (  unsigned long  _arg  )  [virtual, inherited]

Set the number of iterations.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

void itk::Optimizer::SetScales (  const ScalesType &  scales  )  [inherited]

Set current parameters scaling. Reimplemented in itk::LBFGSBOptimizer.

void itk::GradientDescentOptimizer::StartOptimization (  void   )  [virtual, inherited]

Start optimization. Reimplemented from itk::Optimizer.

void itk::GradientDescentOptimizer::StopOptimization (  void   )  [inherited]

Stop optimization. See also: ResumeOptimization

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected, inherited]

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

DerivativeType itk::GradientDescentOptimizer::m_Gradient [protected, inherited]

Definition at line 131 of file itkGradientDescentOptimizer.h.

double itk::GradientDescentOptimizer::m_LearningRate [protected, inherited]

Definition at line 133 of file itkGradientDescentOptimizer.h.

bool itk::GradientDescentOptimizer::m_Maximize [protected, inherited]

Definition at line 132 of file itkGradientDescentOptimizer.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

bool itk::Optimizer::m_ScalesInitialized [protected, inherited]

Definition at line 90 of file itkOptimizer.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkQuaternionRigidTransformGradientDescentOptimizer.h

---