ITK  4.2.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

#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 Types inherited from itk::NonLinearOptimizer
typedef Superclass::ScalesType ScalesType
- Public Types inherited from itk::Optimizer
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

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 ()
 NonLinearOptimizer ()
virtual ~NonLinearOptimizer ()
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
virtual void SetCurrentPosition (const ParametersType &param)
virtual ~Optimizer ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

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.

typedef Superclass::ParametersType itk::SingleValuedNonLinearOptimizer::ParametersType

Parameters type. It defines a position in the optimization search space.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::AmoebaOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, and itk::FRPROptimizer.

Definition at line 49 of file itkSingleValuedNonLinearOptimizer.h.


Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )
protected
virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )
inlineprotectedvirtual

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

Reimplemented from itk::Optimizer.

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

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

Set the cost function.


Member Data Documentation

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction
protected

Definition at line 81 of file itkSingleValuedNonLinearOptimizer.h.


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