itk::UCLRegularStepOptimizer Class Reference

Implement a Regular Step Size optimizer. More...

Inheritance diagram for itk::UCLRegularStepOptimizer:

Collaboration diagram for itk::UCLRegularStepOptimizer:

Public Types
enum	StopConditionType {   StepTooSmall = 1, ImageNotAvailable = 2, CostFunctionError = 3, MaximumNumberOfIterations = 4,   Unknown = 5 }
typedef UCLRegularStepOptimizer	Self
typedef SingleValuedNonLinearOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual const char *	GetClassName () const
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)
void	StartOptimization (void) override
void	ResumeOptimization (void)
void	StopOptimization (void)
virtual void	SetMaximumStepLength (double _arg)
virtual void	SetMinimumStepLength (double _arg)
virtual void	SetRelaxationFactor (double _arg)
virtual void	SetNumberOfIterations (unsigned long _arg)
virtual const double &	GetCurrentStepLength ()
virtual const double &	GetMaximumStepLength ()
virtual const double &	GetMinimumStepLength ()
virtual const double &	GetRelaxationFactor ()
virtual const unsigned long &	GetNumberOfIterations ()
virtual unsigned int	GetCurrentIteration () const
virtual const StopConditionType &	GetStopCondition ()
virtual const MeasureType &	GetValue ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	UCLRegularStepOptimizer ()
virtual	~UCLRegularStepOptimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Attributes
bool	m_Stop
bool	m_Maximize
MeasureType	m_Value
MeasureType	m_BestSoFarValue
ParametersType	m_BestSoFarParameters
double	m_MaximumStepLength
double	m_MinimumStepLength
double	m_CurrentStepLength
double	m_RelaxationFactor
StopConditionType	m_StopCondition
unsigned long	m_NumberOfIterations
unsigned long	m_CurrentIteration

Detailed Description

Implement a Regular Step Size optimizer.

Member Typedef Documentation

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

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

typedef UCLRegularStepOptimizer itk::UCLRegularStepOptimizer::Self

Standard "Self" typedef.

typedef SingleValuedNonLinearOptimizer itk::UCLRegularStepOptimizer::Superclass

Member Enumeration Documentation

enum itk::UCLRegularStepOptimizer::StopConditionType

Codes of stopping conditions.

Enumerator
StepTooSmall
ImageNotAvailable
CostFunctionError
MaximumNumberOfIterations
Unknown

Constructor & Destructor Documentation

itk::UCLRegularStepOptimizer::UCLRegularStepOptimizer ( )

protected

Constructor

virtual itk::UCLRegularStepOptimizer::~UCLRegularStepOptimizer ( )

inlineprotectedvirtual

Member Function Documentation

virtual const char* itk::UCLRegularStepOptimizer::GetClassName ( ) const

virtual

Run-time type information (and related methods).

virtual unsigned int itk::UCLRegularStepOptimizer::GetCurrentIteration ( ) const

virtual

virtual const double& itk::UCLRegularStepOptimizer::GetCurrentStepLength ( )

virtual

virtual const bool& itk::UCLRegularStepOptimizer::GetMaximize ( )

virtual

virtual const double& itk::UCLRegularStepOptimizer::GetMaximumStepLength ( )

virtual

bool itk::UCLRegularStepOptimizer::GetMinimize ( ) const

inline

virtual const double& itk::UCLRegularStepOptimizer::GetMinimumStepLength ( )

virtual

virtual const unsigned long& itk::UCLRegularStepOptimizer::GetNumberOfIterations ( )

virtual

virtual const double& itk::UCLRegularStepOptimizer::GetRelaxationFactor ( )

virtual

virtual const StopConditionType& itk::UCLRegularStepOptimizer::GetStopCondition ( )

virtual

virtual const MeasureType& itk::UCLRegularStepOptimizer::GetValue ( )

virtual

virtual void itk::UCLRegularStepOptimizer::MaximizeOff ( )

virtual

virtual void itk::UCLRegularStepOptimizer::MaximizeOn ( )

virtual

void itk::UCLRegularStepOptimizer::MinimizeOff ( void  )

inline

void itk::UCLRegularStepOptimizer::MinimizeOn ( void  )

inline

static Pointer itk::UCLRegularStepOptimizer::New ( )

static

Method for creation through the object factory.

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

overrideprotected

void itk::UCLRegularStepOptimizer::ResumeOptimization

(

void

)

Resume previously stopped optimization with current parameters.

See also

StopOptimization

Resume the optimization

virtual void itk::UCLRegularStepOptimizer::SetMaximize ( bool  _arg )

virtual

Specify whether to minimize or maximize the cost function.

virtual void itk::UCLRegularStepOptimizer::SetMaximumStepLength ( double  _arg )

virtual

Set/Get parameters to control the optimization process.

void itk::UCLRegularStepOptimizer::SetMinimize ( bool  v )

inline

virtual void itk::UCLRegularStepOptimizer::SetMinimumStepLength ( double  _arg )

virtual

virtual void itk::UCLRegularStepOptimizer::SetNumberOfIterations ( unsigned long  _arg )

virtual

virtual void itk::UCLRegularStepOptimizer::SetRelaxationFactor ( double  _arg )

virtual

void itk::UCLRegularStepOptimizer::StartOptimization ( void  )

override

Start optimization.

Start the optimization

void itk::UCLRegularStepOptimizer::StopOptimization

(

void

)

Stop optimization.

See also

ResumeOptimization

Stop optimization

Member Data Documentation

ParametersType itk::UCLRegularStepOptimizer::m_BestSoFarParameters

protected

MeasureType itk::UCLRegularStepOptimizer::m_BestSoFarValue

protected

unsigned long itk::UCLRegularStepOptimizer::m_CurrentIteration

protected

double itk::UCLRegularStepOptimizer::m_CurrentStepLength

protected

bool itk::UCLRegularStepOptimizer::m_Maximize

protected

double itk::UCLRegularStepOptimizer::m_MaximumStepLength

protected

double itk::UCLRegularStepOptimizer::m_MinimumStepLength

protected

unsigned long itk::UCLRegularStepOptimizer::m_NumberOfIterations

protected

double itk::UCLRegularStepOptimizer::m_RelaxationFactor

protected

bool itk::UCLRegularStepOptimizer::m_Stop

protected

StopConditionType itk::UCLRegularStepOptimizer::m_StopCondition

protected

MeasureType itk::UCLRegularStepOptimizer::m_Value

protected

---

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

• itkUCLRegularStepOptimizer.h
• itkUCLRegularStepOptimizer.cxx