itk::SingleValuedNonLinearOptimizer Class Reference
[Numerics, Optimizers]

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.

Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( ) [protected]

virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( ) [inline, protected, virtual]

Definition at line 77 of file itkSingleValuedNonLinearOptimizer.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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.

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.

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction ( ) [virtual]

Get the cost function.

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]

This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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

Run-time type information (and related methods).

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

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

Get current parameters scaling.

virtual const std::string itk::Optimizer::GetStopConditionDescription ( ) const [virtual, inherited]

Get the reason for termination

Reimplemented in itk::AmoebaOptimizer, itk::CumulativeGaussianOptimizer, itk::ExhaustiveOptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::SPSAOptimizer.

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType & parameters ) const

Get the cost function value at the given parameters.

Reimplemented in itk::SPSAOptimizer.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::SingleValuedNonLinearOptimizer::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

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

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.

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

void itk::SingleValuedNonLinearOptimizer::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::Optimizer.

Reimplemented in itk::AmoebaOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::SingleValuedNonLinearVnlOptimizer, and itk::SPSAOptimizer.

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

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.

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::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType * costFunction ) [virtual]

Set the cost function.

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.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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.

Member Data Documentation

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected]

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

ParametersType itk::Optimizer::m_CurrentPosition [protected, inherited]

Definition at line 98 of file itkOptimizer.h.

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

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

Definition at line 93 of file itkOptimizer.h.

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

itkSingleValuedNonLinearOptimizer.h


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::DerivativeType	DerivativeType
typedef CostFunctionType::MeasureType	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef SingleValuedNonLinearOptimizer	Self
typedef NonLinearOptimizer	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual const CostFunctionType *	GetCostFunction ()
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 ()
virtual const std::string	GetStopConditionDescription () const
MeasureType	GetValue (const ParametersType &parameters) const
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)
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

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetCurrentPosition (const ParametersType &param)
	SingleValuedNonLinearOptimizer ()
virtual	~SingleValuedNonLinearOptimizer ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
CostFunctionPointer	m_CostFunction
ParametersType	m_CurrentPosition
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_ScalesInitialized

itk::SingleValuedNonLinearOptimizer Class Reference [Numerics, Optimizers]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::SingleValuedNonLinearOptimizer Class Reference
[Numerics, Optimizers]