#include <itkIterateNeighborhoodOptimizer.h>

Inheritance diagram for itk::IterateNeighborhoodOptimizer:

Collaboration diagram for itk::IterateNeighborhoodOptimizer:

Detailed Description

Finds the local minima/maxima by iteratively choosing the minimum/maximum value in a neighborhood.

This optimizer is designed to operate on a monotonic cost function WITHOUT using gradient information (derivatives). The user must set the Neighborhood size, and optionally the connectivity.

Definition at line 40 of file itkIterateNeighborhoodOptimizer.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = IterateNeighborhoodOptimizer

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 void	AdvanceOneStep (void)

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

virtual unsigned int	GetCurrentIteration () const

virtual const double &	GetCurrentValue () const

virtual const char *	GetNameOfClass () const

void	ResumeOptimization (void)

void	StartOptimization (void) override

void	StopOptimization (void)


virtual const bool &	GetMaximize () const

virtual void	SetMaximize (bool _arg)

virtual void	MaximizeOn ()

virtual void	MaximizeOff ()

bool	GetMinimize () const

void	SetMinimize (bool v)

void	MinimizeOn ()

void	MinimizeOff ()


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()

virtual void	FullyConnectedOff ()

Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual const CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetInitialPosition () const

virtual const std::string	GetStopConditionDescription () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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 flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	IterateNeighborhoodOptimizer ()

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

	~IterateNeighborhoodOptimizer () override

Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
	SingleValuedNonLinearOptimizer ()

	~SingleValuedNonLinearOptimizer () override=default

Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default

	~NonLinearOptimizer () override

Protected Member Functions inherited from itk::Optimizer
	Optimizer ()

virtual void	SetCurrentPosition (const ParametersType &param)

	~Optimizer () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~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 ()

Private Attributes
unsigned long	m_CurrentIteration

double	m_CurrentValue

bool	m_FullyConnected

bool	m_Maximize

NeighborhoodSizeType	m_NeighborhoodSize

bool	m_Stop

using	NeighborhoodSizeType = Array< double >

virtual void	SetNeighborhoodSize (NeighborhoodSizeType _arg)

virtual const NeighborhoodSizeType &	GetNeighborhoodSize () const

Additional Inherited Members
Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition

bool	m_ScalesInitialized { false }

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::IterateNeighborhoodOptimizer::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkIterateNeighborhoodOptimizer.h.

using itk::IterateNeighborhoodOptimizer::NeighborhoodSizeType = Array<double>

Get/set the nieghborhood size (in physical space). The default is [1.0,1.0] and MUST be specified for all 3-D images and 2-D images with non-unity spacing.

Definition at line 99 of file itkIterateNeighborhoodOptimizer.h.

using itk::IterateNeighborhoodOptimizer::Pointer = SmartPointer<Self>

Definition at line 49 of file itkIterateNeighborhoodOptimizer.h.

using itk::IterateNeighborhoodOptimizer::Self = IterateNeighborhoodOptimizer

Standard class type alias.

Definition at line 47 of file itkIterateNeighborhoodOptimizer.h.

using itk::IterateNeighborhoodOptimizer::Superclass = SingleValuedNonLinearOptimizer

Definition at line 48 of file itkIterateNeighborhoodOptimizer.h.

Constructor & Destructor Documentation

itk::IterateNeighborhoodOptimizer::IterateNeighborhoodOptimizer ( )

protected

itk::IterateNeighborhoodOptimizer::~IterateNeighborhoodOptimizer ( )

inlineoverrideprotected

Definition at line 112 of file itkIterateNeighborhoodOptimizer.h.

Member Function Documentation

virtual void itk::IterateNeighborhoodOptimizer::AdvanceOneStep ( void )

virtual

Advance one step.

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

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::SingleValuedNonLinearOptimizer.

virtual void itk::IterateNeighborhoodOptimizer::FullyConnectedOff ( )

virtual

Get/set whether the nieghborhood is defined by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOn.

virtual void itk::IterateNeighborhoodOptimizer::FullyConnectedOn ( )

virtual

Get/set whether the nieghborhood is defined by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOn.

virtual unsigned int itk::IterateNeighborhoodOptimizer::GetCurrentIteration ( ) const

virtual

Get the current iteration number.

virtual const double& itk::IterateNeighborhoodOptimizer::GetCurrentValue ( ) const

virtual

Get the current value.

virtual const bool& itk::IterateNeighborhoodOptimizer::GetFullyConnected ( ) const

virtual

Get/set whether the nieghborhood is defined by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOn.

virtual const bool& itk::IterateNeighborhoodOptimizer::GetMaximize ( ) const

virtual

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

bool itk::IterateNeighborhoodOptimizer::GetMinimize ( ) const

inline

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

Definition at line 63 of file itkIterateNeighborhoodOptimizer.h.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual const NeighborhoodSizeType& itk::IterateNeighborhoodOptimizer::GetNeighborhoodSize ( ) const

virtual

Get/set the nieghborhood size (in physical space). The default is [1.0,1.0] and MUST be specified for all 3-D images and 2-D images with non-unity spacing.

virtual void itk::IterateNeighborhoodOptimizer::MaximizeOff ( )

virtual

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

virtual void itk::IterateNeighborhoodOptimizer::MaximizeOn ( )

virtual

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

void itk::IterateNeighborhoodOptimizer::MinimizeOff ( )

inline

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

Definition at line 69 of file itkIterateNeighborhoodOptimizer.h.

void itk::IterateNeighborhoodOptimizer::MinimizeOn ( )

inline

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

Definition at line 67 of file itkIterateNeighborhoodOptimizer.h.

static Pointer itk::IterateNeighborhoodOptimizer::New ( )

static

Method for creation through the object factory.

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

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::SingleValuedNonLinearOptimizer.

void itk::IterateNeighborhoodOptimizer::ResumeOptimization ( void )

Resume previously stopped optimization with current parameters

See Also: StopOptimization.

virtual void itk::IterateNeighborhoodOptimizer::SetFullyConnected ( bool _arg )

virtual

Get/set whether the nieghborhood is defined by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOn.

virtual void itk::IterateNeighborhoodOptimizer::SetMaximize ( bool _arg )

virtual

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

void itk::IterateNeighborhoodOptimizer::SetMinimize ( bool v )

inline

Configure whether the local maxima or minima is found. The default is to minimize the cost function (maximize = false ).

Definition at line 65 of file itkIterateNeighborhoodOptimizer.h.

virtual void itk::IterateNeighborhoodOptimizer::SetNeighborhoodSize ( NeighborhoodSizeType _arg )

virtual

Get/set the nieghborhood size (in physical space). The default is [1.0,1.0] and MUST be specified for all 3-D images and 2-D images with non-unity spacing.

void itk::IterateNeighborhoodOptimizer::StartOptimization ( void )

overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

void itk::IterateNeighborhoodOptimizer::StopOptimization ( void )

Stop optimization.