ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members

#include <itkExhaustiveOptimizer.h>

+ Inheritance diagram for itk::ExhaustiveOptimizer:
+ Collaboration diagram for itk::ExhaustiveOptimizer:

Public Types

using ConstPointer = SmartPointer< const Self >
using Pointer = SmartPointer< Self >
using Self = ExhaustiveOptimizer
using StepsType = Array< SizeValueType >
using Superclass = SingleValuedNonLinearOptimizer
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
using ConstPointer = SmartPointer< const Self >
using CostFunctionPointer = CostFunctionType::Pointer
using CostFunctionType = SingleValuedCostFunction
using DerivativeType = CostFunctionType::DerivativeType
using MeasureType = CostFunctionType::MeasureType
using ParametersType = Superclass::ParametersType
using Pointer = SmartPointer< Self >
using Self = SingleValuedNonLinearOptimizer
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 ParametersTypeGetCurrentIndex () const
virtual const MeasureTypeGetCurrentValue () const
virtual const MeasureTypeGetMaximumMetricValue () const
virtual const ParametersTypeGetMaximumMetricValuePosition () const
virtual const SizeValueTypeGetMaximumNumberOfIterations () const
virtual const MeasureTypeGetMinimumMetricValue () const
virtual const ParametersTypeGetMinimumMetricValuePosition () const
virtual const char * GetNameOfClass () const
virtual const StepsTypeGetNumberOfSteps () const
virtual const double & GetStepLength () const
const std::string GetStopConditionDescription () const override
void ResumeWalking ()
virtual void SetNumberOfSteps (StepsType _arg)
virtual void SetStepLength (double _arg)
void StartOptimization () override
void StartWalking ()
void StopWalking ()
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
virtual const CostFunctionTypeGetCostFunction () const
virtual CostFunctionTypeGetModifiableCostFunction ()
MeasureType GetValue (const ParametersType &parameters) const
virtual void SetCostFunction (CostFunctionType *costFunction)
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetInitialPosition () const
virtual void SetInitialPosition (const ParametersType &param)
void SetScales (const ScalesType &scales)
virtual const ScalesTypeGetScales () const
virtual const ScalesTypeGetInverseScales () const
virtual const ParametersTypeGetCurrentPosition () 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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () const
virtual ModifiedTimeType GetMTime () const
virtual const TimeStampGetTimeStamp () 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::SingleValuedNonLinearOptimizer
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

void AdvanceOneStep ()
 ExhaustiveOptimizer ()
void IncrementIndex (ParametersType &newPosition)
void PrintSelf (std::ostream &os, Indent indent) const override
 ~ExhaustiveOptimizer () override=default
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
void PrintSelf (std::ostream &os, Indent indent) const override
 SingleValuedNonLinearOptimizer ()
 ~SingleValuedNonLinearOptimizer () override=default
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()=default
 ~NonLinearOptimizer () override
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 ~Optimizer () override=default
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

ParametersType m_CurrentIndex
SizeValueType m_CurrentIteration
unsigned int m_CurrentParameter
MeasureType m_CurrentValue
MeasureType m_MaximumMetricValue
ParametersType m_MaximumMetricValuePosition
SizeValueType m_MaximumNumberOfIterations
MeasureType m_MinimumMetricValue
ParametersType m_MinimumMetricValuePosition
StepsType m_NumberOfSteps
double m_StepLength
bool m_Stop
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
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

Private Attributes

std::ostringstream m_StopConditionDescription

Detailed Description

Optimizer that fully samples a grid on the parametric space.

This optimizer is equivalent to an exhaustive search in a discrete grid defined over the parametric space. The grid is centered on the initial position. The subdivisions of the grid along each one of the dimensions of the parametric space is defined by an array of number of steps.

A typical use is to plot the metric space to get an idea of how noisy it is. An example is given below, where it is desired to plot the metric space with respect to translations along x, y and z in a 3D registration application: Here it is assumed that the transform is Euler3DTransform.

OptimizerType::StepsType steps( m_Transform->GetNumberOfParameters() );
steps[0] = 10;
steps[1] = 10;
steps[2] = 10;
m_Optimizer->SetNumberOfSteps( steps );
m_Optimizer->SetStepLength( 2 );

The optimizer throws IterationEvents after every iteration. We use this to plot the metric space in an image as follows:

if( itk::IterationEvent().CheckEvent(& event ) )
IndexType index;
index[0] = m_Optimizer->GetCurrentIndex()[0];
index[1] = m_Optimizer->GetCurrentIndex()[1];
index[2] = m_Optimizer->GetCurrentIndex()[2];
image->SetPixel( index, m_Optimizer->GetCurrentValue() );

The image size is expected to be 11 x 11 x 11.

If you wish to use different step lengths along each parametric axis, you can use the SetScales() method. This accepts an array, each element represents the number of subdivisions per step length. For instance scales of [0.5 1 4] along with a step length of 2 will cause the optimizer to search the metric space on a grid with x,y,z spacing of [1 2 8].

Physical dimensions of the grid are influenced by both the scales and the number of steps along each dimension, a side of the region is stepLength*(2*numberOfSteps[d]+1)*scaling[d].

ITK Sphinx Examples:

Definition at line 83 of file itkExhaustiveOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 92 of file itkExhaustiveOptimizer.h.

◆ Pointer

Definition at line 91 of file itkExhaustiveOptimizer.h.

◆ Self

Standard "Self" type alias.

Definition at line 89 of file itkExhaustiveOptimizer.h.

◆ StepsType

Definition at line 94 of file itkExhaustiveOptimizer.h.

