Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::RegularStepGradientDescentBaseOptimizer Class Reference
[NumericsOptimizers]

#include <itkRegularStepGradientDescentBaseOptimizer.h>

Inheritance diagram for itk::RegularStepGradientDescentBaseOptimizer:

Inheritance graph
[legend]
Collaboration diagram for itk::RegularStepGradientDescentBaseOptimizer:

Collaboration graph
[legend]

List of all members.


Detailed Description

Implement a gradient descent optimizer.

Definition at line 30 of file itkRegularStepGradientDescentBaseOptimizer.h.


Public Types

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 Superclass::ScalesType ScalesType
typedef
RegularStepGradientDescentBaseOptimizer 
Self
enum  StopConditionType {
  GradientMagnitudeTolerance = 1,
  StepTooSmall = 2,
  ImageNotAvailable = 3,
  CostFunctionError = 4,
  MaximumNumberOfIterations = 5,
  Unknown = 6
}
typedef
SingleValuedNonLinearOptimizer 
Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
CommandGetCommand (unsigned long tag)
virtual const CostFunctionTypeGetCostFunction ()
virtual const ParametersTypeGetCurrentPosition ()
bool GetDebug () const
virtual const ParametersTypeGetInitialPosition ()
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
virtual const ScalesTypeGetScales ()
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)
void ResumeOptimization (void)
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)
void StartOptimization (void)
void StopOptimization (void)
virtual void UnRegister () const
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
virtual unsigned int GetCurrentIteration () const
virtual const double & GetCurrentStepLength ()
virtual const DerivativeTypeGetGradient ()
virtual const double & GetGradientMagnitudeTolerance ()
virtual const double & GetMaximumStepLength ()
virtual const double & GetMinimumStepLength ()
virtual const unsigned long & GetNumberOfIterations ()
virtual const double & GetRelaxationFactor ()
virtual const StopConditionTypeGetStopCondition ()
virtual const MeasureTypeGetValue ()
virtual void SetGradientMagnitudeTolerance (double _arg)
virtual void SetMaximumStepLength (double _arg)
virtual void SetMinimumStepLength (double _arg)
virtual void SetNumberOfIterations (unsigned long _arg)
virtual void SetRelaxationFactor (double _arg)
virtual const bool & GetMaximize ()
bool GetMinimize () const
virtual void MaximizeOff ()
virtual void MaximizeOn ()
void MinimizeOff (void)
void MinimizeOn (void)
virtual void SetMaximize (bool _arg)
void SetMinimize (bool v)

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

virtual void AdvanceOneStep (void)
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
 RegularStepGradientDescentBaseOptimizer ()
virtual void SetCurrentPosition (const ParametersType &param)
virtual ~RegularStepGradientDescentBaseOptimizer ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual void StepAlongGradient (double, const DerivativeType &)

Protected Attributes

CostFunctionPointer m_CostFunction
unsigned long m_CurrentIteration
ParametersType m_CurrentPosition
double m_CurrentStepLength
DerivativeType m_Gradient
double m_GradientMagnitudeTolerance
bool m_Maximize
double m_MaximumStepLength
double m_MinimumStepLength
unsigned long m_NumberOfIterations
DerivativeType m_PreviousGradient
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
double m_RelaxationFactor
bool m_ScalesInitialized
bool m_Stop
StopConditionType m_StopCondition
MeasureType m_Value

Member Typedef Documentation

Derivative type. It defines a type used to return the cost function derivative.

Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

Measure type. It defines a type used to return the cost function value.

Definition at line 60 of file itkSingleValuedNonLinearOptimizer.h.

Parameters type. It defines a position in the optimization search space.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::AmoebaOptimizer, itk::FRPROptimizer, itk::PowellOptimizer, and itk::QuaternionRigidTransformGradientDescentOptimizer.

Definition at line 48 of file itkSingleValuedNonLinearOptimizer.h.

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.


Member Enumeration Documentation

Codes of stopping conditions.

Enumerator:
GradientMagnitudeTolerance 
StepTooSmall 
ImageNotAvailable 
CostFunctionError 
MaximumNumberOfIterations 
Unknown 

Definition at line 49 of file itkRegularStepGradientDescentBaseOptimizer.h.


Constructor & Destructor Documentation

itk::RegularStepGradientDescentBaseOptimizer::RegularStepGradientDescentBaseOptimizer (  )  [protected]

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


Member Function Documentation

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

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

