Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
itk::FRPROptimizer Class Reference

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

#include <itkFRPROptimizer.h>

+ Inheritance diagram for itk::FRPROptimizer:
+ Collaboration diagram for itk::FRPROptimizer:

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

unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
virtual void Delete ()
 
virtual const bool & GetCatchGetValueException ()
 
CommandGetCommand (unsigned long tag)
 
virtual const MeasureTypeGetCurrentCost ()
 
virtual const unsigned int & GetCurrentIteration ()
 
virtual const unsigned int & GetCurrentLineIteration ()
 
virtual const ParametersTypeGetCurrentPosition ()
 
bool GetDebug () const
 
virtual const ParametersTypeGetInitialPosition ()
 
virtual const ScalesTypeGetInverseScales ()
 
virtual const bool & GetMaximize ()
 
virtual const unsigned int & GetMaximumIteration ()
 
virtual unsigned int GetMaximumLineIteration () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual const double & GetMetricWorstPossibleValue ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const char * GetNameOfClass () const
 
virtual const std::string & GetObjectName ()
 
virtual int GetReferenceCount () const
 
virtual const ScalesTypeGetScales ()
 
virtual const double & GetStepLength ()
 
virtual const double & GetStepTolerance ()
 
const std::string GetStopConditionDescription () const
 
virtual const TimeStampGetTimeStamp () const
 
virtual bool GetUseUnitLengthGradient () const
 
MeasureType GetValue (const ParametersType &parameters) const
 
MeasureType GetValue () const
 
virtual const double & GetValueTolerance ()
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkCloneMacro (Self)
 
 itkGetModifiableObjectMacro (CostFunction, CostFunctionType)
 
virtual void MaximizeOff ()
 
virtual void MaximizeOn ()
 
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)
 
virtual void SetMaximize (bool _arg)
 
virtual void SetMaximumIteration (unsigned int _arg)
 
virtual void SetMaximumLineIteration (unsigned int _arg)
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetMetricWorstPossibleValue (double _arg)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int)
 
void SetScales (const ScalesType &scales)
 
virtual void SetStepLength (double _arg)
 
virtual void SetStepTolerance (double _arg)
 
void SetToFletchReeves ()
 
void SetToPolakRibiere ()
 
virtual void SetUseUnitLengthGradient (bool _arg)
 
virtual void SetValueTolerance (double _arg)
 
void StartOptimization ()
 
void StopOptimization ()
 
virtual void UnRegister () const
 

Static Public Member Functions

static void BreakOnError ()
 
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 

Protected Types

typedef int InternalReferenceCountType
 

Protected Member Functions

 FRPROptimizer ()
 
virtual ~FRPROptimizer ()
 
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)
 
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 LightObject::Pointer InternalClone () const
 
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)
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (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)
 
virtual void SetTimeStamp (const TimeStamp &time)
 
void Shift (double *a, double *b, double *c, double d) const
 
void Swap (double *a, double *b) const
 

Protected Attributes

CostFunctionPointer m_CostFunction
 
ParametersType m_CurrentPosition
 
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
bool m_ScalesInitialized
 

Private Types

enum  OptimizationType {
  FletchReeves,
  PolakRibiere
}
 

Private Member Functions

 FRPROptimizer (const FRPROptimizer &)
 

Private Attributes

OptimizationType m_OptimizationType
 
bool m_UseUnitLengthGradient
 

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 49 of file itkFRPROptimizer.h.

Member Typedef Documentation

Definition at line 57 of file itkFRPROptimizer.h.

Definition at line 69 of file itkFRPROptimizer.h.

Type of the Cost Function

Definition at line 65 of file itkFRPROptimizer.h.

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

Definition at line 65 of file itkSingleValuedNonLinearOptimizer.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

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

Definition at line 152 of file itkLightObject.h.

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

Definition at line 61 of file itkSingleValuedNonLinearOptimizer.h.

Definition at line 59 of file itkFRPROptimizer.h.

Definition at line 56 of file itkFRPROptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType
inherited

Definition at line 52 of file itkNonLinearOptimizer.h.

Standard "Self" typedef.

Definition at line 54 of file itkFRPROptimizer.h.

Definition at line 55 of file itkFRPROptimizer.h.

Member Enumeration Documentation

Enumerator
FletchReeves 
PolakRibiere 

Definition at line 106 of file itkFRPROptimizer.h.

