ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::RegularStepGradientDescentOptimizer Class Reference

#include <itkRegularStepGradientDescentOptimizer.h>

+ Inheritance diagram for itk::RegularStepGradientDescentOptimizer:
+ Collaboration diagram for itk::RegularStepGradientDescentOptimizer:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef
RegularStepGradientDescentOptimizer 
Self
typedef
RegularStepGradientDescentBaseOptimizer 
Superclass
- Public Types inherited from itk::RegularStepGradientDescentBaseOptimizer
enum  StopConditionType {
  GradientMagnitudeTolerance = 1,
  StepTooSmall = 2,
  ImageNotAvailable = 3,
  CostFunctionError = 4,
  MaximumNumberOfIterations = 5,
  Unknown = 6
}
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef
CostFunctionType::DerivativeType 
DerivativeType
typedef
CostFunctionType::MeasureType 
MeasureType
typedef Superclass::ParametersType ParametersType
- 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 ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
- 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 ()

Protected Member Functions

virtual void StepAlongGradient (double factor, const DerivativeType &transformedGradient)
- 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
 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 &)
 RegularStepGradientDescentOptimizer (const Self &)
typedef
Superclass::CostFunctionType 
CostFunctionType
typedef CostFunctionType::Pointer CostFunctionPointer
 RegularStepGradientDescentOptimizer ()
virtual ~RegularStepGradientDescentOptimizer ()

Additional Inherited Members

- 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
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction

Detailed Description

Implement a gradient descent optimizer.

Definition at line 32 of file itkRegularStepGradientDescentOptimizer.h.


Member Typedef Documentation

Cost function typedefs.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Definition at line 51 of file itkRegularStepGradientDescentOptimizer.h.

typedef Superclass::CostFunctionType itk::RegularStepGradientDescentOptimizer::CostFunctionType

Cost function typedefs.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Definition at line 47 of file itkRegularStepGradientDescentOptimizer.h.

Standard class typedefs.

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

Definition at line 37 of file itkRegularStepGradientDescentOptimizer.h.


Constructor & Destructor Documentation

itk::RegularStepGradientDescentOptimizer::RegularStepGradientDescentOptimizer ( )
inlineprotected

Cost function typedefs.

Definition at line 53 of file itkRegularStepGradientDescentOptimizer.h.

virtual itk::RegularStepGradientDescentOptimizer::~RegularStepGradientDescentOptimizer ( )
inlineprotectedvirtual

Cost function typedefs.

Definition at line 54 of file itkRegularStepGradientDescentOptimizer.h.

itk::RegularStepGradientDescentOptimizer::RegularStepGradientDescentOptimizer ( const Self )
private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::RegularStepGradientDescentOptimizer::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::RegularStepGradientDescentOptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

static Pointer itk::RegularStepGradientDescentOptimizer::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

void itk::RegularStepGradientDescentOptimizer::operator= ( const Self )
private

Types inherited from the superclass

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

virtual void itk::RegularStepGradientDescentOptimizer::StepAlongGradient ( double  factor,
const DerivativeType transformedGradient 
)
protectedvirtual

Advance one step along the corrected gradient taking into account the steplength represented by factor. This method is invoked by AdvanceOneStep. It is expected to be overrided by optimization methods in non-vector spaces

See also:
AdvanceOneStep

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