itk::MultipleValuedNonLinearVnlOptimizer Class Reference
[Numerics]

#include <itkMultipleValuedNonLinearVnlOptimizer.h>

Inheritance diagram for itk::MultipleValuedNonLinearVnlOptimizer:

[legend]Collaboration diagram for itk::MultipleValuedNonLinearVnlOptimizer:

[legend]List of all members.

---

Detailed Description

This class is a base for the Optimization methods that optimize a multi-valued function.

It is an Adaptor class for optimizers provided by the vnl library

Optimizers

Definition at line 36 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef MultipleValuedCostFunction	CostFunctionType
typedef Array2D< double >	DerivativeType
typedef Array< double >	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef MultipleValuedNonLinearVnlOptimizer	Self
typedef MultipleValuedNonLinearOptimizer	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const ParametersType &	GetCachedCurrentPosition ()
virtual const DerivativeType &	GetCachedDerivative ()
Command *	GetCommand (unsigned long tag)
virtual const ParametersType &	GetCurrentPosition ()
bool	GetDebug () const
virtual const ParametersType &	GetInitialPosition ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual const ScalesType &	GetScales ()
bool	GetUseCostFunctionGradient () const
Return Cached Values These method have the advantage of not triggering a *recomputation of the metric but it has the disadvantage of returning *a value that may not be the one corresponding to the current parameters For *GUI update this method is a good for mathematical *validation you should rather call	GetValue ().*/virtual const MeasureType &GetCachedValue()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual void	SetCostFunction (MultipleValuedCostFunction *costFunction)=0
void	SetDebug (bool debugFlag) const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetScales (const ScalesType &scales)
virtual void	StartOptimization ()
virtual void	UnRegister () const
void	UseCostFunctionGradientOff ()
void	UseCostFunctionGradientOn ()
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Return Cached Values These method have the advantage of not triggering a *recomputation of the metric but it has the disadvantage of returning *a value that may not be the one corresponding to the current parameters For *GUI update this method is a good	option
Return Cached Values These method have the advantage of not triggering a *recomputation of the metric but it has the disadvantage of returning *a value that may not be the one corresponding to the current parameters For *GUI update	purposes
Return Cached Values These method have the advantage of not triggering a *recomputation of the metric	value
Protected Types
typedef ReceptorMemberCommand< Self >	CommandType
typedef MultipleValuedVnlCostFunctionAdaptor	CostFunctionAdaptorType
Protected Member Functions
CostFunctionAdaptorType *	GetCostFunctionAdaptor (void)
const CostFunctionAdaptorType *	GetCostFunctionAdaptor (void) const
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor (void) const
	MultipleValuedNonLinearVnlOptimizer ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~MultipleValuedNonLinearVnlOptimizer ()
Protected Attributes
CostFunctionPointer	m_CostFunction
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_ScalesInitialized
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

typedef ReceptorMemberCommand< Self > itk::MultipleValuedNonLinearVnlOptimizer::CommandType [protected]

Command observer that will interact with the ITK-VNL cost-function adaptor in order to generate iteration events. This will allow to overcome the limitation of VNL optimizers not offering callbacks for every iteration Definition at line 102 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef SmartPointer<const Self> itk::MultipleValuedNonLinearVnlOptimizer::ConstPointer

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 44 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef MultipleValuedVnlCostFunctionAdaptor itk::MultipleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType [protected]

Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 88 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef CostFunctionType::Pointer itk::MultipleValuedNonLinearOptimizer::CostFunctionPointer [inherited]

Definition at line 45 of file itkMultipleValuedNonLinearOptimizer.h.

typedef MultipleValuedCostFunction itk::MultipleValuedNonLinearOptimizer::CostFunctionType [inherited]

Type of the Cost Function Reimplemented in itk::CumulativeGaussianOptimizer. Definition at line 44 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Array2D<double> itk::MultipleValuedNonLinearOptimizer::DerivativeType [inherited]

Derivative type. It defines a type used to return the cost function derivative. Here a bidimensional Array is used for Multivalued functions Definition at line 66 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Array<double> itk::MultipleValuedNonLinearOptimizer::MeasureType [inherited]

Measure type. It defines a type used to return the cost function value. Here an Array is used for Multivalued functions Reimplemented in itk::CumulativeGaussianOptimizer. Definition at line 61 of file itkMultipleValuedNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::MultipleValuedNonLinearVnlOptimizer::ParametersType

ParametersType typedef. It defines a position in the optimization search space. Reimplemented from itk::MultipleValuedNonLinearOptimizer. Definition at line 48 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef SmartPointer<Self> itk::MultipleValuedNonLinearVnlOptimizer::Pointer

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 43 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType [inherited]

Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range. Reimplemented from itk::Optimizer. Definition at line 52 of file itkNonLinearOptimizer.h.