Constructor & Destructor Documentation

itk::FRPROptimizer::FRPROptimizer ( )
protected

Definition at line 28 of file itkFRPROptimizer.cxx.

itk::FRPROptimizer::~FRPROptimizer ( )
protectedvirtual

Definition at line 35 of file itkFRPROptimizer.cxx.

itk::FRPROptimizer::FRPROptimizer ( const FRPROptimizer )
private

Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command cmd 
)
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

Definition at line 398 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

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

Definition at line 409 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal 
)
protectedvirtualinherited

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.

Definition at line 229 of file itkPowellOptimizer.cxx.

void itk::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal,
ParametersType tempCoord 
)
protectedvirtualinherited

Definition at line 240 of file itkPowellOptimizer.cxx.

References b.

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 150 of file itkLightObject.cxx.

virtual::itk::LightObject::Pointer itk::FRPROptimizer::CreateAnother ( void  ) const
virtual

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

void itk::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

Definition at line 243 of file itkObject.cxx.

void itk::LightObject::Delete ( )
virtualinherited

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.

Delete a 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.

Definition at line 91 of file itkLightObject.cxx.

virtual const bool& itk::PowellOptimizer::GetCatchGetValueException ( )
virtualinherited
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 assign 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.

Definition at line 421 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

virtual const MeasureType& itk::PowellOptimizer::GetCurrentCost ( )
virtualinherited

Return Current Value

Referenced by itk::PowellOptimizer::GetValue().

virtual const unsigned int& itk::PowellOptimizer::GetCurrentIteration ( )
virtualinherited

Return Current Iteration

virtual const unsigned int& itk::PowellOptimizer::GetCurrentLineIteration ( )
virtualinherited

Get the current line search iteration

virtual const ParametersType& itk::Optimizer::GetCurrentPosition ( )
virtualinherited

Get current position of the optimization.

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

Get the value of the debug flag.

Definition at line 263 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 391 of file itkObject.cxx.

virtual const ParametersType& itk::Optimizer::GetInitialPosition ( )
virtualinherited

Get the position to initialize the optimization.

Referenced by itk::SPSAOptimizer::GuessParameters().

virtual const ScalesType& itk::Optimizer::GetInverseScales ( )
virtualinherited
double itk::PowellOptimizer::GetLineValue ( double  x) const
protectedinherited

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

Definition at line 70 of file itkPowellOptimizer.cxx.

double itk::PowellOptimizer::GetLineValue ( double  x,
ParametersType tempCoord 
) const
protectedinherited

Definition at line 79 of file itkPowellOptimizer.cxx.

virtual const bool& itk::PowellOptimizer::GetMaximize ( )
virtualinherited
virtual const unsigned int& itk::PowellOptimizer::GetMaximumIteration ( )
virtualinherited
virtual unsigned int itk::PowellOptimizer::GetMaximumLineIteration ( ) const
virtualinherited
MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns
A constant reference to this objects MetaDataDictionary.

Definition at line 548 of file itkObject.cxx.

References NULL.

virtual const double& itk::PowellOptimizer::GetMetricWorstPossibleValue ( )
virtualinherited
ModifiedTimeType itk::Object::GetMTime ( void  ) const
virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, 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::ShiftScalePixelAccessor< 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::ComplexConjugatePixelAccessor< TImage::PixelType > >, 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::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::SpatialObject< VDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< TDimension >, itk::SpatialObject< TMesh::PointDimension >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::TransformToDisplacementFieldSource< TOutputImage, TTransformPrecisionType >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::LandmarkDisplacementFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

Definition at line 283 of file itkObject.cxx.

