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

#include <itkNonLinearOptimizer.h>

+ Inheritance diagram for itk::NonLinearOptimizer:
+ Collaboration diagram for itk::NonLinearOptimizer:

Detailed Description

Wrap of the vnl_nonlinear_minimizer to be adapted.

This class is provided to support the structure of an Optimizers Hierarchy. It is not intended to be instantiated.

Definition at line 35 of file itkNonLinearOptimizer.h.

Public Types

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 > 
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 ::itk::LightObject::Pointer CreateAnother () const
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
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 void StartOptimization ()
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::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

 NonLinearOptimizer ()
virtual ~NonLinearOptimizer ()
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
virtual void PrintSelf (std::ostream &os, Indent indent) const override
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

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

Additional Inherited Members

- 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 43 of file itkNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::NonLinearOptimizer::ParametersType

Types inherited from the superclass

Definition at line 49 of file itkNonLinearOptimizer.h.

Definition at line 42 of file itkNonLinearOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType

Definition at line 53 of file itkNonLinearOptimizer.h.

Standard class typedefs.

Definition at line 40 of file itkNonLinearOptimizer.h.

Definition at line 41 of file itkNonLinearOptimizer.h.

Constructor & Destructor Documentation

itk::NonLinearOptimizer::NonLinearOptimizer ( )

Definition at line 56 of file itkNonLinearOptimizer.h.

virtual itk::NonLinearOptimizer::~NonLinearOptimizer ( )
itk::NonLinearOptimizer::NonLinearOptimizer ( const Self )

Member Function Documentation

virtual::itk::LightObject::Pointer itk::NonLinearOptimizer::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.

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::ParticleSwarmOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, itk::SingleValuedNonLinearOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::RegularStepGradientDescentOptimizer.

virtual const char* itk::NonLinearOptimizer::GetNameOfClass ( ) const
static Pointer itk::NonLinearOptimizer::New ( )

Method for creation through the object factory.

void itk::NonLinearOptimizer::operator= ( const Self )

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