go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::ScaledSingleValuedCostFunction Class Reference

#include <itkScaledSingleValuedCostFunction.h>

Detailed Description

A cost function that applies a scaling to another cost function.

This class can be used to adapt an existing, badly scaled, cost function.

By default it does not apply any scaling. Use the method SetUseScales(true) to enable the use of scales.

Definition at line 39 of file itkScaledSingleValuedCostFunction.h.

Inheritance diagram for itk::ScaledSingleValuedCostFunction:
Inheritance graph

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Superclass::DerivativeType DerivativeType
typedef Superclass::MeasureType MeasureType
typedef unsigned int NumberOfParametersType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef Array< doubleScalesType
typedef ScaledSingleValuedCostFunction Self
typedef Superclass::Pointer SingleValuedCostFunctionPointer
typedef SingleValuedCostFunction Superclass

Public Member Functions

virtual void ConvertScaledToUnscaledParameters (ParametersType &parameters) const
virtual void ConvertUnscaledToScaledParameters (ParametersType &parameters) const
virtual const char * GetClassName () const
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const
virtual bool GetNegateCostFunction () const
virtual NumberOfParametersType GetNumberOfParameters (void) const
virtual const ScalesTypeGetScales ()
virtual const ScalesTypeGetSquaredScales ()
virtual SuperclassGetUnscaledCostFunction ()
virtual bool GetUseScales () const
virtual MeasureType GetValue (const ParametersType &parameters) const
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
virtual void NegateCostFunctionOff ()
virtual void NegateCostFunctionOn ()
virtual void SetNegateCostFunction (bool _arg)
virtual void SetScales (const ScalesType &scales)
virtual void SetSquaredScales (const ScalesType &squaredScales)
virtual void SetUnscaledCostFunction (Superclass *_arg)
virtual void SetUseScales (bool _arg)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Private Member Functions

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

Private Attributes

bool m_NegateCostFunction
ScalesType m_Scales
ScalesType m_SquaredScales
SingleValuedCostFunctionPointer m_UnscaledCostFunction
bool m_UseScales

Member Typedef Documentation

Definition at line 47 of file itkScaledSingleValuedCostFunction.h.

typedef Superclass::DerivativeType itk::ScaledSingleValuedCostFunction::DerivativeType

Definition at line 57 of file itkScaledSingleValuedCostFunction.h.

typedef Superclass::MeasureType itk::ScaledSingleValuedCostFunction::MeasureType

Typedefs inherited from the superclass.

Definition at line 53 of file itkScaledSingleValuedCostFunction.h.

Definition at line 61 of file itkScaledSingleValuedCostFunction.h.

typedef Superclass::ParametersType itk::ScaledSingleValuedCostFunction::ParametersType

Definition at line 58 of file itkScaledSingleValuedCostFunction.h.

Definition at line 46 of file itkScaledSingleValuedCostFunction.h.

Definition at line 64 of file itkScaledSingleValuedCostFunction.h.

Standard ITK-stuff.

Definition at line 44 of file itkScaledSingleValuedCostFunction.h.

Definition at line 62 of file itkScaledSingleValuedCostFunction.h.

typedef SingleValuedCostFunction itk::ScaledSingleValuedCostFunction::Superclass

Definition at line 45 of file itkScaledSingleValuedCostFunction.h.

Constructor & Destructor Documentation

itk::ScaledSingleValuedCostFunction::ScaledSingleValuedCostFunction ( )

The constructor.

virtual itk::ScaledSingleValuedCostFunction::~ScaledSingleValuedCostFunction ( )

The destructor.

Definition at line 134 of file itkScaledSingleValuedCostFunction.h.

itk::ScaledSingleValuedCostFunction::ScaledSingleValuedCostFunction ( const Self )

The private constructor.

Member Function Documentation

virtual void itk::ScaledSingleValuedCostFunction::ConvertScaledToUnscaledParameters ( ParametersType parameters) const

Convert the parameters from scaled to unscaled: x = y/s.

