ITK
6.0.0
Insight Toolkit
|
#include <itkConjugateGradientOptimizer.h>
Wrap of the vnl_conjugate_gradient.
Definition at line 35 of file itkConjugateGradientOptimizer.h.
Public Member Functions | |
SizeValueType | GetCurrentIteration () const |
const char * | GetNameOfClass () const override |
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 bool | CanUseScales () const |
const char * | GetNameOfClass () const override |
void | SetCostFunction (SingleValuedCostFunction *costFunction) override=0 |
virtual const bool & | GetMaximize () const |
virtual void | SetMaximize (bool _arg) |
virtual void | MaximizeOn () |
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 CostFunctionType * | GetModifiableCostFunction () |
const char * | GetNameOfClass () const override |
MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
const char * | GetNameOfClass () const override |
Public Member Functions inherited from itk::Optimizer | |
virtual const ParametersType & | GetCurrentPosition () const |
virtual const ParametersType & | GetInitialPosition () const |
const char * | GetNameOfClass () const override |
virtual std::string | GetStopConditionDescription () const |
virtual void | SetInitialPosition (const ParametersType ¶m) |
void | SetScales (const ScalesType &scales) |
virtual void | StartOptimization () |
virtual const ScalesType & | GetScales () const |
virtual const ScalesType & | GetInverseScales () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
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 |
const char * | GetNameOfClass () const override |
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) const |
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 | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 val) |
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 | |
CostFunctionAdaptorType * | GetCostFunctionAdaptor () |
const CostFunctionAdaptorType * | GetCostFunctionAdaptor () const |
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 | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
SingleValuedNonLinearOptimizer () | |
~SingleValuedNonLinearOptimizer () override=default | |
Protected Member Functions inherited from itk::NonLinearOptimizer | |
NonLinearOptimizer ()=default | |
~NonLinearOptimizer () override | |
Protected Member Functions inherited from itk::Optimizer | |
Optimizer () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetCurrentPosition (const ParametersType ¶m) |
~Optimizer () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~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 | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
bool | m_OptimizerInitialized {} |
std::unique_ptr< 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 {} |
using itk::ConjugateGradientOptimizer::ConstPointer = SmartPointer<const Self> |
Definition at line 45 of file itkConjugateGradientOptimizer.h.
|
protected |
Definition at line 86 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.
Definition at line 44 of file itkConjugateGradientOptimizer.h.
Standard class type aliases.
Definition at line 42 of file itkConjugateGradientOptimizer.h.
Definition at line 43 of file itkConjugateGradientOptimizer.h.
|
protected |
|
overrideprotected |
SizeValueType itk::ConjugateGradientOptimizer::GetCurrentIteration | ( | ) | const |
|
overridevirtual |
Reimplemented from itk::Object.
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 |
Method for creation through the object factory.
|
overridevirtual |
Plug in a Cost Function into the optimizer
Implements itk::SingleValuedNonLinearVnlOptimizer.
|
overridevirtual |
Start optimization with an initial value.
Reimplemented from itk::Optimizer.
|
private |
The vnl optimization method for conjugate gradient.
Definition at line 90 of file itkConjugateGradientOptimizer.h.
|
private |
Definition at line 91 of file itkConjugateGradientOptimizer.h.