ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::VersorTransformOptimizer Class Reference

#include <itkVersorTransformOptimizer.h>

+ Inheritance diagram for itk::VersorTransformOptimizer:
+ Collaboration diagram for itk::VersorTransformOptimizer:

Detailed Description

Implement a gradient descent optimizer.

VersorTransformOptimizer is a variant of the gradient descent optimizer implmented in RegularStepGradientDescentOptimizer.

Versors are not in a vector space, for that reason, the classical gradient descent algorithm has to be modified in order to be applicable to Versors (unit quaternions) that form the group SO(3).

The Versor space has only three degrees of freedom, even though Versors are represented using four values.

This optimizer assumes that the CostFunction to be optimized has an itk::Versor as parameter.

See Also
RegularStepGradientDescentOptimizer
Versor
VersorTransform

Definition at line 51 of file itkVersorTransformOptimizer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef VersorTransformOptimizer Self
 
typedef
RegularStepGradientDescentBaseOptimizer 
Superclass
 
typedef VersorType::VectorType VectorType
 
typedef Versor< double > VersorType
 
- Public Types inherited from itk::RegularStepGradientDescentBaseOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef
RegularStepGradientDescentBaseOptimizer 
Self
 
enum  StopConditionType {
  GradientMagnitudeTolerance = 1,
  StepTooSmall = 2,
  ImageNotAvailable = 3,
  CostFunctionError = 4,
  MaximumNumberOfIterations = 5,
  Unknown = 6
}
 
typedef
SingleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 
DerivativeType
 
typedef
CostFunctionType::MeasureType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void StepAlongGradient (double factor, const DerivativeType &transformedGradient)
 
- Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
virtual const std::string GetStopConditionDescription () const
 
void ResumeOptimization (void)
 
void StartOptimization (void)
 
void StopOptimization (void)
 
virtual void SetMaximize (bool _arg)
 
virtual const bool & GetMaximize ()
 
virtual void MaximizeOn ()
 
virtual void MaximizeOff ()
 
bool GetMinimize () const
 
void SetMinimize (bool v)
 
void MinimizeOn (void)
 
void MinimizeOff (void)
 
virtual void SetMaximumStepLength (double _arg)
 
virtual void SetMinimumStepLength (double _arg)
 
virtual void SetRelaxationFactor (double _arg)
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual void SetGradientMagnitudeTolerance (double _arg)
 
virtual const double & GetCurrentStepLength ()
 
virtual const double & GetMaximumStepLength ()
 
virtual const double & GetMinimumStepLength ()
 
virtual const double & GetRelaxationFactor ()
 
virtual const SizeValueTypeGetNumberOfIterations ()
 
virtual const double & GetGradientMagnitudeTolerance ()
 
virtual unsigned int GetCurrentIteration () const
 
virtual const StopConditionTypeGetStopCondition ()
 
virtual const MeasureTypeGetValue ()
 
virtual const DerivativeTypeGetGradient ()
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual const CostFunctionTypeGetCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
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

 VersorTransformOptimizer ()
 
virtual ~VersorTransformOptimizer ()
 
- Protected Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
virtual void AdvanceOneStep (void)
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 RegularStepGradientDescentBaseOptimizer ()
 
virtual void StepAlongGradient (double, const DerivativeType &)
 
virtual ~RegularStepGradientDescentBaseOptimizer ()
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
void PrintSelf (std::ostream &os, Indent indent) const
 
 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 &)
 
 VersorTransformOptimizer (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::RegularStepGradientDescentBaseOptimizer
SizeValueType m_CurrentIteration
 
double m_CurrentStepLength
 
DerivativeType m_Gradient
 
double m_GradientMagnitudeTolerance
 
bool m_Maximize
 
double m_MaximumStepLength
 
double m_MinimumStepLength
 
SizeValueType m_NumberOfIterations
 
DerivativeType m_PreviousGradient
 
double m_RelaxationFactor
 
bool m_Stop
 
StopConditionType m_StopCondition
 
std::ostringstream m_StopConditionDescription
 
MeasureType m_Value
 

Member Typedef Documentation

Definition at line 59 of file itkVersorTransformOptimizer.h.

Definition at line 58 of file itkVersorTransformOptimizer.h.

Standard class typedefs.

Definition at line 56 of file itkVersorTransformOptimizer.h.

Definition at line 57 of file itkVersorTransformOptimizer.h.

Definition at line 70 of file itkVersorTransformOptimizer.h.

Versor Type

Definition at line 66 of file itkVersorTransformOptimizer.h.

Constructor & Destructor Documentation

itk::VersorTransformOptimizer::VersorTransformOptimizer ( )
inlineprotected

Definition at line 77 of file itkVersorTransformOptimizer.h.

virtual itk::VersorTransformOptimizer::~VersorTransformOptimizer ( )
inlineprotectedvirtual

Definition at line 78 of file itkVersorTransformOptimizer.h.

itk::VersorTransformOptimizer::VersorTransformOptimizer ( const Self )
private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::VersorTransformOptimizer::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::RegularStepGradientDescentBaseOptimizer.

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

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

static Pointer itk::VersorTransformOptimizer::New ( )
static

Method for creation through the object factory.

void itk::VersorTransformOptimizer::operator= ( const Self )
private
virtual void itk::VersorTransformOptimizer::StepAlongGradient ( double  factor,
const DerivativeType transformedGradient 
)
virtual

Advance one step following the gradient direction.


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