typedef MultipleValuedNonLinearVnlOptimizer itk::MultipleValuedNonLinearVnlOptimizer::Self

Standard class typedefs. Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 41 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef MultipleValuedNonLinearOptimizer itk::MultipleValuedNonLinearVnlOptimizer::Superclass

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 42 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

Constructor & Destructor Documentation

itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer (   )  [protected]

virtual itk::MultipleValuedNonLinearVnlOptimizer::~MultipleValuedNonLinearVnlOptimizer (   )  [protected, virtual]

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual const ParametersType& itk::MultipleValuedNonLinearVnlOptimizer::GetCachedCurrentPosition (   )  [virtual]

virtual const DerivativeType& itk::MultipleValuedNonLinearVnlOptimizer::GetCachedDerivative (   )  [virtual]

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor (  void   )  [protected]

const CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor (  void   )  const [protected]

virtual const ParametersType& itk::Optimizer::GetCurrentPosition (   )  [virtual, inherited]

Get current position of the optimization.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

virtual const ParametersType& itk::Optimizer::GetInitialPosition (   )  [virtual, inherited]

Get the position to initialize the optimization.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

virtual const char* itk::MultipleValuedNonLinearVnlOptimizer::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer.

CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetNonConstCostFunctionAdaptor (  void   )  const [protected]

The purpose of this method is to get around the lack of const correctness in vnl cost_functions and optimizers

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

virtual const ScalesType& itk::Optimizer::GetScales (   )  [virtual, inherited]

Get current parameters scaling.

bool itk::MultipleValuedNonLinearVnlOptimizer::GetUseCostFunctionGradient (   )  const

Return Cached Values These method have the advantage of not triggering a* recomputation of the metric but it has the disadvantage of returning* a value that may not be the one corresponding to the current parameters For* GUI update this method is a good for mathematical* validation you should rather call itk::MultipleValuedNonLinearVnlOptimizer::GetValue (   )  const

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::MultipleValuedNonLinearOptimizer::New (   )  [static, inherited]

Method for creation through the object factory. Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::CumulativeGaussianOptimizer, and itk::LevenbergMarquardtOptimizer.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

void itk::MultipleValuedNonLinearVnlOptimizer::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

virtual void itk::MultipleValuedNonLinearOptimizer::SetCostFunction (  CostFunctionType *  costFunction  )  [virtual, inherited]

Set the cost function.

virtual void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunction (  MultipleValuedCostFunction *  costFunction  )  [pure virtual]

Set the cost Function. This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method Implemented in itk::LevenbergMarquardtOptimizer.

void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunctionAdaptor (  CostFunctionAdaptorType *  adaptor  )  [protected]

virtual void itk::Optimizer::SetCurrentPosition (  const ParametersType &  param  )  [protected, virtual, inherited]

Set the current position.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::Optimizer::SetInitialPosition (  const ParametersType &  param  )  [virtual, inherited]

Set the position to initialize the optimization.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

void itk::Optimizer::SetScales (  const ScalesType &  scales  )  [inherited]

Set current parameters scaling. Reimplemented in itk::LBFGSBOptimizer.

virtual void itk::Optimizer::StartOptimization (  void   )  [inline, virtual, inherited]

Start optimization. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::SPSAOptimizer. Definition at line 80 of file itkOptimizer.h.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOff (   )  [inline]

Definition at line 68 of file itkMultipleValuedNonLinearVnlOptimizer.h.

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOn (   )  [inline]

Definition at line 67 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

CostFunctionPointer itk::MultipleValuedNonLinearOptimizer::m_CostFunction [protected, inherited]

Definition at line 76 of file itkMultipleValuedNonLinearOptimizer.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

bool itk::Optimizer::m_ScalesInitialized [protected, inherited]

Definition at line 90 of file itkOptimizer.h.

Return Cached Values These method have the advantage of not triggering a* recomputation of the metric but it has the disadvantage of returning* a value that may not be the one corresponding to the current parameters For* GUI update this method is a good itk::MultipleValuedNonLinearVnlOptimizer::option

Definition at line 73 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

Return Cached Values These method have the advantage of not triggering a* recomputation of the metric but it has the disadvantage of returning* a value that may not be the one corresponding to the current parameters For* GUI update itk::MultipleValuedNonLinearVnlOptimizer::purposes

Definition at line 73 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Return Cached Values These method have the advantage of not triggering a* recomputation of the metric itk::MultipleValuedNonLinearVnlOptimizer::value

Definition at line 73 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

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

• itkMultipleValuedNonLinearVnlOptimizer.h

---