itk::ConjugateGradientOptimizer Class Reference

#include <itkConjugateGradientOptimizer.h>

Inheritance diagram for itk::ConjugateGradientOptimizer:

Collaboration diagram for itk::ConjugateGradientOptimizer:

Detailed Description

Wrap of the vnl_conjugate_gradient.

Definition at line 34 of file itkConjugateGradientOptimizer.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	InternalOptimizerType = vnl_conjugate_gradient
using	InternalParametersType = vnl_vector< double >
using	Pointer = SmartPointer< Self >
using	Self = ConjugateGradientOptimizer
using	Superclass = SingleValuedNonLinearVnlOptimizer
Public Types inherited from itk::SingleValuedNonLinearVnlOptimizer
using	CommandType = ReceptorMemberCommand< Self >
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = SingleValuedNonLinearVnlOptimizer
using	Superclass = SingleValuedNonLinearOptimizer
Public Types inherited from itk::SingleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >
using	CostFunctionPointer = CostFunctionType::Pointer
using	CostFunctionType = SingleValuedCostFunction
using	DerivativeType = CostFunctionType::DerivativeType
using	MeasureType = CostFunctionType::MeasureType
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = SingleValuedNonLinearOptimizer
using	Superclass = NonLinearOptimizer
Public Types inherited from itk::NonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = Superclass::ScalesType
using	Self = NonLinearOptimizer
using	Superclass = Optimizer
Public Types inherited from itk::Optimizer
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = OptimizerParameters< double >
using	Pointer = SmartPointer< Self >
using	ScalesType = Array< double >
using	Self = Optimizer
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
SizeValueType	GetCurrentIteration () const
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfIterations () const
vnl_conjugate_gradient *	GetOptimizer ()
MeasureType	GetValue () const
void	SetCostFunction (SingleValuedCostFunction *costFunction) override
void	StartOptimization () override
Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer
virtual const bool &	GetMaximize () const
virtual void	SetMaximize (bool _arg)
virtual void	MaximizeOn ()
virtual void	MaximizeOff ()
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn ()
void	MinimizeOff ()
virtual const MeasureType &	GetCachedValue () const
virtual const DerivativeType &	GetCachedDerivative () const
virtual const ParametersType &	GetCachedCurrentPosition () const
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const CostFunctionType *	GetCostFunction () const
virtual CostFunctionType *	GetModifiableCostFunction ()
MeasureType	GetValue (const ParametersType &parameters) const
virtual void	SetCostFunction (CostFunctionType *costFunction)
Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
virtual const std::string	GetStopConditionDescription () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
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 Types
using	CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType
Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizer
using	CostFunctionAdaptorType = SingleValuedVnlCostFunctionAdaptor

Protected Member Functions
	ConjugateGradientOptimizer ()
	~ConjugateGradientOptimizer () override
Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const
void	PrintSelf (std::ostream &os, Indent indent) const override
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
	SingleValuedNonLinearVnlOptimizer ()
	~SingleValuedNonLinearVnlOptimizer () override
Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
	SingleValuedNonLinearOptimizer ()
	~SingleValuedNonLinearOptimizer () override=default
Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default
	~NonLinearOptimizer () override
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
virtual void	SetCurrentPosition (const ParametersType &param)
	~Optimizer () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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 Attributes
bool	m_OptimizerInitialized
InternalOptimizerType *	m_VnlOptimizer

Additional Inherited Members
Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction
Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition
bool	m_ScalesInitialized { false }
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::ConjugateGradientOptimizer::ConstPointer = SmartPointer< const Self >

Definition at line 45 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType

protected

Definition at line 80 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::InternalOptimizerType = vnl_conjugate_gradient

Internal Optimizer Type

Definition at line 57 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::InternalParametersType = vnl_vector< double >

InternalParameters type alias.

Definition at line 54 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::Pointer = SmartPointer< Self >

Definition at line 44 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::Self = ConjugateGradientOptimizer

Standard class type aliases.

Definition at line 42 of file itkConjugateGradientOptimizer.h.

using itk::ConjugateGradientOptimizer::Superclass = SingleValuedNonLinearVnlOptimizer

Definition at line 43 of file itkConjugateGradientOptimizer.h.

Constructor & Destructor Documentation

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer ( )

protected

itk::ConjugateGradientOptimizer::~ConjugateGradientOptimizer ( )

overrideprotected

Member Function Documentation

virtual::itk::LightObject::Pointer itk::ConjugateGradientOptimizer::CreateAnother ( ) 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::Object.

SizeValueType itk::ConjugateGradientOptimizer::GetCurrentIteration

(

)

const

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

SizeValueType itk::ConjugateGradientOptimizer::GetNumberOfIterations

(

)

const

Return the number of iterations performed so far

vnl_conjugate_gradient* itk::ConjugateGradientOptimizer::GetOptimizer

(

)

Method for getting access to the internal optimizer

MeasureType itk::ConjugateGradientOptimizer::GetValue

(

)

const

Return Current Value

static Pointer itk::ConjugateGradientOptimizer::New ( )

static

Method for creation through the object factory.

void itk::ConjugateGradientOptimizer::SetCostFunction ( SingleValuedCostFunction *  costFunction )

overridevirtual

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizer.

void itk::ConjugateGradientOptimizer::StartOptimization ( )

overridevirtual

Start optimization with an initial value.

Reimplemented from itk::Optimizer.

Member Data Documentation

bool itk::ConjugateGradientOptimizer::m_OptimizerInitialized

private

The vnl optimization method for conjugate gradient.

Definition at line 84 of file itkConjugateGradientOptimizer.h.

InternalOptimizerType* itk::ConjugateGradientOptimizer::m_VnlOptimizer

private

Definition at line 85 of file itkConjugateGradientOptimizer.h.

---

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

• itkConjugateGradientOptimizer.h