Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

itk::FRPROptimizer Class Reference
[NumericsOptimizers]

Implements Fletch-Reeves & Polak-Ribiere optimization using dBrent line search. More...

#include <itkFRPROptimizer.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef CostFunctionType::Pointer CostFunctionPointer
typedef SingleValuedCostFunction CostFunctionType
typedef
CostFunctionType::DerivativeType 
DerivativeType
typedef
CostFunctionType::MeasureType 
MeasureType
typedef
SingleValuedNonLinearOptimizer::ParametersType 
ParametersType
typedef SmartPointer< SelfPointer
typedef Superclass::ScalesType ScalesType
typedef FRPROptimizer Self
typedef PowellOptimizer Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual const bool & GetCatchGetValueException ()
CommandGetCommand (unsigned long tag)
virtual const CostFunctionTypeGetCostFunction ()
virtual const unsigned int & GetCurrentIteration ()
virtual const unsigned int & GetCurrentLineIteration ()
virtual const ParametersTypeGetCurrentPosition ()
bool GetDebug () const
virtual const ParametersTypeGetInitialPosition ()
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual const double & GetMetricWorstPossibleValue ()
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
virtual const ScalesTypeGetScales ()
const std::string GetStopConditionDescription () const
MeasureType GetValue (const ParametersType &parameters) const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
virtual void SetCatchGetValueException (bool _arg)
virtual void SetCostFunction (CostFunctionType *costFunction)
void SetDebug (bool debugFlag) const
virtual void SetInitialPosition (const ParametersType &param)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetMetricWorstPossibleValue (double _arg)
virtual void SetReferenceCount (int)
void SetScales (const ScalesType &scales)
void SetToFletchReeves ()
void SetToPolakRibiere ()
void StartOptimization ()
void StopOptimization ()
virtual void UnRegister () const

virtual void SetUseUnitLengthGradient (bool _arg)
virtual bool GetUseUnitLengthGradient () const

virtual void SetMaximize (bool _arg)
virtual void MaximizeOn ()
virtual void MaximizeOff ()
virtual const bool & GetMaximize ()

virtual void SetMaximumIteration (unsigned int _arg)
virtual const unsigned int & GetMaximumIteration ()

virtual void SetMaximumLineIteration (unsigned int _arg)
virtual unsigned int GetMaximumLineIteration () const

virtual void SetStepLength (double _arg)
virtual const double & GetStepLength ()

virtual void SetStepTolerance (double _arg)
virtual const double & GetStepTolerance ()

virtual void SetValueTolerance (double _arg)
virtual const double & GetValueTolerance ()

virtual const MeasureTypeGetCurrentCost ()
MeasureType GetValue () const

unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()

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

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

virtual void BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal)
virtual void BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal, ParametersType &tempCoord)
 FRPROptimizer ()
double GetLineValue (double x) const
double GetLineValue (double x, ParametersType &tempCoord) const
virtual unsigned int GetSpaceDimension ()
virtual bool GetStop ()
virtual void GetValueAndDerivative (ParametersType &p, double *val, ParametersType *xi)
virtual void LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc)
virtual void LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc, ParametersType &tempCoord)
virtual void LineOptimize (ParametersType *p, ParametersType &xi, double *val)
virtual void LineOptimize (ParametersType *p, ParametersType &xi, double *val, ParametersType &tempCoord)
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void SetCurrentCost (double _arg)
virtual void SetCurrentIteration (unsigned int _arg)
void SetCurrentLinePoint (double x, double fx)
virtual void SetCurrentPosition (const ParametersType &param)
void SetLine (const ParametersType &origin, const vnl_vector< double > &direction)
void SetSpaceDimension (unsigned int dim)
virtual void SetStop (bool _arg)
void Shift (double *a, double *b, double *c, double d) const
void Swap (double *a, double *b) const
virtual ~FRPROptimizer ()

virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

CostFunctionPointer m_CostFunction
ParametersType m_CurrentPosition
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
bool m_ScalesInitialized

Detailed Description

Implements Fletch-Reeves & Polak-Ribiere optimization using dBrent line search.

This optimizer needs a cost function. This optimizer needs to be able to compute partial derivatives of the cost function with respect to each parameter.

The SetStepLength determines the initial distance to step in a line direction when bounding the minimum (using bracketing triple spaced using a derivative-based search strategy).

The StepTolerance terminates optimization when the parameter values are known to be within this (scaled) distance of the local extreme.

The ValueTolerance terminates optimization when the cost function values at the current parameters and at the local extreme are likely (within a second order approximation) to be within this is tolerance.

Definition at line 50 of file itkFRPROptimizer.h.


Member Typedef Documentation

Reimplemented from itk::PowellOptimizer.

Definition at line 58 of file itkFRPROptimizer.h.

Reimplemented from itk::PowellOptimizer.

