itk::MultipleValuedNonLinearOptimizer Class Reference

#include <itkMultipleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::MultipleValuedNonLinearOptimizer:

Collaboration diagram for itk::MultipleValuedNonLinearOptimizer:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	CostFunctionPointer = CostFunctionType::Pointer
using	CostFunctionType = MultipleValuedCostFunction
using	DerivativeType = Array2D< double >
using	MeasureType = Array< double >
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = MultipleValuedNonLinearOptimizer
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 char *	GetNameOfClass () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
Public Member Functions inherited from itk::NonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const ParametersType &	GetInitialPosition () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
virtual const ParametersType &	GetCurrentPosition () 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
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 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 void	Delete ()
virtual int	GetReferenceCount () const
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 val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
	MultipleValuedNonLinearOptimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~MultipleValuedNonLinearOptimizer () override=default
Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default
	~NonLinearOptimizer () override
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
	~Optimizer () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
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 &timeStamp)
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 multiple valued function.

Definition at line 34 of file itkMultipleValuedNonLinearOptimizer.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 43 of file itkMultipleValuedNonLinearOptimizer.h.

CostFunctionPointer

using itk::MultipleValuedNonLinearOptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 47 of file itkMultipleValuedNonLinearOptimizer.h.

CostFunctionType

using itk::MultipleValuedNonLinearOptimizer::CostFunctionType = MultipleValuedCostFunction

Type of the Cost Function

Definition at line 46 of file itkMultipleValuedNonLinearOptimizer.h.

DerivativeType

using itk::MultipleValuedNonLinearOptimizer::DerivativeType = Array2D<double>

Derivative type. It defines a type used to return the cost function derivative. Here a bidimensional Array is used for Multivalued functions

Definition at line 67 of file itkMultipleValuedNonLinearOptimizer.h.

MeasureType

using itk::MultipleValuedNonLinearOptimizer::MeasureType = Array<double>

Measure type. It defines a type used to return the cost function value. Here an Array is used for Multivalued functions

Definition at line 62 of file itkMultipleValuedNonLinearOptimizer.h.

ParametersType

using itk::MultipleValuedNonLinearOptimizer::ParametersType = Superclass::ParametersType

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

Definition at line 57 of file itkMultipleValuedNonLinearOptimizer.h.

Pointer

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

Definition at line 42 of file itkMultipleValuedNonLinearOptimizer.h.

Self

using itk::MultipleValuedNonLinearOptimizer::Self = MultipleValuedNonLinearOptimizer

Standard class type aliases.

Definition at line 40 of file itkMultipleValuedNonLinearOptimizer.h.

Superclass

using itk::MultipleValuedNonLinearOptimizer::Superclass = NonLinearOptimizer

Definition at line 41 of file itkMultipleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

MultipleValuedNonLinearOptimizer()

itk::MultipleValuedNonLinearOptimizer::MultipleValuedNonLinearOptimizer ( )

protected

~MultipleValuedNonLinearOptimizer()

itk::MultipleValuedNonLinearOptimizer::~MultipleValuedNonLinearOptimizer ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

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

GetNameOfClass()

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::CumulativeGaussianOptimizer, itk::LevenbergMarquardtOptimizer, and itk::MultipleValuedNonLinearVnlOptimizer.

New()

static Pointer itk::MultipleValuedNonLinearOptimizer::New ( )

static

Method for creation through the object factory.

PrintSelf()

void itk::MultipleValuedNonLinearOptimizer::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::Object.

Reimplemented in itk::MultipleValuedNonLinearVnlOptimizer.

SetCostFunction()

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

virtual

Set the cost function.

Member Data Documentation

m_CostFunction

CostFunctionPointer itk::MultipleValuedNonLinearOptimizer::m_CostFunction

protected

Definition at line 79 of file itkMultipleValuedNonLinearOptimizer.h.

---

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

• itkMultipleValuedNonLinearOptimizer.h