ITK
6.0.0
Insight Toolkit
|
#include <itkOptimizerParameterScalesEstimator.h>
OptimizerParameterScalesEstimatorTemplate is the base class offering a empty method of estimating the parameter scales for optimizers.
Its subclass RegistrationParameterScalesEstimator estimates scales for registration optimizers.
Definition at line 39 of file itkOptimizerParameterScalesEstimator.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | FloatType = TInternalComputationValueType |
using | ParametersType = OptimizerParameters< TInternalComputationValueType > |
using | Pointer = SmartPointer< Self > |
using | ScalesType = OptimizerParameters< TInternalComputationValueType > |
using | Self = OptimizerParameterScalesEstimatorTemplate |
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 void | EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0 |
virtual FloatType | EstimateMaximumStepSize ()=0 |
virtual void | EstimateScales (ScalesType &scales)=0 |
virtual FloatType | EstimateStepScale (const ParametersType &step)=0 |
const char * | GetNameOfClass () const override |
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 |
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 void | Delete () |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
Protected Member Functions | |
OptimizerParameterScalesEstimatorTemplate ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~OptimizerParameterScalesEstimatorTemplate () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
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 | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Additional Inherited Members | |
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 Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self> |
Definition at line 48 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::FloatType = TInternalComputationValueType |
Type of float
Definition at line 60 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ParametersType = OptimizerParameters<TInternalComputationValueType> |
Type of parameters of the optimizer
Definition at line 57 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self> |
Definition at line 47 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ScalesType = OptimizerParameters<TInternalComputationValueType> |
Type of scales
Definition at line 54 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Self = OptimizerParameterScalesEstimatorTemplate |
Standard class type aliases.
Definition at line 45 of file itkOptimizerParameterScalesEstimator.h.
using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Superclass = Object |
Definition at line 46 of file itkOptimizerParameterScalesEstimator.h.
|
protecteddefault |
|
overrideprotecteddefault |
|
pure virtual |
Estimate the scales of local steps.
Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
pure virtual |
Estimate the maximum size for steps.
Implemented in itk::RegistrationParameterScalesEstimator< TMetric >.
|
pure virtual |
Estimate parameter scales.
Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
pure virtual |
Estimate the scale of a step.
Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
overridevirtual |
Reimplemented from itk::Object.
|
inlineoverrideprotectedvirtual |
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.
Definition at line 83 of file itkOptimizerParameterScalesEstimator.h.