Definition at line 70 of file itkFRPROptimizer.h.

Type of the Cost Function

Reimplemented from itk::PowellOptimizer.

Definition at line 66 of file itkFRPROptimizer.h.

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::PowellOptimizer.

Definition at line 60 of file itkFRPROptimizer.h.

Reimplemented from itk::PowellOptimizer.

Definition at line 57 of file itkFRPROptimizer.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.

Standard "Self" typedef.

Reimplemented from itk::PowellOptimizer.

Definition at line 55 of file itkFRPROptimizer.h.

Reimplemented from itk::PowellOptimizer.

Definition at line 56 of file itkFRPROptimizer.h.


Constructor & Destructor Documentation

itk::FRPROptimizer::FRPROptimizer (  )  [protected]
virtual itk::FRPROptimizer::~FRPROptimizer (  )  [protected, virtual]

Member Function Documentation

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::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal 
) [protected, virtual, inherited]

Given a bracketing triple of points and their function values, returns a bounded extreme. These values are in parameter space, along the current line and wrt the current origin set via SetLine. Optimization terminates based on MaximumIteration, StepTolerance, or ValueTolerance. Implemented as Brent line optimers from NRC.

virtual void itk::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal,
ParametersType tempCoord 
) [protected, virtual, inherited]
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]
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.

virtual const bool& itk::PowellOptimizer::GetCatchGetValueException (  )  [virtual, inherited]
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 const MeasureType& itk::PowellOptimizer::GetCurrentCost (  )  [virtual, inherited]

Return Current Value

virtual const unsigned int& itk::PowellOptimizer::GetCurrentIteration (  )  [virtual, inherited]

Return Current Iteration

virtual const unsigned int& itk::PowellOptimizer::GetCurrentLineIteration (  )  [virtual, inherited]

Get the current line search iteration

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

Get current position of the optimization.

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

Get the value of the debug flag.

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

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

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

Get the position to initialize the optimization.

double itk::PowellOptimizer::GetLineValue ( double  x  )  const [protected, inherited]

Get the value of the n-dimensional cost function at this scalar step distance along the current line direction from the current line origin. Line origin and distances are set via SetLine

double itk::PowellOptimizer::GetLineValue ( double  x,
ParametersType tempCoord 
) const [protected, inherited]
virtual const bool& itk::PowellOptimizer::GetMaximize (  )  [virtual, inherited]

Set if the Optimizer should Maximize the metric

virtual const unsigned int& itk::PowellOptimizer::GetMaximumIteration (  )  [virtual, inherited]

Set/Get maximum iteration limit.

virtual unsigned int itk::PowellOptimizer::GetMaximumLineIteration (  )  const [virtual, inherited]

Set/Get the maximum number of line search iterations

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]
Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.
const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]
Returns:
A constant reference to this objects MetaDataDictionary.
virtual const double& itk::PowellOptimizer::GetMetricWorstPossibleValue (  )  [virtual, inherited]
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::FRPROptimizer::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::PowellOptimizer.

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 unsigned int itk::PowellOptimizer::GetSpaceDimension (  )  [protected, virtual, inherited]
virtual const double& itk::PowellOptimizer::GetStepLength (  )  [virtual, inherited]

Set/Get StepLength for the (scaled) spacing of the sampling of parameter space while bracketing the extremum

virtual const double& itk::PowellOptimizer::GetStepTolerance (  )  [virtual, inherited]

Set/Get StepTolerance. Once the local extreme is known to be within this distance of the current parameter values, optimization terminates

virtual bool itk::PowellOptimizer::GetStop (  )  [protected, virtual, inherited]
const std::string itk::PowellOptimizer::GetStopConditionDescription (  )  const [virtual, inherited]

Get the reason for termination

Reimplemented from itk::Optimizer.

virtual bool itk::FRPROptimizer::GetUseUnitLengthGradient (  )  const [virtual]

Convert gradient to a unit length vector

MeasureType itk::PowellOptimizer::GetValue ( void   )  const [inline, inherited]

Return Current Value

Definition at line 120 of file itkPowellOptimizer.h.

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

Get the cost function value at the given parameters.

Reimplemented in itk::SPSAOptimizer.

virtual void itk::FRPROptimizer::GetValueAndDerivative ( ParametersType p,
double *  val,
ParametersType xi 
) [protected, virtual]

Get the value of the n-dimensional cost function at this scalar step distance along the current line direction from the current line origin. Line origin and distances are set via SetLine

virtual const double& itk::PowellOptimizer::GetValueTolerance (  )  [virtual, inherited]

Set/Get ValueTolerance. Once this current cost function value is known to be within this tolerance of the cost function value at the local extreme, optimization terminates

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::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc 
) [protected, virtual, inherited]

The LineBracket routine from NRC. Later reimplemented from the description of the method available in the Wikipedia.

