![]() |
Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages |
A cost function that applies a scaling to another cost function. More...
#include <itkScaledSingleValuedCostFunction.h>
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef Superclass::DerivativeType | DerivativeType |
typedef Superclass::MeasureType | MeasureType |
typedef Superclass::ParametersType | ParametersType |
typedef SmartPointer< Self > | Pointer |
typedef Array< double > | ScalesType |
typedef ScaledSingleValuedCostFunction | Self |
typedef Superclass::Pointer | SingleValuedCostFunctionPointer |
typedef SingleValuedCostFunction | Superclass |
Public Member Functions | |
virtual void | ConvertScaledToUnscaledParameters (ParametersType ¶meters) const |
virtual void | ConvertUnscaledToScaledParameters (ParametersType ¶meters) const |
virtual const char * | GetClassName () const |
virtual void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const |
virtual bool | GetNegateCostFunction () const |
virtual unsigned int | GetNumberOfParameters (void) const |
virtual const ScalesType & | GetScales () |
virtual const ScalesType & | GetSquaredScales () |
virtual Superclass * | GetUnscaledCostFunction () |
virtual bool | GetUseScales () const |
virtual MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | GetValueAndDerivative (const ParametersType ¶meters, 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 |
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 34 of file itkScaledSingleValuedCostFunction.h.
typedef SmartPointer<const Self> itk::ScaledSingleValuedCostFunction::ConstPointer |
Definition at line 42 of file itkScaledSingleValuedCostFunction.h.
typedef Superclass::DerivativeType itk::ScaledSingleValuedCostFunction::DerivativeType |
Definition at line 52 of file itkScaledSingleValuedCostFunction.h.
typedef Superclass::MeasureType itk::ScaledSingleValuedCostFunction::MeasureType |
Typedefs inherited from the superclass.
Definition at line 48 of file itkScaledSingleValuedCostFunction.h.
typedef Superclass::ParametersType itk::ScaledSingleValuedCostFunction::ParametersType |
Definition at line 53 of file itkScaledSingleValuedCostFunction.h.
typedef SmartPointer<Self> itk::ScaledSingleValuedCostFunction::Pointer |
Definition at line 41 of file itkScaledSingleValuedCostFunction.h.
typedef Array<double> itk::ScaledSingleValuedCostFunction::ScalesType |
Definition at line 56 of file itkScaledSingleValuedCostFunction.h.
Standard ITK-stuff.
Definition at line 39 of file itkScaledSingleValuedCostFunction.h.
typedef Superclass::Pointer itk::ScaledSingleValuedCostFunction::SingleValuedCostFunctionPointer |
Definition at line 54 of file itkScaledSingleValuedCostFunction.h.
Definition at line 40 of file itkScaledSingleValuedCostFunction.h.
itk::ScaledSingleValuedCostFunction::ScaledSingleValuedCostFunction | ( | ) | [protected] |
The constructor.
virtual itk::ScaledSingleValuedCostFunction::~ScaledSingleValuedCostFunction | ( | ) | [inline, protected, virtual] |
The destructor.
Definition at line 126 of file itkScaledSingleValuedCostFunction.h.
itk::ScaledSingleValuedCostFunction::ScaledSingleValuedCostFunction | ( | const Self & | ) | [private] |
The private constructor.
virtual void itk::ScaledSingleValuedCostFunction::ConvertScaledToUnscaledParameters | ( | ParametersType & | parameters | ) | const [virtual] |
Convert the parameters from scaled to unscaled: x = y/s.
virtual void itk::ScaledSingleValuedCostFunction::ConvertUnscaledToScaledParameters | ( | ParametersType & | parameters | ) | const [virtual] |
Convert the parameters from unscaled to scaled: y = x*s.
virtual const char* itk::ScaledSingleValuedCostFunction::GetClassName | ( | ) | const [virtual] |
Run-time type information (and related methods).
virtual void itk::ScaledSingleValuedCostFunction::GetDerivative | ( | const ParametersType & | parameters, |
DerivativeType & | derivative | ||
) | const [virtual] |
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 [virtual] |
Get the flag to negate the cost function or not.
virtual unsigned int itk::ScaledSingleValuedCostFunction::GetNumberOfParameters | ( | void | ) | const [virtual] |
Ask the UnscaledCostFunction how many parameters it has.
virtual const ScalesType& itk::ScaledSingleValuedCostFunction::GetScales | ( | ) | [virtual] |
Get the scales.
virtual const ScalesType& itk::ScaledSingleValuedCostFunction::GetSquaredScales | ( | ) | [virtual] |
The ITK convention is to use the squared scales. This function returns the squared actual scales.
virtual Superclass* itk::ScaledSingleValuedCostFunction::GetUnscaledCostFunction | ( | ) | [virtual] |
Get the cost function that needs scaling.
virtual bool itk::ScaledSingleValuedCostFunction::GetUseScales | ( | ) | const [virtual] |
Get the flag to use scales or not.
virtual MeasureType itk::ScaledSingleValuedCostFunction::GetValue | ( | const ParametersType & | parameters | ) | const [virtual] |
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 [virtual] |
Same procedure as in GetValue and GetDerivative.
virtual void itk::ScaledSingleValuedCostFunction::NegateCostFunctionOff | ( | ) | [virtual] |
virtual void itk::ScaledSingleValuedCostFunction::NegateCostFunctionOn | ( | ) | [virtual] |
Set the flag to negate the cost function or not.
static Pointer itk::ScaledSingleValuedCostFunction::New | ( | ) | [static] |
Method for creation through the object factory.
void itk::ScaledSingleValuedCostFunction::operator= | ( | const Self & | ) | [private] |
The private copy constructor.
void itk::ScaledSingleValuedCostFunction::PrintSelf | ( | std::ostream & | os, |
Indent | indent | ||
) | const [protected] |
PrintSelf.
virtual void itk::ScaledSingleValuedCostFunction::SetNegateCostFunction | ( | bool | _arg | ) | [virtual] |
Set the flag to negate the cost function or not.
virtual void itk::ScaledSingleValuedCostFunction::SetScales | ( | const ScalesType & | scales | ) | [virtual] |
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 | ) | [virtual] |
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 | ) | [virtual] |
Set the cost function that needs scaling.
virtual void itk::ScaledSingleValuedCostFunction::SetUseScales | ( | bool | _arg | ) | [virtual] |
Set the flag to use scales or not.
Definition at line 143 of file itkScaledSingleValuedCostFunction.h.
Member variables.
Definition at line 139 of file itkScaledSingleValuedCostFunction.h.
Definition at line 140 of file itkScaledSingleValuedCostFunction.h.
SingleValuedCostFunctionPointer itk::ScaledSingleValuedCostFunction::m_UnscaledCostFunction [private] |
Definition at line 141 of file itkScaledSingleValuedCostFunction.h.
Definition at line 142 of file itkScaledSingleValuedCostFunction.h.
Generated on 24-10-2011 for elastix by ![]() |
![]() |