Referenced by itk::LandmarkDisplacementFieldSource< TOutputImage >::GetMTime(), itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::TransformToDisplacementFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< VDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetMTime(), itk::SpatialObject< TMesh::PointDimension >::GetObjectMTime(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* itk::FRPROptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PowellOptimizer.

virtual const std::string& itk::Object::GetObjectName ( )
virtualinherited
virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 112 of file itkLightObject.h.

virtual const ScalesType& itk::Optimizer::GetScales ( )
virtualinherited

Get current parameters scaling.

Referenced by itk::SPSAOptimizer::ComputeGradient().

virtual unsigned int itk::PowellOptimizer::GetSpaceDimension ( )
protectedvirtualinherited
virtual const double& itk::PowellOptimizer::GetStepLength ( )
virtualinherited
virtual const double& itk::PowellOptimizer::GetStepTolerance ( )
virtualinherited
virtual bool itk::PowellOptimizer::GetStop ( )
protectedvirtualinherited
const std::string itk::PowellOptimizer::GetStopConditionDescription ( ) const
virtualinherited

Get the reason for termination

Reimplemented from itk::Optimizer.

Definition at line 548 of file itkPowellOptimizer.cxx.

const TimeStamp & itk::Object::GetTimeStamp ( ) const
virtualinherited

Return this object's time stamp.

Return the modification for this object.

Reimplemented in itk::RealTimeClock.

Definition at line 293 of file itkObject.cxx.

Referenced by itk::RealTimeClock::GetTimeStamp().

virtual bool itk::FRPROptimizer::GetUseUnitLengthGradient ( ) const
virtual
SingleValuedNonLinearOptimizer::MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType parameters) const
inherited

Get the cost function value at the given parameters.

Get the cost function value at the given parameters

Definition at line 66 of file itkSingleValuedNonLinearOptimizer.cxx.

References itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

MeasureType itk::PowellOptimizer::GetValue ( void  ) const
inlineinherited

Definition at line 115 of file itkPowellOptimizer.h.

References itk::PowellOptimizer::GetCurrentCost().

void itk::FRPROptimizer::GetValueAndDerivative ( ParametersType p,
double *  val,
ParametersType xi 
)
protectedvirtual

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

Definition at line 40 of file itkFRPROptimizer.cxx.

virtual const double& itk::PowellOptimizer::GetValueTolerance ( )
virtualinherited
static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

Definition at line 118 of file itkObject.h.

Referenced by itk::OutputWindow::DisplayText().

static void itk::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

Definition at line 116 of file itkObject.h.

bool itk::Object::HasObserver ( const EventObject event) const
inherited

Return true if an observer is registered for this event.

Definition at line 472 of file itkObject.cxx.

LightObject::Pointer itk::LightObject::InternalClone ( ) const
protectedvirtualinherited
void itk::Object::InvokeEvent ( const EventObject event)
inherited
void itk::Object::InvokeEvent ( const EventObject event) const
inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 462 of file itkObject.cxx.

itk::LightObject::itkCloneMacro ( Self  )
inherited
itk::SingleValuedNonLinearOptimizer::itkGetModifiableObjectMacro ( CostFunction  ,
CostFunctionType   
)
inherited

Get the cost function.

void itk::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc 
)
protectedvirtualinherited

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.

Definition at line 169 of file itkPowellOptimizer.cxx.

void itk::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc,
ParametersType tempCoord 
)
protectedvirtualinherited

Definition at line 179 of file itkPowellOptimizer.cxx.

void itk::FRPROptimizer::LineOptimize ( ParametersType p,
ParametersType xi,
double *  val 
)
protectedvirtual

Definition at line 69 of file itkFRPROptimizer.cxx.

void itk::FRPROptimizer::LineOptimize ( ParametersType p,
ParametersType xi,
double *  val,
ParametersType tempCoord 
)
protectedvirtual

Definition at line 78 of file itkFRPROptimizer.cxx.

virtual void itk::PowellOptimizer::MaximizeOff ( )
virtualinherited
virtual void itk::PowellOptimizer::MaximizeOn ( )
virtualinherited
void itk::Object::Modified ( void  ) const
virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Reimplemented in otb::SVMModel< TValue, TLabel >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, 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::ShiftScalePixelAccessor< 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::ComplexConjugatePixelAccessor< TImage::PixelType > >, 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 > >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, itk::GPUImage< TPixel, VImageDimension >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, otb::PolyLineParametricPathWithValue< TValue, 2 >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 312 of file itkObject.cxx.

