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

#include <itkSingleValuedNonLinearOptimizer.h>

+ Inheritance diagram for itk::SingleValuedNonLinearOptimizer:
+ Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

Public Types

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
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
virtual const char * GetNameOfClass () const
 
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 void StartOptimization ()
 
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::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 Member Functions

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 ()
 
 ~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 ()
 

Protected Attributes

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

This class is a base for the Optimization methods that optimize a single valued function.

Definition at line 35 of file itkSingleValuedNonLinearOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 44 of file itkSingleValuedNonLinearOptimizer.h.

◆ CostFunctionPointer

Definition at line 58 of file itkSingleValuedNonLinearOptimizer.h.

◆ CostFunctionType

Type of the Cost Function

Definition at line 57 of file itkSingleValuedNonLinearOptimizer.h.

◆ DerivativeType

Derivative type. It defines a type used to return the cost function derivative.

Definition at line 66 of file itkSingleValuedNonLinearOptimizer.h.

◆ MeasureType

Measure type. It defines a type used to return the cost function value.

Definition at line 62 of file itkSingleValuedNonLinearOptimizer.h.

◆ ParametersType

Parameters type. It defines a position in the optimization search space.

Definition at line 54 of file itkSingleValuedNonLinearOptimizer.h.

◆ Pointer

Definition at line 43 of file itkSingleValuedNonLinearOptimizer.h.

◆ Self

Standard "Self" type alias.

Definition at line 41 of file itkSingleValuedNonLinearOptimizer.h.

◆ Superclass

Definition at line 42 of file itkSingleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

◆ SingleValuedNonLinearOptimizer()

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )
protected

◆ ~SingleValuedNonLinearOptimizer()

itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::SingleValuedNonLinearOptimizer::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::NonLinearOptimizer.

Reimplemented in itk::SPSAOptimizer, itk::VersorTransformOptimizer, and itk::VersorRigid3DTransformOptimizer.

◆ GetCostFunction()

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction ( ) const
virtual

◆ GetModifiableCostFunction()

virtual CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetModifiableCostFunction ( )
virtual

Get the cost function.

◆ GetNameOfClass()

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

◆ GetValue()

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType parameters) const

Get the cost function value at the given parameters.

◆ New()

static Pointer itk::SingleValuedNonLinearOptimizer::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

Get current parameters scaling.

Reimplemented from itk::Optimizer.

Reimplemented in itk::SPSAOptimizer, and itk::SingleValuedNonLinearVnlOptimizer.

◆ SetCostFunction()

virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType costFunction)
virtual

Set the cost function.

Member Data Documentation

◆ m_CostFunction

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction
protected

Definition at line 85 of file itkSingleValuedNonLinearOptimizer.h.


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