Implement a gradient descent optimizer. More...
#include <itkRegularStepGradientDescentBaseOptimizer.h>
Implement a gradient descent optimizer.
Definition at line 30 of file itkRegularStepGradientDescentBaseOptimizer.h.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.
Definition at line 38 of file itkRegularStepGradientDescentBaseOptimizer.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::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::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.
Definition at line 37 of file itkRegularStepGradientDescentBaseOptimizer.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 "Self" typedef.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.
Definition at line 35 of file itkRegularStepGradientDescentBaseOptimizer.h.
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::RegularStepGradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.
Definition at line 36 of file itkRegularStepGradientDescentBaseOptimizer.h.
Codes of stopping conditions.
GradientMagnitudeTolerance | |
StepTooSmall | |
ImageNotAvailable | |
CostFunctionError | |
MaximumNumberOfIterations | |
Unknown |
Definition at line 49 of file itkRegularStepGradientDescentBaseOptimizer.h.
itk::RegularStepGradientDescentBaseOptimizer::RegularStepGradientDescentBaseOptimizer | ( | ) | [protected] |
virtual itk::RegularStepGradientDescentBaseOptimizer::~RegularStepGradientDescentBaseOptimizer | ( | ) | [inline, protected, virtual] |
Definition at line 106 of file itkRegularStepGradientDescentBaseOptimizer.h.
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
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
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.
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::MRCImageIOFactory, itk::PhilipsRECImageIOFactory, itk::TxtTransformIOFactory, itk::VoxBoCUBImageIOFactory, itk::VTKImageIO2Factory, 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 int itk::RegularStepGradientDescentBaseOptimizer::GetCurrentIteration | ( | ) | const [virtual] |
Set/Get parameters to control the optimization process.
virtual const ParametersType& itk::Optimizer::GetCurrentPosition | ( | ) | [virtual, inherited] |
Get current position of the optimization.
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetCurrentStepLength | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
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::RegularStepGradientDescentBaseOptimizer::GetGradient | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetGradientMagnitudeTolerance | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
virtual const ParametersType& itk::Optimizer::GetInitialPosition | ( | ) | [virtual, inherited] |
Get the position to initialize the optimization.
virtual const bool& itk::RegularStepGradientDescentBaseOptimizer::GetMaximize | ( | ) | [virtual] |
Specify whether to minimize or maximize the cost function.
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMaximumStepLength | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
const MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | const [inherited] |
MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | [inherited] |
bool itk::RegularStepGradientDescentBaseOptimizer::GetMinimize | ( | ) | const [inline] |
Specify whether to minimize or maximize the cost function.
Definition at line 62 of file itkRegularStepGradientDescentBaseOptimizer.h.
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMinimumStepLength | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
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, 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::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] |
Set/Get parameters to control the optimization process.
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] |
Set/Get parameters to control the optimization process.
virtual const ScalesType& itk::Optimizer::GetScales | ( | ) | [virtual, inherited] |
Get current parameters scaling.
virtual const StopConditionType& itk::RegularStepGradientDescentBaseOptimizer::GetStopCondition | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
virtual const std::string itk::RegularStepGradientDescentBaseOptimizer::GetStopConditionDescription | ( | ) | const [virtual] |
Get the reason for termination
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 MeasureType& itk::RegularStepGradientDescentBaseOptimizer::GetValue | ( | ) | [virtual] |
Set/Get parameters to control the optimization process.
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 & | ) | [inherited] |
Call Execute on all the Commands observing this event id.
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.
virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOff | ( | ) | [virtual] |
Specify whether to minimize or maximize the cost function.
virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOn | ( | ) | [virtual] |
Specify whether to minimize or maximize the cost function.
void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOff | ( | void | ) | [inline] |
Specify whether to minimize or maximize the cost function.
Definition at line 68 of file itkRegularStepGradientDescentBaseOptimizer.h.
void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOn | ( | void | ) | [inline] |
Specify whether to minimize or maximize the cost function.
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, 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, 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::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] |
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] |
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.
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] |
Set/Get parameters to control the optimization process.
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] |
void itk::RegularStepGradientDescentBaseOptimizer::SetMinimize | ( | bool | v | ) | [inline] |
Specify whether to minimize or maximize the cost function.
Definition at line 64 of file itkRegularStepGradientDescentBaseOptimizer.h.
virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMinimumStepLength | ( | double | _arg | ) | [virtual] |
Set/Get parameters to control the optimization process.
virtual void itk::RegularStepGradientDescentBaseOptimizer::SetNumberOfIterations | ( | unsigned long | _arg | ) | [virtual] |
Set/Get parameters to control the optimization process.
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] |
Set/Get parameters to control the optimization process.
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
Definition at line 119 of file itkRegularStepGradientDescentBaseOptimizer.h.
void itk::RegularStepGradientDescentBaseOptimizer::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.
unsigned long itk::RegularStepGradientDescentBaseOptimizer::m_CurrentIteration [protected] |
Definition at line 148 of file itkRegularStepGradientDescentBaseOptimizer.h.
ParametersType itk::Optimizer::m_CurrentPosition [protected, inherited] |
Definition at line 98 of file itkOptimizer.h.
double itk::RegularStepGradientDescentBaseOptimizer::m_CurrentStepLength [protected] |
Definition at line 144 of file itkRegularStepGradientDescentBaseOptimizer.h.
Definition at line 135 of file itkRegularStepGradientDescentBaseOptimizer.h.
double itk::RegularStepGradientDescentBaseOptimizer::m_GradientMagnitudeTolerance [protected] |
Definition at line 141 of file itkRegularStepGradientDescentBaseOptimizer.h.
bool itk::RegularStepGradientDescentBaseOptimizer::m_Maximize [protected] |
Definition at line 139 of file itkRegularStepGradientDescentBaseOptimizer.h.
double itk::RegularStepGradientDescentBaseOptimizer::m_MaximumStepLength [protected] |
Definition at line 142 of file itkRegularStepGradientDescentBaseOptimizer.h.
double itk::RegularStepGradientDescentBaseOptimizer::m_MinimumStepLength [protected] |
Definition at line 143 of file itkRegularStepGradientDescentBaseOptimizer.h.
unsigned long itk::RegularStepGradientDescentBaseOptimizer::m_NumberOfIterations [protected] |
Definition at line 147 of file itkRegularStepGradientDescentBaseOptimizer.h.
Definition at line 136 of file itkRegularStepGradientDescentBaseOptimizer.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.
double itk::RegularStepGradientDescentBaseOptimizer::m_RelaxationFactor [protected] |
Definition at line 145 of file itkRegularStepGradientDescentBaseOptimizer.h.
bool itk::Optimizer::m_ScalesInitialized [protected, inherited] |
Definition at line 93 of file itkOptimizer.h.
bool itk::RegularStepGradientDescentBaseOptimizer::m_Stop [protected] |
Definition at line 138 of file itkRegularStepGradientDescentBaseOptimizer.h.
Definition at line 146 of file itkRegularStepGradientDescentBaseOptimizer.h.
Definition at line 149 of file itkRegularStepGradientDescentBaseOptimizer.h.
Definition at line 140 of file itkRegularStepGradientDescentBaseOptimizer.h.