ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members

#include <itkConjugateGradientOptimizer.h>

+ Inheritance diagram for itk::ConjugateGradientOptimizer:
+ Collaboration diagram for itk::ConjugateGradientOptimizer:

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 MeasureTypeGetCachedValue () const
 
virtual const DerivativeTypeGetCachedDerivative () const
 
virtual const ParametersTypeGetCachedCurrentPosition () const
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const std::string GetStopConditionDescription () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 noexcept override
 
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
 SingleValuedNonLinearVnlOptimizer ()
 
 ~SingleValuedNonLinearVnlOptimizer () override
 
void SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
 
const CostFunctionAdaptorTypeGetCostFunctionAdaptor () const
 
CostFunctionAdaptorTypeGetCostFunctionAdaptor ()
 
CostFunctionAdaptorTypeGetNonConstCostFunctionAdaptor () const
 
void PrintSelf (std::ostream &os, Indent indent) const 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 ()
 
 ~Optimizer () override=default
 
virtual void SetCurrentPosition (const ParametersType &param)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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
 
InternalOptimizerTypem_VnlOptimizer
 

Additional Inherited Members

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

Detailed Description

Wrap of the vnl_conjugate_gradient.

Definition at line 34 of file itkConjugateGradientOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 44 of file itkConjugateGradientOptimizer.h.

◆ CostFunctionAdaptorType

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

Definition at line 85 of file itkConjugateGradientOptimizer.h.

◆ InternalOptimizerType

Internal Optimizer Type

Definition at line 56 of file itkConjugateGradientOptimizer.h.

◆ InternalParametersType

InternalParameters type alias.

Definition at line 53 of file itkConjugateGradientOptimizer.h.

◆ Pointer

Definition at line 43 of file itkConjugateGradientOptimizer.h.

◆ Self

Standard class type aliases.

Definition at line 41 of file itkConjugateGradientOptimizer.h.

◆ Superclass

Definition at line 42 of file itkConjugateGradientOptimizer.h.

Constructor & Destructor Documentation

◆ ConjugateGradientOptimizer()

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer ( )
protected

◆ ~ConjugateGradientOptimizer()

itk::ConjugateGradientOptimizer::~ConjugateGradientOptimizer ( )
overrideprotected

Member Function Documentation

◆ CreateAnother()

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.

◆ GetCurrentIteration()

SizeValueType itk::ConjugateGradientOptimizer::GetCurrentIteration ( ) const

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

◆ GetNumberOfIterations()

SizeValueType itk::ConjugateGradientOptimizer::GetNumberOfIterations ( ) const

Return the number of iterations performed so far

◆ GetOptimizer()

vnl_conjugate_gradient* itk::ConjugateGradientOptimizer::GetOptimizer ( )

Method for getting access to the internal optimizer

◆ GetValue()

MeasureType itk::ConjugateGradientOptimizer::GetValue ( ) const

Return Current Value

◆ New()

static Pointer itk::ConjugateGradientOptimizer::New ( )
static

Method for creation through the object factory.

◆ SetCostFunction()

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

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizer.

◆ StartOptimization()

void itk::ConjugateGradientOptimizer::StartOptimization ( )
overridevirtual

Start optimization with an initial value.

Reimplemented from itk::Optimizer.

Member Data Documentation

◆ m_OptimizerInitialized

bool itk::ConjugateGradientOptimizer::m_OptimizerInitialized
private

The vnl optimization method for conjugate gradient.

Definition at line 89 of file itkConjugateGradientOptimizer.h.

◆ m_VnlOptimizer

InternalOptimizerType* itk::ConjugateGradientOptimizer::m_VnlOptimizer
private

Definition at line 90 of file itkConjugateGradientOptimizer.h.


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