◆ Superclass

Definition at line 90 of file itkExhaustiveOptimizer.h.

Constructor & Destructor Documentation

◆ ExhaustiveOptimizer()

itk::ExhaustiveOptimizer::ExhaustiveOptimizer ( )

◆ ~ExhaustiveOptimizer()

itk::ExhaustiveOptimizer::~ExhaustiveOptimizer ( )

Member Function Documentation

◆ AdvanceOneStep()

void itk::ExhaustiveOptimizer::AdvanceOneStep ( )

Advance to the next grid position.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::ExhaustiveOptimizer::CreateAnother ( ) const

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.

◆ GetCurrentIndex()

virtual const ParametersType& itk::ExhaustiveOptimizer::GetCurrentIndex ( ) const

◆ GetCurrentValue()

virtual const MeasureType& itk::ExhaustiveOptimizer::GetCurrentValue ( ) const

◆ GetMaximumMetricValue()

virtual const MeasureType& itk::ExhaustiveOptimizer::GetMaximumMetricValue ( ) const

◆ GetMaximumMetricValuePosition()

virtual const ParametersType& itk::ExhaustiveOptimizer::GetMaximumMetricValuePosition ( ) const

◆ GetMaximumNumberOfIterations()

virtual const SizeValueType& itk::ExhaustiveOptimizer::GetMaximumNumberOfIterations ( ) const

◆ GetMinimumMetricValue()

virtual const MeasureType& itk::ExhaustiveOptimizer::GetMinimumMetricValue ( ) const

◆ GetMinimumMetricValuePosition()

virtual const ParametersType& itk::ExhaustiveOptimizer::GetMinimumMetricValuePosition ( ) const

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

◆ GetNumberOfSteps()

virtual const StepsType& itk::ExhaustiveOptimizer::GetNumberOfSteps ( ) const

◆ GetStepLength()

virtual const double& itk::ExhaustiveOptimizer::GetStepLength ( ) const

◆ GetStopConditionDescription()

const std::string itk::ExhaustiveOptimizer::GetStopConditionDescription ( ) const

Get the reason for termination

Reimplemented from itk::Optimizer.

◆ IncrementIndex()

void itk::ExhaustiveOptimizer::IncrementIndex ( ParametersType newPosition)

◆ New()

static Pointer itk::ExhaustiveOptimizer::New ( )

Method for creation through the object factory.

◆ PrintSelf()

void itk::ExhaustiveOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

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.

◆ ResumeWalking()

void itk::ExhaustiveOptimizer::ResumeWalking ( )

◆ SetNumberOfSteps()

virtual void itk::ExhaustiveOptimizer::SetNumberOfSteps ( StepsType  _arg)

◆ SetStepLength()

virtual void itk::ExhaustiveOptimizer::SetStepLength ( double  _arg)

◆ StartOptimization()

void itk::ExhaustiveOptimizer::StartOptimization ( )

Start optimization.

Reimplemented from itk::Optimizer.

◆ StartWalking()

void itk::ExhaustiveOptimizer::StartWalking ( )

◆ StopWalking()

void itk::ExhaustiveOptimizer::StopWalking ( )

Member Data Documentation

◆ m_CurrentIndex

ParametersType itk::ExhaustiveOptimizer::m_CurrentIndex

Definition at line 155 of file itkExhaustiveOptimizer.h.

◆ m_CurrentIteration

SizeValueType itk::ExhaustiveOptimizer::m_CurrentIteration

Definition at line 147 of file itkExhaustiveOptimizer.h.

◆ m_CurrentParameter

unsigned int itk::ExhaustiveOptimizer::m_CurrentParameter

Definition at line 151 of file itkExhaustiveOptimizer.h.

◆ m_CurrentValue

MeasureType itk::ExhaustiveOptimizer::m_CurrentValue

Definition at line 143 of file itkExhaustiveOptimizer.h.

◆ m_MaximumMetricValue

MeasureType itk::ExhaustiveOptimizer::m_MaximumMetricValue

Definition at line 159 of file itkExhaustiveOptimizer.h.

◆ m_MaximumMetricValuePosition

ParametersType itk::ExhaustiveOptimizer::m_MaximumMetricValuePosition

Definition at line 165 of file itkExhaustiveOptimizer.h.

◆ m_MaximumNumberOfIterations

SizeValueType itk::ExhaustiveOptimizer::m_MaximumNumberOfIterations

Definition at line 157 of file itkExhaustiveOptimizer.h.

◆ m_MinimumMetricValue

MeasureType itk::ExhaustiveOptimizer::m_MinimumMetricValue

Definition at line 161 of file itkExhaustiveOptimizer.h.

◆ m_MinimumMetricValuePosition

ParametersType itk::ExhaustiveOptimizer::m_MinimumMetricValuePosition

Definition at line 163 of file itkExhaustiveOptimizer.h.

◆ m_NumberOfSteps

StepsType itk::ExhaustiveOptimizer::m_NumberOfSteps

Definition at line 145 of file itkExhaustiveOptimizer.h.

◆ m_StepLength

double itk::ExhaustiveOptimizer::m_StepLength

Definition at line 153 of file itkExhaustiveOptimizer.h.

◆ m_Stop

bool itk::ExhaustiveOptimizer::m_Stop

Definition at line 149 of file itkExhaustiveOptimizer.h.

◆ m_StopConditionDescription

std::ostringstream itk::ExhaustiveOptimizer::m_StopConditionDescription

Definition at line 168 of file itkExhaustiveOptimizer.h.

The documentation for this class was generated from the following file:
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50