ITK
6.0.0
Insight Toolkit
|
#include <itkOptimizer.h>
Generic representation for an optimization method.
This class is a base for a hierarchy of optimizers. It is not intended to be instantiated.
Definition at line 38 of file itkOptimizer.h.
Public Types | |
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 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::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 | |
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 () |
Protected Attributes | |
ParametersType | m_CurrentPosition {} |
bool | m_ScalesInitialized { false } |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
Private Attributes | |
ParametersType | m_InitialPosition {} |
ScalesType | m_InverseScales {} |
ScalesType | m_Scales {} |
using itk::Optimizer::ConstPointer = SmartPointer<const Self> |
Definition at line 47 of file itkOptimizer.h.
using itk::Optimizer::ParametersType = OptimizerParameters<double> |
Parameters type. It defines a position in the optimization search space.
Definition at line 57 of file itkOptimizer.h.
using itk::Optimizer::Pointer = SmartPointer<Self> |
Definition at line 46 of file itkOptimizer.h.
using itk::Optimizer::ScalesType = Array<double> |
Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range.
Definition at line 65 of file itkOptimizer.h.
using itk::Optimizer::Self = Optimizer |
Standard class type aliases.
Definition at line 44 of file itkOptimizer.h.
using itk::Optimizer::Superclass = Object |
Definition at line 45 of file itkOptimizer.h.
|
protected |
|
overrideprotecteddefault |
|
virtual |
Get current position of the optimization.
|
virtual |
Get the position to initialize the optimization.
|
virtual |
Get current parameters scaling.
|
overridevirtual |
Reimplemented from itk::Object.
Reimplemented in itk::ParticleSwarmOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, and itk::VersorTransformOptimizer.
|
virtual |
Get current parameters scaling.
|
virtual |
Get the reason for termination
Reimplemented in itk::AmoebaOptimizer, itk::CumulativeGaussianOptimizer, itk::ExhaustiveOptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::SPSAOptimizer.
|
static |
Method for creation through the object factory.
|
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::ParticleSwarmOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, and itk::SPSAOptimizer.
|
protectedvirtual |
Set the current position.
|
virtual |
Set the position to initialize the optimization.
void itk::Optimizer::SetScales | ( | const ScalesType & | scales | ) |
Set current parameters scaling.
|
inlinevirtual |
Start optimization.
Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::SPSAOptimizer.
Definition at line 88 of file itkOptimizer.h.
|
protected |
Definition at line 110 of file itkOptimizer.h.
|
private |
Definition at line 113 of file itkOptimizer.h.
|
private |
Definition at line 115 of file itkOptimizer.h.
|
private |
Definition at line 114 of file itkOptimizer.h.
|
protected |
Definition at line 105 of file itkOptimizer.h.