Inheritance diagram for itk::RegularStepGradientDescentOptimizer2:

Public Types
enum	StopConditionType { GradientMagnitudeTolerance = 1, StepTooSmall = 2, ImageNotAvailable = 3, SamplesNotAvailable = 4, MaximumNumberOfIterations = 5 }

typedef RegularStepGradientDescentOptimizer2	Self

typedef SingleValuedNonLinearOptimizer	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

Public Member Functions
	itkNewMacro (Self)

	itkTypeMacro (RegularStepGradientDescentOptimizer2, SingleValuedNonLinearOptimizer)

	itkSetMacro (Maximize, bool)

	itkGetConstReferenceMacro (Maximize, bool)

	itkBooleanMacro (Maximize)

bool	GetMinimize () const

void	SetMinimize (bool v)

void	MinimizeOn ()

void	MinimizeOff ()

void	StartOptimization ()

void	ResumeOptimization ()

void	StopOptimization ()

	itkSetMacro (MaximumStepLength, double)

	itkSetMacro (MinimumStepLength, double)

	itkGetConstReferenceMacro (MaximumStepLength, double)

	itkGetConstReferenceMacro (MinimumStepLength, double)

	itkSetMacro (RelaxationFactor, double)

	itkGetConstReferenceMacro (RelaxationFactor, double)

	itkSetMacro (NumberOfIterations, unsigned long)

	itkGetConstReferenceMacro (NumberOfIterations, unsigned long)

	itkSetMacro (GradientMagnitudeTolerance, double)

	itkGetConstReferenceMacro (GradientMagnitudeTolerance, double)

	itkSetMacro (BackTracking, bool)

	itkGetConstReferenceMacro (BackTracking, bool)

	itkSetMacro (PickUpPaceSteps, unsigned int)

	itkGetConstReferenceMacro (PickUpPaceSteps, unsigned int)

	itkGetConstReferenceMacro (CurrentStepLength, double)

	itkGetConstMacro (CurrentIteration, unsigned int)

	itkGetConstReferenceMacro (StopCondition, StopConditionType)

	itkGetConstReferenceMacro (Value, MeasureType)

	itkGetConstReferenceMacro (Gradient, DerivativeType)

	itkGetConstReferenceMacro (BestParams, ParametersType)

	itkGetConstReferenceMacro (BestValue, MeasureType)

Protected Member Functions
virtual void	AdvanceOneStep ()

virtual void	StepAlongGradient (double step_length_scale, const DerivativeType &step_direction)

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

Protected Attributes
DerivativeType	m_Gradient

DerivativeType	m_PreviousGradient

bool	m_Stop

bool	m_Maximize

MeasureType	m_Value

MeasureType	m_PreviousValue

double	m_GradientMagnitudeTolerance

double	m_MaximumStepLength

double	m_MinimumStepLength

double	m_CurrentStepLength

double	m_RelaxationFactor

StopConditionType	m_StopCondition

unsigned long	m_NumberOfIterations

unsigned long	m_CurrentIteration

MeasureType	m_BestValue

ParametersType	m_BestParams

bool	m_BackTracking

unsigned int	m_PickUpPaceSteps

Member Typedef Documentation

typedef RegularStepGradientDescentOptimizer2 itk::RegularStepGradientDescentOptimizer2::Self

Standard "Self" typedef.

Member Function Documentation

itk::RegularStepGradientDescentOptimizer2::itkNewMacro ( Self )

Method for creation through the object factory.

itk::RegularStepGradientDescentOptimizer2::itkSetMacro	(	Maximize	,
		bool
	)

Specify whether to minimize or maximize the cost function.

itk::RegularStepGradientDescentOptimizer2::itkTypeMacro	(	RegularStepGradientDescentOptimizer2	,
		SingleValuedNonLinearOptimizer
	)

Run-time type information (and related methods).

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

Core/ITKCommon/Optimizers/itkRegularStepGradientDescentOptimizer2.h
Core/ITKCommon/Optimizers/itkRegularStepGradientDescentOptimizer2.cxx

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Function Documentation