virtual void itk::RegularStepGradientDescentBaseOptimizer::AdvanceOneStep ( void   )  [protected, virtual]

Advance one step following the gradient direction This method verifies if a change in direction is required and if a reduction in steplength is required.

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, inherited]

Get the cost function.

virtual unsigned int itk::RegularStepGradientDescentBaseOptimizer::GetCurrentIteration (  )  const [virtual]

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

Get current position of the optimization.

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetCurrentStepLength (  )  [virtual]

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

Get the value of the debug flag.

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

virtual const DerivativeType& itk::RegularStepGradientDescentBaseOptimizer::GetGradient (  )  [virtual]

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetGradientMagnitudeTolerance (  )  [virtual]

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

Get the position to initialize the optimization.

virtual const bool& itk::RegularStepGradientDescentBaseOptimizer::GetMaximize (  )  [virtual]

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMaximumStepLength (  )  [virtual]

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.

bool itk::RegularStepGradientDescentBaseOptimizer::GetMinimize (  )  const [inline]

Definition at line 62 of file itkRegularStepGradientDescentBaseOptimizer.h.

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMinimumStepLength (  )  [virtual]

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

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

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

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

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Reimplemented in itk::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

virtual const unsigned long& itk::RegularStepGradientDescentBaseOptimizer::GetNumberOfIterations (  )  [virtual]

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 double& itk::RegularStepGradientDescentBaseOptimizer::GetRelaxationFactor (  )  [virtual]

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

Get current parameters scaling.

virtual const StopConditionType& itk::RegularStepGradientDescentBaseOptimizer::GetStopCondition (  )  [virtual]

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType parameters  )  const [inherited]

Get the cost function value at the given parameters.

Reimplemented in itk::SPSAOptimizer.

virtual const MeasureType& itk::RegularStepGradientDescentBaseOptimizer::GetValue (  )  [virtual]

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::RegularStepGradientDescentBaseOptimizer::MaximizeOff (  )  [virtual]

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOn (  )  [virtual]

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOff ( void   )  [inline]

Definition at line 68 of file itkRegularStepGradientDescentBaseOptimizer.h.

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOn ( void   )  [inline]

Definition at line 66 of file itkRegularStepGradientDescentBaseOptimizer.h.

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.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, itk::RankImageFilter< TInputImage, TInputImage, itk::FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::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::RegularStepGradientDescentBaseOptimizer::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Reimplemented in itk::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

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

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

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

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

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.

void itk::RegularStepGradientDescentBaseOptimizer::ResumeOptimization ( void   ) 

Resume previously stopped optimization with current parameters.

See also:
StopOptimization

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

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::RegularStepGradientDescentBaseOptimizer::SetGradientMagnitudeTolerance ( double  _arg  )  [virtual]

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

Set the position to initialize the optimization.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximize ( bool  _arg  )  [virtual]

Specify whether to minimize or maximize the cost function.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximumStepLength ( double  _arg  )  [virtual]

Set/Get parameters to control the optimization process.

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

Returns:
Set the MetaDataDictionary

void itk::RegularStepGradientDescentBaseOptimizer::SetMinimize ( bool  v  )  [inline]

Definition at line 64 of file itkRegularStepGradientDescentBaseOptimizer.h.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMinimumStepLength ( double  _arg  )  [virtual]

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetNumberOfIterations ( unsigned long  _arg  )  [virtual]

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetRelaxationFactor ( double  _arg  )  [virtual]

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

Set current parameters scaling.

void itk::RegularStepGradientDescentBaseOptimizer::StartOptimization ( void   )  [virtual]

Start optimization.

Reimplemented from itk::Optimizer.

virtual void itk::RegularStepGradientDescentBaseOptimizer::StepAlongGradient ( double  ,
const DerivativeType  
) [inline, protected, virtual]

Advance one step along the corrected gradient taking into account the steplength represented by factor. This method is invoked by AdvanceOneStep. It is expected to be overrided by optimization methods in non-vector spaces

See also:
AdvanceOneStep

Definition at line 117 of file itkRegularStepGradientDescentBaseOptimizer.h.

void itk::RegularStepGradientDescentBaseOptimizer::StopOptimization ( void   ) 

Stop optimization.

See also:
ResumeOptimization

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().


Member Data Documentation

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

Definition at line 95 of file itkOptimizer.h.

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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 90 of file itkOptimizer.h.


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

Generated at Thu May 28 17:03:48 2009 for ITK by doxygen 1.5.5 written by Dimitri van Heesch, © 1997-2000