Uses current origin and line direction (from SetLine) to find a triple of points (ax, bx, cx) that bracket the extreme "near" the origin. Search first considers the point StepLength distance from ax.

IMPORTANT: The value of ax and the value of the function at ax (i.e., fa), must both be provided to this function.

virtual void itk::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc,
ParametersType tempCoord 
) [protected, virtual, inherited]
virtual void itk::FRPROptimizer::LineOptimize ( ParametersType p,
ParametersType xi,
double *  val 
) [protected, virtual]
virtual void itk::FRPROptimizer::LineOptimize ( ParametersType p,
ParametersType xi,
double *  val,
ParametersType tempCoord 
) [protected, virtual]
virtual void itk::PowellOptimizer::MaximizeOff (  )  [virtual, inherited]

Set if the Optimizer should Maximize the metric

virtual void itk::PowellOptimizer::MaximizeOn (  )  [virtual, inherited]

Set if the Optimizer should Maximize the metric

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::FRPROptimizer::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::PowellOptimizer.

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

Cause the object to print itself out.

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

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]
void itk::FRPROptimizer::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::PowellOptimizer.

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

virtual void itk::PowellOptimizer::SetCatchGetValueException ( bool  _arg  )  [virtual, inherited]
virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType costFunction  )  [virtual, inherited]

Set the cost function.

virtual void itk::PowellOptimizer::SetCurrentCost ( double  _arg  )  [protected, virtual, inherited]
virtual void itk::PowellOptimizer::SetCurrentIteration ( unsigned int  _arg  )  [protected, virtual, inherited]
void itk::PowellOptimizer::SetCurrentLinePoint ( double  x,
double  fx 
) [protected, inherited]

Set the given scalar step distance (x) and function value (fx) as the "best-so-far" optimizer values.

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

Set the current position.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

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

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

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

Set the position to initialize the optimization.

void itk::PowellOptimizer::SetLine ( const ParametersType origin,
const vnl_vector< double > &  direction 
) [protected, inherited]

Used to specify the line direction through the n-dimensional parameter space the is currently being bracketed and optimized.

virtual void itk::PowellOptimizer::SetMaximize ( bool  _arg  )  [virtual, inherited]

Set if the Optimizer should Maximize the metric

virtual void itk::PowellOptimizer::SetMaximumIteration ( unsigned int  _arg  )  [virtual, inherited]

Set/Get maximum iteration limit.

virtual void itk::PowellOptimizer::SetMaximumLineIteration ( unsigned int  _arg  )  [virtual, inherited]

Set/Get the maximum number of line search iterations

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]
Returns:
Set the MetaDataDictionary
virtual void itk::PowellOptimizer::SetMetricWorstPossibleValue ( double  _arg  )  [virtual, inherited]
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::PowellOptimizer::SetSpaceDimension ( unsigned int  dim  )  [inline, protected, inherited]

Definition at line 209 of file itkPowellOptimizer.h.

virtual void itk::PowellOptimizer::SetStepLength ( double  _arg  )  [virtual, inherited]

Set/Get StepLength for the (scaled) spacing of the sampling of parameter space while bracketing the extremum

virtual void itk::PowellOptimizer::SetStepTolerance ( double  _arg  )  [virtual, inherited]

Set/Get StepTolerance. Once the local extreme is known to be within this distance of the current parameter values, optimization terminates

virtual void itk::PowellOptimizer::SetStop ( bool  _arg  )  [protected, virtual, inherited]
void itk::FRPROptimizer::SetToFletchReeves (  ) 

Set it to the Fletch-Reeves optimizer

void itk::FRPROptimizer::SetToPolakRibiere (  ) 

Set it to the Fletch-Reeves optimizer

virtual void itk::FRPROptimizer::SetUseUnitLengthGradient ( bool  _arg  )  [virtual]

Convert gradient to a unit length vector

virtual void itk::PowellOptimizer::SetValueTolerance ( double  _arg  )  [virtual, inherited]

Set/Get ValueTolerance. Once this current cost function value is known to be within this tolerance of the cost function value at the local extreme, optimization terminates

void itk::PowellOptimizer::Shift ( double *  a,
double *  b,
double *  c,
double  d 
) const [protected, inherited]

Used in bracketing the extreme along the current line. Adapted from NRC

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

Start optimization.

Reimplemented from itk::PowellOptimizer.

void itk::PowellOptimizer::StopOptimization (  )  [inline, inherited]

When users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 135 of file itkPowellOptimizer.h.

void itk::PowellOptimizer::Swap ( double *  a,
double *  b 
) const [protected, inherited]

Used in bracketing the extreme along the current line. Adapted from NRC

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.


Member Data Documentation

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

Definition at line 98 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 93 of file itkOptimizer.h.


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

Generated at Mon Jul 12 2010 22:35:56 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000