ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::IterateNeighborhoodOptimizer Class Reference

#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 38 of file itkIterateNeighborhoodOptimizer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef
IterateNeighborhoodOptimizer 
Self
 
typedef
SingleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 
DerivativeType
 
typedef
CostFunctionType::MeasureType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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)
 
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 CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () const
 
virtual const std::string GetStopConditionDescription () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () 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
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
 
virtual ~IterateNeighborhoodOptimizer ()
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual ~Optimizer ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 Member Functions

 IterateNeighborhoodOptimizer (const Self &)
 
void operator= (const Self &)
 

Private Attributes

unsigned long m_CurrentIteration
 
double m_CurrentValue
 
bool m_FullyConnected
 
bool m_Maximize
 
NeighborhoodSizeType m_NeighborhoodSize
 
bool m_Stop
 
typedef Array< double > NeighborhoodSizeType
 
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
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

Definition at line 46 of file itkIterateNeighborhoodOptimizer.h.

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 89 of file itkIterateNeighborhoodOptimizer.h.

Definition at line 45 of file itkIterateNeighborhoodOptimizer.h.

Standard class typedefs.

Definition at line 43 of file itkIterateNeighborhoodOptimizer.h.

Definition at line 44 of file itkIterateNeighborhoodOptimizer.h.

Constructor & Destructor Documentation

itk::IterateNeighborhoodOptimizer::IterateNeighborhoodOptimizer ( )
protected
virtual itk::IterateNeighborhoodOptimizer::~IterateNeighborhoodOptimizer ( )
inlineprotectedvirtual

Definition at line 108 of file itkIterateNeighborhoodOptimizer.h.

itk::IterateNeighborhoodOptimizer::IterateNeighborhoodOptimizer ( const Self )
private

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 59 of file itkIterateNeighborhoodOptimizer.h.

References m_Maximize.

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

Referenced by MinimizeOn().

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

Referenced by MinimizeOff().

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 65 of file itkIterateNeighborhoodOptimizer.h.

References MaximizeOn().

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 63 of file itkIterateNeighborhoodOptimizer.h.

References MaximizeOff().

static Pointer itk::IterateNeighborhoodOptimizer::New ( )
static

Method for creation through the object factory.

void itk::IterateNeighborhoodOptimizer::operator= ( const Self )
private
void itk::IterateNeighborhoodOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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

Referenced by SetMinimize().

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 61 of file itkIterateNeighborhoodOptimizer.h.

References SetMaximize().

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

Start optimization.

Reimplemented from itk::Optimizer.

void itk::IterateNeighborhoodOptimizer::StopOptimization ( void  )

Stop optimization.

See Also
ResumeOptimization

Member Data Documentation

unsigned long itk::IterateNeighborhoodOptimizer::m_CurrentIteration
private

Definition at line 119 of file itkIterateNeighborhoodOptimizer.h.

double itk::IterateNeighborhoodOptimizer::m_CurrentValue
private

Definition at line 118 of file itkIterateNeighborhoodOptimizer.h.

bool itk::IterateNeighborhoodOptimizer::m_FullyConnected
private

Definition at line 117 of file itkIterateNeighborhoodOptimizer.h.

bool itk::IterateNeighborhoodOptimizer::m_Maximize
private

Definition at line 116 of file itkIterateNeighborhoodOptimizer.h.

Referenced by GetMinimize().

NeighborhoodSizeType itk::IterateNeighborhoodOptimizer::m_NeighborhoodSize
private

Definition at line 120 of file itkIterateNeighborhoodOptimizer.h.

bool itk::IterateNeighborhoodOptimizer::m_Stop
private

Definition at line 115 of file itkIterateNeighborhoodOptimizer.h.


The documentation for this class was generated from the following file: