ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::SingleValuedNonLinearOptimizer Class Reference
Numerics | Optimizers | Module ITKOptimizers

#include <itkSingleValuedNonLinearOptimizer.h>

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

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.

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 CostFunctionType * GetCostFunction () const
 
virtual CostFunctionType * GetModifiableCostFunction ()
 
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 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 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 *)
 
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::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 ()
 
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 ()
 

Protected Attributes

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::SingleValuedNonLinearOptimizer::ConstPointer = SmartPointer< const Self >

Definition at line 45 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 60 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::CostFunctionType = SingleValuedCostFunction

Type of the Cost Function

Definition at line 59 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::DerivativeType = CostFunctionType::DerivativeType

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

Definition at line 68 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::MeasureType = CostFunctionType::MeasureType

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

Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::ParametersType = Superclass::ParametersType

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

Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h.

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

Definition at line 44 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::Self = SingleValuedNonLinearOptimizer

Standard "Self" type alias.

Definition at line 42 of file itkSingleValuedNonLinearOptimizer.h.

using itk::SingleValuedNonLinearOptimizer::Superclass = NonLinearOptimizer

Definition at line 43 of file itkSingleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )
protected
itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )
overrideprotecteddefault

Member Function Documentation

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::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, and itk::IterateNeighborhoodOptimizer.

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

Get the cost function.

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

Run-time type information (and related methods).

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::LBFGSOptimizer, itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, itk::PowellOptimizer, itk::ParticleSwarmOptimizer, itk::ParticleSwarmOptimizerBase, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::GradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, itk::FRPROptimizer, itk::SPSAOptimizer, itk::IterateNeighborhoodOptimizer, itk::ConjugateGradientOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::RegularStepGradientDescentOptimizer.

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

Get the cost function value at the given parameters.

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

Method for creation through the object factory.

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Optimizer.

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

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

Set the cost function.

Member Data Documentation

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction
protected

Definition at line 84 of file itkSingleValuedNonLinearOptimizer.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Sun Mar 24 2019 04:06:44 for ITK by   doxygen 1.8.5