ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::SingleValuedNonLinearOptimizer Class Reference

This class is a base for the Optimization methods that optimize a single valued function. More...

#include <itkSingleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearOptimizer:
Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

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 Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef
SingleValuedNonLinearOptimizer 
Self
typedef NonLinearOptimizer Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const CostFunctionTypeGetCostFunction ()
virtual const char * GetNameOfClass () const
MeasureType GetValue (const ParametersType &parameters) const
virtual void SetCostFunction (CostFunctionType *costFunction)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 SingleValuedNonLinearOptimizer ()
virtual ~SingleValuedNonLinearOptimizer ()

Protected Attributes

CostFunctionPointer m_CostFunction

Private Member Functions

void operator= (const Self &)
 SingleValuedNonLinearOptimizer (const Self &)

Detailed Description

This class is a base for the Optimization methods that optimize a single valued function.

Definition at line 34 of file itkSingleValuedNonLinearOptimizer.h.


Member Typedef Documentation

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

Definition at line 65 of file itkSingleValuedNonLinearOptimizer.h.

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

Reimplemented in itk::ParticleSwarmOptimizerBase.

Definition at line 61 of file itkSingleValuedNonLinearOptimizer.h.

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


Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( ) [protected]
virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( ) [inline, protected, virtual]

Definition at line 78 of file itkSingleValuedNonLinearOptimizer.h.

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( const Self ) [private]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::SingleValuedNonLinearOptimizer::CreateAnother ( void  ) const [virtual]
virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction ( ) [virtual]

Get the cost function.

virtual const char* itk::SingleValuedNonLinearOptimizer::GetNameOfClass ( ) const [virtual]
MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType parameters) const

Get the cost function value at the given parameters.

Reimplemented in itk::SPSAOptimizer.

static Pointer itk::SingleValuedNonLinearOptimizer::New ( ) [static]
void itk::SingleValuedNonLinearOptimizer::operator= ( const Self ) [private]
void itk::SingleValuedNonLinearOptimizer::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::Optimizer.

Reimplemented in itk::AmoebaOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::ParticleSwarmOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::SingleValuedNonLinearVnlOptimizer, and itk::SPSAOptimizer.

virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType costFunction) [virtual]

Set the cost function.


Member Data Documentation

Definition at line 81 of file itkSingleValuedNonLinearOptimizer.h.


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