ITK
6.0.0
Insight Toolkit
|
#include <itkOnePlusOneEvolutionaryOptimizerv4.h>
1+1 evolutionary strategy optimizer
This optimizer searches for the optimal parameters. It changes its search radius and position using the grow factor ,shrink factor, and isotropic probability function (which is a random unit normal variate generator).
This optimizer needs a cost function and a random unit normal variate generator. The cost function should return cost with new position in parameter space which will be generated by 1+1 evolutionary strategy. Users should plug-in the random unit normal variate generator using SetNormalVariateGenerator method.
The SetEpsilon method is the minimum value for the frobenius_norm of the covariance matrix. If the fnorm is smaller than this value, the optimization process will stop even before it hits the maximum iteration.
Another way to stop the optimization process is calling the StopOptimization method. At next iteration after calling it, the optimization process will stop.
This optimizing scheme was initially developed and implemented by Martin Styner, Univ. of North Carolina at Chapel Hill, and his colleagues.
For more details. refer to the following articles. "Parametric estimate of intensity inhomogeneities applied to MRI" Martin Styner, G. Gerig, Christian Brechbuehler, Gabor Szekely, IEEE TRANSACTIONS ON MEDICAL IMAGING; 19(3), pp. 153-165, 2000, (https://www.cs.unc.edu/~styner/docs/tmi00.pdf)
"Evaluation of 2D/3D bias correction with 1+1ES-optimization" Martin Styner, Prof. Dr. G. Gerig (IKT, BIWI, ETH Zuerich), TR-197 (https://www.cs.unc.edu/~styner/docs/StynerTR97.pdf)
Definition at line 70 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
Public Member Functions | |
virtual void | CatchGetValueExceptionOn () |
virtual const bool & | GetCatchGetValueException () const |
virtual const double & | GetFrobeniusNorm () const |
virtual const bool & | GetInitialized () const |
virtual const double & | GetMetricWorstPossibleValue () const |
const char * | GetNameOfClass () const override |
std::string | GetStopConditionDescription () const override |
void | Initialize (double initialRadius, double grow=-1, double shrink=-1) |
virtual void | SetCatchGetValueException (bool _arg) |
virtual void | SetMetricWorstPossibleValue (double _arg) |
void | SetNormalVariateGenerator (NormalVariateGeneratorType *generator) |
void | StartOptimization (bool doOnlyInitialization=false) override |
void | StopOptimization () |
virtual void | SetMaximumIteration (unsigned int _arg) |
virtual const unsigned int & | GetMaximumIteration () const |
virtual void | SetGrowthFactor (double _arg) |
virtual const double & | GetGrowthFactor () const |
virtual void | SetShrinkFactor (double _arg) |
virtual const double & | GetShrinkFactor () const |
virtual void | SetInitialRadius (double _arg) |
virtual const double & | GetInitialRadius () const |
virtual void | SetEpsilon (double _arg) |
virtual const double & | GetEpsilon () const |
virtual const MeasureType & | GetCurrentCost () const |
const MeasureType & | GetValue () const override |
Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
virtual bool | CanUseScales () const |
virtual SizeValueType | GetCurrentIteration () const |
virtual const MeasureType & | GetCurrentMetricValue () const |
virtual const ParametersType & | GetCurrentPosition () const |
const char * | GetNameOfClass () const override |
virtual SizeValueType | GetNumberOfIterations () const |
virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
virtual const ScalesType & | GetScales () const |
virtual const bool & | GetScalesAreIdentity () const |
bool | GetScalesInitialized () const |
virtual StopConditionReturnStringType | GetStopConditionDescription () const=0 |
virtual const MeasureType & | GetValue () const |
virtual const ScalesType & | GetWeights () const |
virtual const bool & | GetWeightsAreIdentity () const |
virtual void | SetNumberOfIterations (SizeValueType _arg) |
virtual void | SetNumberOfWorkUnits (ThreadIdType number) |
virtual void | SetScalesEstimator (ScalesEstimatorType *_arg) |
virtual void | SetWeights (ScalesType _arg) |
virtual void | StartOptimization (bool doOnlyInitialization=false) |
virtual void | SetMetric (MetricType *_arg) |
virtual MetricType * | GetModifiableMetric () |
virtual void | SetScales (const ScalesType &scales) |
virtual void | SetDoEstimateScales (bool _arg) |
virtual const bool & | GetDoEstimateScales () const |
virtual void | DoEstimateScalesOn () |
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 | |
OnePlusOneEvolutionaryOptimizerv4 () | |
OnePlusOneEvolutionaryOptimizerv4 (const OnePlusOneEvolutionaryOptimizerv4 &) | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~OnePlusOneEvolutionaryOptimizerv4 () override=default | |
Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
ObjectToObjectOptimizerBaseTemplate () | |
~ObjectToObjectOptimizerBaseTemplate () override | |
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 () |
Private Attributes | |
bool | m_CatchGetValueException {} |
MeasureType | m_CurrentCost {} |
double | m_Epsilon {} |
double | m_FrobeniusNorm {} |
double | m_GrowthFactor {} |
bool | m_Initialized {} |
double | m_InitialRadius {} |
unsigned int | m_MaximumIteration {} |
double | m_MetricWorstPossibleValue {} |
NormalVariateGeneratorType::Pointer | m_RandomGenerator {} |
double | m_ShrinkFactor {} |
bool | m_Stop {} |
std::ostringstream | m_StopConditionDescription {} |
Additional Inherited Members | |
Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
SizeValueType | m_CurrentIteration |
MeasureType | m_CurrentMetricValue |
bool | m_DoEstimateScales |
MetricTypePointer | m_Metric |
SizeValueType | m_NumberOfIterations |
ThreadIdType | m_NumberOfWorkUnits |
ScalesType | m_Scales |
bool | m_ScalesAreIdentity |
ScalesEstimatorType::Pointer | m_ScalesEstimator |
ScalesType | m_Weights |
bool | m_WeightsAreIdentity |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self> |
Definition at line 78 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CostFunctionPointer = CostFunctionType::Pointer |
Definition at line 88 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CostFunctionType = SingleValuedCostFunctionv4 |
Type of the Cost Function
Definition at line 87 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase |
Normal random variate generator type.
Definition at line 91 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Pointer = SmartPointer<Self> |
Definition at line 77 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Self = OnePlusOneEvolutionaryOptimizerv4 |
Standard "Self" type alias.
Definition at line 75 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> |
Definition at line 76 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
protected |
|
protected |
|
overrideprotecteddefault |
|
virtual |
|
virtual |
|
virtual |
Return Current Value
|
virtual |
Set/Get the minimal size of search radius (frobenius_norm of covariance matrix).
|
virtual |
Get the current Frobenius norm of covariance matrix
|
virtual |
Set/Get the search radius grow factor in parameter space.
|
virtual |
Return if optimizer has been initialized
|
virtual |
Set/Get initial search radius in parameter space
|
virtual |
Set/Get maximum iteration limit.
|
virtual |
|
overridevirtual |
Reimplemented from itk::Object.
|
virtual |
Set/Get the search radius shrink factor.
|
overridevirtual |
Stop condition return string type
Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
overridevirtual |
Return Current Value
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Initialize | ( | double | initialRadius, |
double | grow = -1 , |
||
double | shrink = -1 |
||
) |
Initializes the optimizer. Before running this optimizer, this function should have been called.
initialRadius: search radius in parameter space grow: search radius grow factor shrink: search radius shrink factor
|
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.
|
virtual |
|
virtual |
Set/Get the minimal size of search radius (frobenius_norm of covariance matrix).
|
virtual |
Set/Get the search radius grow factor in parameter space.
|
virtual |
Set/Get initial search radius in parameter space
|
virtual |
Set/Get maximum iteration limit.
|
virtual |
void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetNormalVariateGenerator | ( | NormalVariateGeneratorType * | generator | ) |
|
virtual |
Set/Get the search radius shrink factor.
|
overridevirtual |
Start optimization. Optimization will stop when it meets either of two termination conditions, the maximum iteration limit or epsilon (minimal search radius)
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
inline |
when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.
Definition at line 162 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Definition at line 191 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Internal storage for the value type / used as a cache
Definition at line 211 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
The minimal size of search radius (frobenius_norm of covariance matrix).
Definition at line 196 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Cache variable for reporting the Frobenius Norm
Definition at line 224 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Search radius growth factor in parameter space.
Definition at line 202 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Flag tells if the optimizer was initialized using Initialize function.
Definition at line 208 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Initial search radius in parameter space.
Definition at line 199 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Maximum iteration limit.
Definition at line 189 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Definition at line 192 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Smart pointer to the normal random variate generator.
Definition at line 186 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Search radius shrink factor in parameter space,
Definition at line 205 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
This is user-settable flag to stop optimization. when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.
Definition at line 217 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Stop description
Definition at line 220 of file itkOnePlusOneEvolutionaryOptimizerv4.h.