virtual void itk::ScaledSingleValuedCostFunction::ConvertUnscaledToScaledParameters ( ParametersType parameters) const

Convert the parameters from unscaled to scaled: y = x*s.

virtual const char* itk::ScaledSingleValuedCostFunction::GetClassName ( ) const

Run-time type information (and related methods).

virtual void itk::ScaledSingleValuedCostFunction::GetDerivative ( const ParametersType parameters,
DerivativeType derivative 
) const

Divide the parameters by the scales, call the GetDerivative routine of the unscaled cost function and divide the resulting derivative by the scales.

virtual bool itk::ScaledSingleValuedCostFunction::GetNegateCostFunction ( ) const

Get the flag to negate the cost function or not.

virtual NumberOfParametersType itk::ScaledSingleValuedCostFunction::GetNumberOfParameters ( void  ) const

Ask the UnscaledCostFunction how many parameters it has.

virtual const ScalesType& itk::ScaledSingleValuedCostFunction::GetScales ( )

Get the scales.

virtual const ScalesType& itk::ScaledSingleValuedCostFunction::GetSquaredScales ( )

The ITK convention is to use the squared scales. This function returns the squared actual scales.

virtual Superclass* itk::ScaledSingleValuedCostFunction::GetUnscaledCostFunction ( )

Get the cost function that needs scaling.

virtual bool itk::ScaledSingleValuedCostFunction::GetUseScales ( ) const

Get the flag to use scales or not.

virtual MeasureType itk::ScaledSingleValuedCostFunction::GetValue ( const ParametersType parameters) const

Divide the parameters by the scales and call the GetValue routine of the unscaled cost function.

virtual void itk::ScaledSingleValuedCostFunction::GetValueAndDerivative ( const ParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const

Same procedure as in GetValue and GetDerivative.

virtual void itk::ScaledSingleValuedCostFunction::NegateCostFunctionOff ( )
virtual void itk::ScaledSingleValuedCostFunction::NegateCostFunctionOn ( )

Set the flag to negate the cost function or not.

static Pointer itk::ScaledSingleValuedCostFunction::New ( )

Method for creation through the object factory.

void itk::ScaledSingleValuedCostFunction::operator= ( const Self )

The private copy constructor.

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


virtual void itk::ScaledSingleValuedCostFunction::SetNegateCostFunction ( bool  _arg)

Set the flag to negate the cost function or not.

virtual void itk::ScaledSingleValuedCostFunction::SetScales ( const ScalesType scales)

Set the scales. Also computes the squared scales, just in case users call GetSquaredScales (for compatibility with the ITK convention).

virtual void itk::ScaledSingleValuedCostFunction::SetSquaredScales ( const ScalesType squaredScales)

The ITK convention is to use the squared scales. This function takes the square root of the input scales and sets them as the the actual scales

virtual void itk::ScaledSingleValuedCostFunction::SetUnscaledCostFunction ( Superclass _arg)

Set the cost function that needs scaling.

virtual void itk::ScaledSingleValuedCostFunction::SetUseScales ( bool  _arg)

Set the flag to use scales or not.

Field Documentation

bool itk::ScaledSingleValuedCostFunction::m_NegateCostFunction

Definition at line 151 of file itkScaledSingleValuedCostFunction.h.

ScalesType itk::ScaledSingleValuedCostFunction::m_Scales

Member variables.

Definition at line 147 of file itkScaledSingleValuedCostFunction.h.

ScalesType itk::ScaledSingleValuedCostFunction::m_SquaredScales

Definition at line 148 of file itkScaledSingleValuedCostFunction.h.

SingleValuedCostFunctionPointer itk::ScaledSingleValuedCostFunction::m_UnscaledCostFunction

Definition at line 149 of file itkScaledSingleValuedCostFunction.h.

bool itk::ScaledSingleValuedCostFunction::m_UseScales

Definition at line 150 of file itkScaledSingleValuedCostFunction.h.

Generated on 04-09-2015 for elastix by doxygen elastix logo