Referenced by itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::AddAttribute(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::AddEnergyValue(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputFilenameListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputFilenameListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSeed(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSpecifiedRegion(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), itk::PolyLineParametricPath< VDimension >::AddVertex(), itk::ChainCodePath< 2 >::ChangeStep(), itk::ChainCodePath2D::ChangeStep(), itk::FourierSeriesPath< VDimension >::Clear(), itk::HilbertPath< TIndexValue, VDimension >::Clear(), itk::ChainCodePath< 2 >::Clear(), itk::ChainCodePath2D::Clear(), itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::ClearAttributeSet(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ClearEnergyValues(), itk::MultiTransform< TScalar, NDimensions >::ClearTransformQueue(), otb::Wrapper::InputFilenameListParameter::ClearValue(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::Wrapper::InputFilenameListParameter::Erase(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSeedList(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSpecifiedRegionList(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::InsertNarrowBandNode(), itk::ChainCodePath2D::InsertStep(), itk::ChainCodePath< 2 >::InsertStep(), otb::ogr::ImageReference< double >::Modified(), itk::MultiTransform< TScalar, NDimensions >::PopBackTransform(), itk::MultiTransform< TScalar, NDimensions >::PopFrontTransform(), itk::MultiTransform< TScalar, NDimensions >::PushBackTransform(), itk::MultiTransform< TScalar, NDimensions >::PushFrontTransform(), itk::Statistics::SubsamplerBase< TSample >::RequestMaximumNumberOfResults(), itk::AdaptImageFilter< TInputImage, TOutputImage, TAccessor >::SetAccessor(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetAdvectionScaling(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetAlivePoints(), itk::CompositeTransform< TScalar, NDimensions >::SetAllTransformsToOptimize(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetAlpha(), itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetAlpha(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetAlpha(), itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::SetAttributeSet(), itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::SetAuxImage(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetBeta(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetCenter(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetClosestPoint(), itk::ConstantPadImageFilter< TInputImage, TOutputImage >::SetConstant(), itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetConstant(), itk::LBFGSBOptimizer::SetCostFunction(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCovariance(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCurvatureScaling(), itk::CurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::NarrowBandCurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), otb::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDimensions(), otb::ImageIOBase::SetDirection(), itk::ImageIOBase::SetDirection(), itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToStrategy(), itk::ComposeDisplacementFieldsImageFilter< TInputImage, TOutputImage >::SetDisplacementField(), itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetDisplacementField(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetEdgeWeight(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetEdgeWeight(), itk::watershed::Boundary< TScalar, TDimension >::SetFace(), itk::ExpNegativeImageFilter< TInputImage, TOutputImage >::SetFactor(), itk::FileListVideoIO::SetFileName(), itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >::SetFixedAverageGradientMagnitude(), itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash(), itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Maximum1< TInputImage::PixelType, TInputImage::PixelType > >::SetFunctor(), itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::ReciprocalHAlphaFunctor< TInputImage::PixelType, TOutputImage::PixelType > >::SetFunctor(), itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramIntensityFunction< SizeValueType, TImage::PixelType > >::SetFunctor(), itk::TernaryFunctorImageFilter< TInputMultiSpectralImage, TInputMultiSpectralInterpImage, TInputPanchroImage, TOutputImage, TFunctor >::SetFunctor(), itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarVectorsFunctor< TInputImage::ValueType >, TMaskImage >::SetFunctor(), itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::DivideOrZeroOut< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >::SetFunctor(), itk::ImageMomentsCalculator< TImage >::SetImage(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::VectorIndexSelectionCastImageFilter< TInputImage, TOutputImage >::SetIndex(), itk::MatrixIndexSelectionImageFilter< TInputImage, TOutputImage >::SetIndices(), itk::TriangleMeshToBinaryImageFilter< TInputMesh, TOutputImage >::SetInfoImage(), itk::MRIBiasFieldCorrectionFilter< TInputImage, TOutputImage, TMaskImage >::SetInitialBiasFieldCoefficients(), itk::AmoebaOptimizer::SetInitialSimplexDelta(), itk::HistogramAlgorithmBase< THistogram >::SetInputHistogram(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), itk::LabelVotingImageFilter< TInputImage, TOutputImage >::SetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetLabelForUndecidedPixels(), itk::watershed::Segmenter< InputImageType >::SetLargestPossibleRegion(), itk::TemporalDataObject::SetLargestPossibleTemporalRegion(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputFilenameListParameter::SetListFromFileName(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetLowerThreshold(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetLowerThreshold(), itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetMatrix(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumCurvatureTimeStep(), itk::watershed::SegmentTable< TScalar >::SetMaximumDepth(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError(), itk::CannyEdgeDetectionImageFilter< ImageType, ImageType >::SetMaximumError(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetMaximumNumberOfIterations(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumPropagationTimeStep(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMean(), itk::Statistics::MembershipFunctionBase< TMeasurementVector >::SetMeasurementVectorSize(), itk::Statistics::DistanceMetric< Array< double > >::SetMeasurementVectorSize(), itk::Statistics::Sample< ImageJointDomainTraits< TImage >::MeasurementVectorType >::SetMeasurementVectorSize(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBandTotalRadius(), itk::OpenCVVideoIO::SetNextFrameToRead(), itk::VXLVideoIO::SetNextFrameToRead(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), otb::Wrapper::InputFilenameListParameter::SetNthFileName(), itk::CompositeTransform< TScalar, NDimensions >::SetNthTransformToOptimize(), otb::ImageIOBase::SetNumberOfDimensions(), itk::ImageIOBase::SetNumberOfDimensions(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::SetNumberOfLayers(), itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetNumberOfResultsRequested(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetNumberOfTargetsToBeReached(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetOffset(), itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::SetOperator(), itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::SetOperator(), itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >::SetOperator(), otb::ImageIOBase::SetOrigin(), itk::ImageIOBase::SetOrigin(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetOutputMaximum(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetOutputMinimum(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutsidePoints(), itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue(), otb::MapProjectionAdapter::SetParameter(), itk::Statistics::ProbabilityDistribution::SetParameters(), itk::DisplacementFieldTransform< TScalar, NDimensions >::SetParameters(), itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetPriorProbabilities(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetPropagationScaling(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage(), itk::ImportImageFilter< TPixel, VImageDimension >::SetRegion(), itk::BinaryMask3DMeshSource< TInputImage, TOutputMesh >::SetRegionOfInterest(), itk::ScaleTransform< TScalar, NDimensions >::SetScale(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSegmentationFunction(), itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetShapePriorScaling(), itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >::SetShrinkFactorsPerDimension(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingConductance(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingConductance(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingIterations(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingIterations(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingTimeStep(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingTimeStep(), itk::PowellOptimizer::SetSpaceDimension(), otb::ImageIOBase::SetSpacing(), itk::ImageIOBase::SetSpacing(), itk::SpatialObject< TMesh::PointDimension >::SetSpacing(), itk::ImageMomentsCalculator< TImage >::SetSpatialObjectMask(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetSpeedConstant(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetCondition(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetNodes(), itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetPoints(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetTerminationUpdateThreshold(), itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetThreshold(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetThreshold(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetTranslation(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetTrialPoints(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUpperThreshold(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUpperThreshold(), itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetUseClockForSeed(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseMinimalCurvature(), itk::watershed::Boundary< TScalar, TDimension >::SetValid(), otb::Wrapper::OutputProcessXMLParameter::SetValue(), otb::Wrapper::InputProcessXMLParameter::SetValue(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance(), itk::CannyEdgeDetectionImageFilter< ImageType, ImageType >::SetVariance(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), otb::MapProjectionAdapter::SetWkt(), itk::LabelVotingImageFilter< TInputImage, TOutputImage >::UnsetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetMaximumNumberOfIterations(), and itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetPriorProbabilities().

static Pointer itk::FRPROptimizer::New ( )
static

Method for creation through the object factory.

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

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 137 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<(), and itk::VideoStream< TFrameType >::PrintSelf().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 315 of file itkLightObject.cxx.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const
protectedinherited

Definition at line 483 of file itkObject.cxx.

void itk::FRPROptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 242 of file itkFRPROptimizer.cxx.

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 325 of file itkLightObject.cxx.

void itk::Object::Register ( ) const
virtualinherited

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

Reimplemented from itk::LightObject.

Definition at line 323 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory(), and itk::ObjectFactoryBase::RegisterFactoryInternal().

void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 442 of file itkObject.cxx.

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

Remove the observer with this tag value.

Definition at line 432 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual void itk::PowellOptimizer::SetCatchGetValueException ( bool  _arg)
virtualinherited
void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType costFunction)
virtualinherited
virtual void itk::PowellOptimizer::SetCurrentCost ( double  _arg)
protectedvirtualinherited
virtual void itk::PowellOptimizer::SetCurrentIteration ( unsigned int  _arg)
protectedvirtualinherited
void itk::PowellOptimizer::SetCurrentLinePoint ( double  x,
double  fx 
)
protectedinherited

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

Definition at line 112 of file itkPowellOptimizer.cxx.

void itk::Optimizer::SetCurrentPosition ( const ParametersType param)
protectedvirtualinherited

Set the current position.

Set the current position

Definition at line 77 of file itkOptimizer.cxx.

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

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

Definition at line 273 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool  val)
staticinherited

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

Set the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

void itk::Optimizer::SetInitialPosition ( const ParametersType param)
virtualinherited

Set the position to initialize the optimization.

Set the initial position

Definition at line 66 of file itkOptimizer.cxx.

void itk::PowellOptimizer::SetLine ( const ParametersType origin,
const vnl_vector< double > &  direction 
)
protectedinherited

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

Definition at line 57 of file itkPowellOptimizer.cxx.

virtual void itk::PowellOptimizer::SetMaximize ( bool  _arg)
virtualinherited

Set if the Optimizer should Maximize the metric

virtual void itk::PowellOptimizer::SetMaximumIteration ( unsigned int  _arg)
virtualinherited

Set/Get maximum iteration limit.

virtual void itk::PowellOptimizer::SetMaximumLineIteration ( unsigned int  _arg)
virtualinherited

Set/Get the maximum number of line search iterations

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
virtual void itk::PowellOptimizer::SetMetricWorstPossibleValue ( double  _arg)
virtualinherited
virtual void itk::Object::SetObjectName ( std::string  _arg)
virtualinherited

A facility to help application programmers set a human identifiable name for a given object. This has no inherent use in ITK, but is a convenience to allow developers to provide a name for this object.

void itk::Object::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 359 of file itkObject.cxx.

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

Set current parameters scaling.

Set scaling as an array of factors

Definition at line 40 of file itkOptimizer.cxx.

References itk::Array< TValueType >::SetSize().

void itk::PowellOptimizer::SetSpaceDimension ( unsigned int  dim)
inlineprotectedinherited
virtual void itk::PowellOptimizer::SetStepLength ( double  _arg)
virtualinherited

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

virtual void itk::PowellOptimizer::SetStepTolerance ( double  _arg)
virtualinherited

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)
protectedvirtualinherited
void itk::Object::SetTimeStamp ( const TimeStamp timeStamp)
protectedvirtualinherited

Set the time stamp of this object. This method must be used very carefully !!!. Most mortals will never need to call this method.

Set the time stamp of this object. To be used very carefully !!!. Most mortals will never need to call this method.

Definition at line 302 of file itkObject.cxx.

void itk::FRPROptimizer::SetToFletchReeves ( )

Set it to the Fletch-Reeves optimizer

Definition at line 232 of file itkFRPROptimizer.cxx.

void itk::FRPROptimizer::SetToPolakRibiere ( )

Set it to the Fletch-Reeves optimizer

Definition at line 222 of file itkFRPROptimizer.cxx.

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

Convert gradient to a unit length vector

virtual void itk::PowellOptimizer::SetValueTolerance ( double  _arg)
virtualinherited

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
protectedinherited

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

Definition at line 142 of file itkPowellOptimizer.cxx.

References b.

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

Start optimization.

Reimplemented from itk::Optimizer.

Definition at line 106 of file itkFRPROptimizer.cxx.

References itk::FRPR_TINY.

void itk::PowellOptimizer::StopOptimization ( void  )
inlineinherited

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 129 of file itkPowellOptimizer.h.

References itk::PowellOptimizer::m_Stop.

void itk::PowellOptimizer::Swap ( double *  a,
double *  b 
) const
protectedinherited

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

Definition at line 131 of file itkPowellOptimizer.cxx.

References b.

void itk::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 337 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::DeleteNonInternalFactory(), and itk::Object::New().

Member Data Documentation

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction
protectedinherited
ParametersType itk::Optimizer::m_CurrentPosition
protectedinherited

Definition at line 99 of file itkOptimizer.h.

Referenced by itk::PowellOptimizer::SetSpaceDimension().

OptimizationType itk::FRPROptimizer::m_OptimizationType
private

Definition at line 111 of file itkFRPROptimizer.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 156 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 159 of file itkLightObject.h.

bool itk::Optimizer::m_ScalesInitialized
protectedinherited

Definition at line 94 of file itkOptimizer.h.

bool itk::FRPROptimizer::m_UseUnitLengthGradient
private

Definition at line 113 of file itkFRPROptimizer.h.


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

Generated at Sat Mar 8 2014 17:02:17 for Orfeo Toolbox with doxygen 1.8.3.1