itk::QuaternionRigidTransformGradientDescentOptimizer Class Reference
[Numerics, Optimizers]
Implement a gradient descent optimizer. More...
#include <itkQuaternionRigidTransformGradientDescentOptimizer.h>
Detailed Description
Implement a gradient descent optimizer.
QuaternionRigidTransformGradientDescentOptimizer is an extension to the simple gradient descent optimizer implmented in GradientDescentOptimizer. At each iteration the current position is updated according to
p(n+1) = p(n) + learningRate * d f(p(n)) / d p(n)
![\[ p_{n+1} = p_n + \mbox{learningRate} \, \frac{\partial f(p_n) }{\partial p_n} \]](form_238.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. The first four components of p are assumed to be the four components of the quaternion. After each update, the quaternion is normalized to have a magnitude of one. This ensures the the transform is purely rigid.
- See also:
- GradientDescentOptimizer
Definition at line 50 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::QuaternionRigidTransformGradientDescentOptimizer::ConstPointer |
Reimplemented from itk::GradientDescentOptimizer.
Definition at line 58 of file itkQuaternionRigidTransformGradientDescentOptimizer.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 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.
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::QuaternionRigidTransformGradientDescentOptimizer::ParametersType |
Parameters type. It defines a position in the optimization search space.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Definition at line 65 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
Reimplemented from itk::GradientDescentOptimizer.
Definition at line 57 of file itkQuaternionRigidTransformGradientDescentOptimizer.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 QuaternionRigidTransformGradientDescentOptimizer itk::QuaternionRigidTransformGradientDescentOptimizer::Self |
Standard class typedefs.
Reimplemented from itk::GradientDescentOptimizer.
Definition at line 55 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
Reimplemented from itk::GradientDescentOptimizer.
Definition at line 56 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
Member Enumeration Documentation
enum itk::GradientDescentOptimizer::StopConditionType [inherited] |
Codes of stopping conditions
Definition at line 66 of file itkGradientDescentOptimizer.h.
Constructor & Destructor Documentation
| itk::QuaternionRigidTransformGradientDescentOptimizer::QuaternionRigidTransformGradientDescentOptimizer | ( | ) | [inline, protected] |
Definition at line 75 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
| virtual itk::QuaternionRigidTransformGradientDescentOptimizer::~QuaternionRigidTransformGradientDescentOptimizer | ( | ) | [inline, protected, virtual] |
Definition at line 76 of file itkQuaternionRigidTransformGradientDescentOptimizer.h.
Member Function Documentation
| unsigned long itk::Object::AddObserver | ( | const EventObject & | event, | |
| Command * | ||||
| ) | const [inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
| 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::QuaternionRigidTransformGradientDescentOptimizer::AdvanceOneStep | ( | void | ) | [virtual] |
Advance one step following the gradient direction.
Reimplemented from itk::GradientDescentOptimizer.
| 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.
Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::CreateObjectFunction< T >, itk::TransformFactoryBase, itk::AnalyzeImageIOFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Brains2MaskImageIOFactory, itk::DICOMImageIO2Factory, itk::DicomImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::JPEGImageIOFactory, itk::LSMImageIOFactory, itk::MetaImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::VTKImageIOFactory, itk::Bruker2DSEQImageIOFactory, itk::MatlabTransformIOFactory, itk::MINC2ImageIOFactory, itk::PhilipsRECImageIOFactory, itk::TxtTransformIOFactory, itk::VoxBoCUBImageIOFactory, and itk::SpatialObjectFactoryBase.
| 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 long itk::GradientDescentOptimizer::GetCurrentIteration | ( | ) | const [virtual, inherited] |
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] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
| virtual const DerivativeType& itk::GradientDescentOptimizer::GetGradient | ( | ) | [virtual, inherited] |
Get Gradient condition.
| virtual const ParametersType& itk::Optimizer::GetInitialPosition | ( | ) | [virtual, inherited] |
Get the position to initialize the optimization.
| virtual const double& itk::GradientDescentOptimizer::GetLearningRate | ( | ) | [virtual, inherited] |
Get the learning rate.
| virtual const bool& itk::GradientDescentOptimizer::GetMaximize | ( | ) | [virtual, inherited] |
Methods to configure the cost function.
| 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::GradientDescentOptimizer::GetMinimize | ( | ) | const [inline, inherited] |
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::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, 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::QuaternionRigidTransformGradientDescentOptimizer::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::GradientDescentOptimizer.
| virtual const unsigned long& itk::GradientDescentOptimizer::GetNumberOfIterations | ( | ) | [virtual, inherited] |
Get the number of iterations.
| 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 StopConditionType& itk::GradientDescentOptimizer::GetStopCondition | ( | ) | [virtual, inherited] |
Get Stop condition.
| const std::string itk::GradientDescentOptimizer::GetStopConditionDescription | ( | ) | const [virtual, inherited] |
Methods to configure the cost function.
Reimplemented from itk::Optimizer.
| 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, inherited] |
Get the current value.
| 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::GradientDescentOptimizer::MaximizeOff | ( | ) | [virtual, inherited] |
Methods to configure the cost function.
| virtual void itk::GradientDescentOptimizer::MaximizeOn | ( | ) | [virtual, inherited] |
Methods to configure the cost function.
| void itk::GradientDescentOptimizer::MinimizeOff | ( | ) | [inline, inherited] |
Methods to configure the cost function.
Definition at line 82 of file itkGradientDescentOptimizer.h.
| void itk::GradientDescentOptimizer::MinimizeOn | ( | ) | [inline, inherited] |
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::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, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.
Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().
| static Pointer itk::QuaternionRigidTransformGradientDescentOptimizer::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::GradientDescentOptimizer.
| 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] |
Define the type of the reference count according to the target. This allows the use of atomic operations
| bool itk::Object::PrintObservers | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, inherited] |
| void itk::GradientDescentOptimizer::PrintSelf | ( | 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.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
| 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 | ) | [inherited] |
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::Optimizer::SetInitialPosition | ( | const ParametersType & | param | ) | [virtual, inherited] |
Set the position to initialize the optimization.
| virtual void itk::GradientDescentOptimizer::SetLearningRate | ( | double | _arg | ) | [virtual, inherited] |
Set the learning rate.
| virtual void itk::GradientDescentOptimizer::SetMaximize | ( | bool | _arg | ) | [virtual, inherited] |
Methods to configure the cost function.
| void itk::Object::SetMetaDataDictionary | ( | const MetaDataDictionary & | rhs | ) | [inherited] |
- Returns:
- Set the MetaDataDictionary
| void itk::GradientDescentOptimizer::SetMinimize | ( | bool | v | ) | [inline, inherited] |
Methods to configure the cost function.
Definition at line 78 of file itkGradientDescentOptimizer.h.
| virtual void itk::GradientDescentOptimizer::SetNumberOfIterations | ( | unsigned long | _arg | ) | [virtual, inherited] |
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, inherited] |
Start optimization.
Reimplemented from itk::Optimizer.
| void itk::GradientDescentOptimizer::StopOptimization | ( | void | ) | [inherited] |
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.
Member Data Documentation
CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected, inherited] |
Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.
ParametersType itk::Optimizer::m_CurrentPosition [protected, inherited] |
Definition at line 98 of file itkOptimizer.h.
DerivativeType itk::GradientDescentOptimizer::m_Gradient [protected, inherited] |
Definition at line 133 of file itkGradientDescentOptimizer.h.
double itk::GradientDescentOptimizer::m_LearningRate [protected, inherited] |
Definition at line 135 of file itkGradientDescentOptimizer.h.
bool itk::GradientDescentOptimizer::m_Maximize [protected, inherited] |
Definition at line 134 of file itkGradientDescentOptimizer.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:
