ITK
5.2.0
Insight Toolkit
|
#include <itkOnePlusOneEvolutionaryOptimizerv4.h>
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const char * | GetNameOfClass () const |
Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > | |
virtual void | SetMetric (MetricType *_arg) |
virtual MetricType * | GetModifiableMetric () |
virtual const MetricType * | GetMetric () const |
virtual const MeasureType & | GetCurrentMetricValue () const |
virtual void | SetScales (const ScalesType &scales) |
virtual const ScalesType & | GetScales () const |
virtual const bool & | GetScalesAreIdentity () const |
virtual void | SetWeights (ScalesType _arg) |
virtual const ScalesType & | GetWeights () const |
virtual const bool & | GetWeightsAreIdentity () const |
bool | GetScalesInitialized () const |
virtual void | SetScalesEstimator (ScalesEstimatorType *_arg) |
virtual void | SetDoEstimateScales (bool _arg) |
virtual const bool & | GetDoEstimateScales () const |
virtual void | DoEstimateScalesOn () |
virtual void | DoEstimateScalesOff () |
virtual void | SetNumberOfWorkUnits (ThreadIdType number) |
virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
virtual SizeValueType | GetCurrentIteration () const |
virtual void | SetNumberOfIterations (SizeValueType _arg) |
virtual SizeValueType | GetNumberOfIterations () const |
virtual const ParametersType & | GetCurrentPosition () 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::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 () |
NormalVariateGeneratorType::Pointer | m_RandomGenerator |
unsigned int | m_MaximumIteration |
bool | m_CatchGetValueException |
double | m_MetricWorstPossibleValue |
double | m_Epsilon |
double | m_InitialRadius |
double | m_GrowthFactor |
double | m_ShrinkFactor |
bool | m_Initialized |
MeasureType | m_CurrentCost |
bool | m_Stop |
std::ostringstream | m_StopConditionDescription |
double | m_FrobeniusNorm |
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 double & | GetFrobeniusNorm () const |
void | SetNormalVariateGenerator (NormalVariateGeneratorType *generator) |
void | Initialize (double initialRadius, double grow=-1, double shrink=-1) |
virtual const MeasureType & | GetCurrentCost () const |
const MeasureType & | GetValue () const override |
virtual const bool & | GetInitialized () const |
void | StartOptimization (bool doOnlyInitialization=false) override |
void | StopOptimization () |
virtual const bool & | GetCatchGetValueException () const |
virtual void | SetCatchGetValueException (bool _arg) |
virtual const double & | GetMetricWorstPossibleValue () const |
virtual void | SetMetricWorstPossibleValue (double _arg) |
const std::string | GetStopConditionDescription () const override |
OnePlusOneEvolutionaryOptimizerv4 () | |
OnePlusOneEvolutionaryOptimizerv4 (const OnePlusOneEvolutionaryOptimizerv4 &) | |
~OnePlusOneEvolutionaryOptimizerv4 () override=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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, (http://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 (http://www.cs.unc.edu/~styner/docs/StynerTR97.pdf)
Definition at line 70 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
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 >::MeasureType = typename Superclass::MeasureType |
Measure type
Definition at line 94 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 >::ParametersType = typename Superclass::ParametersType |
Parameters type
Definition at line 97 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Pointer = SmartPointer<Self> |
Definition at line 77 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::ScalesType = typename Superclass::ScalesType |
Scales type
Definition at line 100 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 |
Smart pointer to the normal random variate generator.
|
protected |
Smart pointer to the normal random variate generator.
|
overrideprotecteddefault |
Smart pointer to the normal random variate generator.
|
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.
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Return Current Value
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Get the current Frobenius norm of covariance matrix
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Return if optimizer has been initialized
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Smart pointer to the normal random variate generator.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
virtual |
Smart pointer to the normal random variate generator.
|
overridevirtual |
Smart pointer to the normal random variate generator.
Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
overridevirtual |
Smart pointer to the normal random variate generator.
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: searhc radius shrink factor
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Smart pointer to the normal random variate generator.
Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.
|
virtual |
Smart pointer to the normal random variate generator.
|
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 |
Smart pointer to the normal random variate generator.
void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetNormalVariateGenerator | ( | NormalVariateGeneratorType * | generator | ) |
Smart pointer to the normal random variate 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 |
Smart pointer to the normal random variate generator.
Definition at line 190 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Internal storage for the value type / used as a cache
Definition at line 210 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
The minimal size of search radius (frobenius_norm of covariance matrix).
Definition at line 195 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Cache variable for reporting the Frobenius Norm
Definition at line 223 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Search radius growth factor in parameter space.
Definition at line 201 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Flag tells if the optimizer was initialized using Initialize function.
Definition at line 207 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Initial search radius in parameter space.
Definition at line 198 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Maximum iteration limit.
Definition at line 188 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Smart pointer to the normal random variate generator.
Definition at line 191 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Smart pointer to the normal random variate generator.
Definition at line 185 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Search radius shrink factor in parameter space,
Definition at line 204 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 216 of file itkOnePlusOneEvolutionaryOptimizerv4.h.
|
private |
Stop description
Definition at line 219 of file itkOnePlusOneEvolutionaryOptimizerv4.h.