#include <itkVersorTransformOptimizer.h>
Inheritance diagram for itk::VersorTransformOptimizer:


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.
Definition at line 50 of file itkVersorTransformOptimizer.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 VersorTransformOptimizer | Self |
| enum | StopConditionType { GradientMagnitudeTolerance = 1, StepTooSmall = 2, ImageNotAvailable = 3, CostFunctionError = 4, MaximumNumberOfIterations = 5 } |
| typedef RegularStepGradientDescentBaseOptimizer | Superclass |
| typedef VersorType::VectorType | VectorType |
| typedef Versor< double > | VersorType |
Public Member Functions | |
| 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 () |
| virtual const double & | GetCurrentStepLength () |
| bool | GetDebug () const |
| virtual const DerivativeType & | GetGradient () |
| virtual const double & | GetGradientMagnitudeTolerance () |
| virtual const ParametersType & | GetInitialPosition () |
| virtual const bool & | GetMaximize () |
| virtual const double & | GetMaximumStepLength () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| bool | GetMinimize () const |
| virtual const double & | GetMinimumStepLength () |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| virtual const unsigned long & | GetNumberOfIterations () |
| virtual int | GetReferenceCount () const |
| virtual const double & | GetRelaxationFactor () |
| virtual const ScalesType & | GetScales () |
| virtual const StopConditionType & | GetStopCondition () |
| MeasureType | GetValue (const ParametersType ¶meters) const |
| virtual const MeasureType & | 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) |
| void | MinimizeOn (void) |
| 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 | SetGradientMagnitudeTolerance (double _arg) |
| virtual void | SetInitialPosition (const ParametersType ¶m) |
| Specify whether to minimize or maximize the cost function *virtual void | SetMaximize (bool _arg) |
| Set Get parameters to control the optimization process *virtual void | SetMaximumStepLength (double _arg) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| void | SetMinimize (bool v) |
| virtual void | SetMinimumStepLength (double _arg) |
| virtual void | SetNumberOfIterations (unsigned long _arg) |
| virtual void | SetReferenceCount (int) |
| virtual void | SetRelaxationFactor (double _arg) |
| void | SetScales (const ScalesType &scales) |
| void | StartOptimization (void) |
| virtual void | StepAlongGradient (double factor, const DerivativeType &transformedGradient) |
| 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 | |
| virtual void | AdvanceOneStep (void) |
| 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 |
| virtual void | SetCurrentPosition (const ParametersType ¶m) |
| VersorTransformOptimizer () | |
| virtual | ~VersorTransformOptimizer () |
Protected Attributes | |
| CostFunctionPointer | m_CostFunction |
| unsigned long | m_CurrentIteration |
| double | m_CurrentStepLength |
| DerivativeType | m_Gradient |
| double | m_GradientMagnitudeTolerance |
| bool | m_Maximize |
| double | m_MaximumStepLength |
| double | m_MinimumStepLength |
| unsigned long | m_NumberOfIterations |
| DerivativeType | m_PreviousGradient |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| double | m_RelaxationFactor |
| bool | m_ScalesInitialized |
| bool | m_Stop |
| StopConditionType | m_StopCondition |
| MeasureType | m_Value |
| 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 |
|
|
Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. Definition at line 58 of file itkVersorTransformOptimizer.h. |
|
|
Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h. |
|
|
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. |
|
|
Derivative type. It defines a type used to return the cost function derivative. Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h. |
|
|
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. |
|
|
Parameters type. It defines a position in the optimization search space. Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::FRPROptimizer, itk::PowellOptimizer, and itk::QuaternionRigidTransformGradientDescentOptimizer. Definition at line 48 of file itkSingleValuedNonLinearOptimizer.h. |
|
|
Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. Definition at line 57 of file itkVersorTransformOptimizer.h. |
|
|
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. |
|
|
Standard class typedefs. Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. Definition at line 55 of file itkVersorTransformOptimizer.h. |
|
|
Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. Definition at line 56 of file itkVersorTransformOptimizer.h. |
|
|
Definition at line 69 of file itkVersorTransformOptimizer.h. |
|
|
Versor Type Definition at line 65 of file itkVersorTransformOptimizer.h. |
|
|
Codes of stopping conditions.
Definition at line 49 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 76 of file itkVersorTransformOptimizer.h. |
|
|
Definition at line 77 of file itkVersorTransformOptimizer.h. |
|
|
Advance one step following the gradient direction This method verifies if a change in direction is required and if a reduction in steplength is required. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|
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. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
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. |
|
|
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. |
|
|
Get the cost function. |
|
|
|
|
|
Get current position of the optimization. |
|
|
|
|
|
Get the value of the debug flag. |
|
|
|
|
|
|
|
|
|
|
|
Get the position to initialize the optimization. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Definition at line 61 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
|
|
|
|
Run-time type information (and related methods). Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. |
|
|
|
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|
|
|
|
Get current parameters scaling. |
|
|
|
|
|
Get the cost function value at the given parameters. Reimplemented in itk::SPSAOptimizer. |
|
|
|
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
|
|
|
|
|
|
|
Definition at line 67 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 65 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
|
Method for creation through the object factory. Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||
|
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. |
|
||||||||||||
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
|
Resume previously stopped optimization with current parameters.
|
|
|
Set the cost function. |
|
|
Set the current position. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
|
|
|
|
Set the position to initialize the optimization. |
|
|
|
|
|
|
|
|
|
|
|
Definition at line 63 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
|
|
|
|
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
|
|
|
Set current parameters scaling. Reimplemented in itk::LBFGSBOptimizer. |
|
|
Start optimization. Reimplemented from itk::Optimizer. |
|
||||||||||||
|
Advance one step following the gradient direction. Reimplemented from itk::RegularStepGradientDescentBaseOptimizer. |
|
|
Stop optimization.
|
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h. |
|
|
Definition at line 146 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 142 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 133 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 139 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 137 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 140 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 141 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 145 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 134 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
Definition at line 143 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 90 of file itkOptimizer.h. |
|
|
Definition at line 136 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 144 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
Definition at line 138 of file itkRegularStepGradientDescentBaseOptimizer.h. |
|
|
|
1.4.2 written by Dimitri van Heesch,
© 1997-2000