#include <itkGradientDescentOptimizer.h>
Inheritance diagram for itk::GradientDescentOptimizer:
GradientDescentOptimizer implements a simple gradient descent optimizer. At each iteration the current position is updated according to
![\[ p_{n+1} = p_n + \mbox{learningRate} \, \frac{\partial f(p_n) }{\partial p_n} \]](form_207.png)
The learning rate is a fixed scalar defined via SetLearningRate(). The optimizer steps through a user defined number of iterations; no convergence checking is done.
Additionally, user can scale each component of the df / dp but setting a scaling vector using method SetScale().
Definition at line 48 of file itkGradientDescentOptimizer.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 GradientDescentOptimizer | Self |
| enum | StopConditionType { MaximumNumberOfIterations, MetricError } |
| typedef SingleValuedNonLinearOptimizer | Superclass |
Public Member Functions | |
| virtual void | AdvanceOneStep (void) |
| 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 unsigned int | GetCurrentIteration () const |
| virtual const ParametersType & | GetCurrentPosition () |
| bool | GetDebug () const |
| virtual const DerivativeType & | GetGradient () |
| virtual const ParametersType & | GetInitialPosition () |
| virtual const double & | GetLearningRate () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| virtual const unsigned long & | GetNumberOfIterations () |
| virtual int | GetReferenceCount () const |
| virtual const ScalesType & | GetScales () |
| virtual const StopConditionType & | GetStopCondition () |
| MeasureType | GetValue (const ParametersType ¶meters) const |
| virtual const double & | GetValue () |
| 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 ¶m) |
| virtual void | SetLearningRate (double _arg) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetNumberOfIterations (unsigned long _arg) |
| 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 const bool & | GetMaximize () |
| bool | GetMinimize () const |
| virtual void | MaximizeOff () |
| virtual void | MaximizeOn () |
| void | MinimizeOff () |
| void | MinimizeOn () |
| 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 Member Functions | |
| GradientDescentOptimizer () | |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | SetCurrentPosition (const ParametersType ¶m) |
| virtual | ~GradientDescentOptimizer () |
| virtual void | PrintHeader (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
Protected Attributes | |
| CostFunctionPointer | m_CostFunction |
| DerivativeType | m_Gradient |
| double | m_LearningRate |
| bool | m_Maximize |
| volatile int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| bool | m_ScalesInitialized |
| typedef SmartPointer<const Self> itk::GradientDescentOptimizer::ConstPointer |
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
Definition at line 56 of file itkGradientDescentOptimizer.h.
typedef CostFunctionType::Pointer itk::SingleValuedNonLinearOptimizer::CostFunctionPointer [inherited] |
Reimplemented in itk::FRPROptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer.
Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h.
typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType [inherited] |
Type of the Cost Function
Reimplemented in itk::FRPROptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer.
Definition at line 55 of file itkSingleValuedNonLinearOptimizer.h.
typedef CostFunctionType::DerivativeType itk::SingleValuedNonLinearOptimizer::DerivativeType [inherited] |
Derivative type. It defines a type used to return the cost function derivative.
Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h.
typedef CostFunctionType::MeasureType itk::SingleValuedNonLinearOptimizer::MeasureType [inherited] |
Measure type. It defines a type used to return the cost function value.
Definition at line 60 of file itkSingleValuedNonLinearOptimizer.h.
typedef Superclass::ParametersType itk::SingleValuedNonLinearOptimizer::ParametersType [inherited] |
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.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
Definition at line 55 of file itkGradientDescentOptimizer.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.
Standard class typedefs.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
Definition at line 53 of file itkGradientDescentOptimizer.h.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
Definition at line 54 of file itkGradientDescentOptimizer.h.
Codes of stopping conditions
Definition at line 66 of file itkGradientDescentOptimizer.h.
| itk::GradientDescentOptimizer::GradientDescentOptimizer | ( | ) | [protected] |
| virtual itk::GradientDescentOptimizer::~GradientDescentOptimizer | ( | ) | [inline, protected, virtual] |
Definition at line 127 of file itkGradientDescentOptimizer.h.
| 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::GradientDescentOptimizer::AdvanceOneStep | ( | void | ) | [virtual] |
Advance one step following the gradient direction.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
| 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::GradientDescentOptimizer::GetCurrentIteration | ( | ) | const [virtual] |
Get the current iteration number.
| 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 DerivativeType& itk::GradientDescentOptimizer::GetGradient | ( | ) | [virtual] |
Get Stop condition.
| virtual const ParametersType& itk::Optimizer::GetInitialPosition | ( | ) | [virtual, inherited] |
Get the position to initialize the optimization.
| virtual const double& itk::GradientDescentOptimizer::GetLearningRate | ( | ) | [virtual] |
Get the learning rate.
| virtual const bool& itk::GradientDescentOptimizer::GetMaximize | ( | ) | [virtual] |
Methods to configure the cost function.
| const MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | const [inherited] |
| MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | [inherited] |
| bool itk::GradientDescentOptimizer::GetMinimize | ( | ) | const [inline] |
Methods to configure the cost function.
Definition at line 76 of file itkGradientDescentOptimizer.h.
| 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::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::GradientDescentOptimizer::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
| virtual const unsigned long& itk::GradientDescentOptimizer::GetNumberOfIterations | ( | ) | [virtual] |
Get the number of iterations.
| 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.
| virtual const StopConditionType& itk::GradientDescentOptimizer::GetStopCondition | ( | ) | [virtual] |
Get Stop condition.
| MeasureType itk::SingleValuedNonLinearOptimizer::GetValue | ( | const ParametersType & | parameters | ) | const [inherited] |
Get the cost function value at the given parameters.
Reimplemented in itk::SPSAOptimizer.
| virtual const double& itk::GradientDescentOptimizer::GetValue | ( | ) | [virtual] |
Get the current value.
| static void itk::Object::GlobalWarningDisplayOff | ( | ) | [inline, static, inherited] |
| static void itk::Object::GlobalWarningDisplayOn | ( | ) | [inline, static, inherited] |
| 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::GradientDescentOptimizer::MaximizeOff | ( | ) | [virtual] |
Methods to configure the cost function.
| virtual void itk::GradientDescentOptimizer::MaximizeOn | ( | ) | [virtual] |
Methods to configure the cost function.
| void itk::GradientDescentOptimizer::MinimizeOff | ( | ) | [inline] |
Methods to configure the cost function.
Definition at line 82 of file itkGradientDescentOptimizer.h.
| void itk::GradientDescentOptimizer::MinimizeOn | ( | ) | [inline] |
Methods to configure the cost function.
Definition at line 80 of file itkGradientDescentOptimizer.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::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 > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.
Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), 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::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().
| static Pointer itk::GradientDescentOptimizer::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< itk::ProcessObject >::Print().
| 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::GradientDescentOptimizer::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::GradientDescentOptimizer::ResumeOptimization | ( | void | ) |
Resume previously stopped optimization with current parameters
| 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::Optimizer::SetInitialPosition | ( | const ParametersType & | param | ) | [virtual, inherited] |
Set the position to initialize the optimization.
| virtual void itk::GradientDescentOptimizer::SetLearningRate | ( | double | _arg | ) | [virtual] |
Set the learning rate.
| virtual void itk::GradientDescentOptimizer::SetMaximize | ( | bool | _arg | ) | [virtual] |
Methods to configure the cost function.
| void itk::Object::SetMetaDataDictionary | ( | const MetaDataDictionary & | rhs | ) | [inherited] |
| void itk::GradientDescentOptimizer::SetMinimize | ( | bool | v | ) | [inline] |
Methods to configure the cost function.
Definition at line 78 of file itkGradientDescentOptimizer.h.
| virtual void itk::GradientDescentOptimizer::SetNumberOfIterations | ( | unsigned long | _arg | ) | [virtual] |
Set the number of iterations.
| 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.
| void itk::GradientDescentOptimizer::StartOptimization | ( | void | ) | [virtual] |
Start optimization.
Reimplemented from itk::Optimizer.
| void itk::GradientDescentOptimizer::StopOptimization | ( | void | ) |
Stop optimization.
| virtual void itk::Object::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.
CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected, inherited] |
Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.
Definition at line 132 of file itkGradientDescentOptimizer.h.
double itk::GradientDescentOptimizer::m_LearningRate [protected] |
Definition at line 134 of file itkGradientDescentOptimizer.h.
bool itk::GradientDescentOptimizer::m_Maximize [protected] |
Definition at line 133 of file itkGradientDescentOptimizer.h.
volatile 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.
1.5.1 written by Dimitri van Heesch,
© 1997-2000