itk::MultipleValuedVnlCostFunctionAdaptor Class Reference
[Numerics, Optimizers]
This class is an Adaptor that allows to pass itk::MultipleValuedCostFunctions to vnl_optimizers expecting a vnl_cost_function. More...
#include <itkMultipleValuedVnlCostFunctionAdaptor.h>
Detailed Description
This class is an Adaptor that allows to pass itk::MultipleValuedCostFunctions to vnl_optimizers expecting a vnl_cost_function.
This class returns a single valued.
Definition at line 36 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
Member Typedef Documentation
| typedef MultipleValuedCostFunction::DerivativeType itk::MultipleValuedVnlCostFunctionAdaptor::DerivativeType |
Derivatives of the MultipleValuedCostFunction
Definition at line 57 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
InternalGradientType typedef.
Definition at line 48 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
InternalMeasureType typedef.
Definition at line 45 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
InternalParametersType typedef.
Definition at line 42 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| typedef MultipleValuedCostFunction::MeasureType itk::MultipleValuedVnlCostFunctionAdaptor::MeasureType |
MeasureType of the MultipleValuedCostFunction
Definition at line 51 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| typedef MultipleValuedCostFunction::ParametersType itk::MultipleValuedVnlCostFunctionAdaptor::ParametersType |
Parameters of the MultipleValuedCostFunction
Definition at line 54 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| typedef Array<double> itk::MultipleValuedVnlCostFunctionAdaptor::ScalesType |
Scales typedef
Definition at line 60 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
Constructor & Destructor Documentation
| itk::MultipleValuedVnlCostFunctionAdaptor::MultipleValuedVnlCostFunctionAdaptor | ( | unsigned int | spaceDimension, | |
| unsigned int | numberOfValues | |||
| ) |
Constructor with size
Member Function Documentation
| unsigned long itk::MultipleValuedVnlCostFunctionAdaptor::AddObserver | ( | const EventObject & | event, | |
| Command * | ||||
| ) | const |
This AddObserver method allows to simulate that this class derives from an itkObject for the purpose of reporting iteration events. The goal of this method is to allow ITK-vnl optimizer adaptors to get iteration events despite the fact that VNL does not provide callbacks.
| virtual void itk::MultipleValuedVnlCostFunctionAdaptor::compute | ( | const InternalParametersType & | x, | |
| InternalMeasureType * | f, | |||
| InternalDerivativeType * | g | |||
| ) | [virtual] |
Delegate computation of value and gradient to the costFunction.
| void itk::MultipleValuedVnlCostFunctionAdaptor::ConvertExternalToInternalGradient | ( | const DerivativeType & | input, | |
| InternalDerivativeType & | output | |||
| ) |
Convert external derviative measures into internal type
| void itk::MultipleValuedVnlCostFunctionAdaptor::ConvertExternalToInternalMeasures | ( | const MeasureType & | input, | |
| InternalMeasureType & | output | |||
| ) |
Convert external measures into internal type
| virtual void itk::MultipleValuedVnlCostFunctionAdaptor::f | ( | const InternalParametersType & | inparameters, | |
| InternalMeasureType & | measures | |||
| ) | [virtual] |
Delegate computation of the value to the CostFunction.
| const ParametersType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedCurrentParameters | ( | ) | const |
| const DerivativeType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedDerivative | ( | ) | const |
| const MeasureType& itk::MultipleValuedVnlCostFunctionAdaptor::GetCachedValue | ( | ) | const |
| const MultipleValuedCostFunction* itk::MultipleValuedVnlCostFunctionAdaptor::GetCostFunction | ( | void | ) | const [inline] |
Get the CostFunction deriving from MultipleValuedCostFunction
Definition at line 71 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| bool itk::MultipleValuedVnlCostFunctionAdaptor::GetUseGradient | ( | ) | const |
| virtual void itk::MultipleValuedVnlCostFunctionAdaptor::gradf | ( | const InternalParametersType & | inparameters, | |
| InternalDerivativeType & | gradient | |||
| ) | [virtual] |
Delegate computation of the gradient to the costFunction.
| void itk::MultipleValuedVnlCostFunctionAdaptor::ReportIteration | ( | const EventObject & | event | ) | const [protected] |
This method is intended to be called by the derived classes in order to notify of an iteration event to any Command/Observers
| void itk::MultipleValuedVnlCostFunctionAdaptor::SetCostFunction | ( | MultipleValuedCostFunction * | costFunction | ) | [inline] |
Set the CostFunction deriving from MultipleValuedCostFunction
Definition at line 67 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| void itk::MultipleValuedVnlCostFunctionAdaptor::SetScales | ( | const ScalesType & | scales | ) |
Set current parameters scaling.
| void itk::MultipleValuedVnlCostFunctionAdaptor::SetUseGradient | ( | bool | ) |
Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach
| void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOff | ( | ) | [inline] |
Return the value of the last evaluation to the value of the cost function. Note that this method DOES NOT triggers a computation of the function or the derivatives, it only returns previous values. Therefore the values here are only valid after you invoke the f() or gradf() methods.
Definition at line 102 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
| void itk::MultipleValuedVnlCostFunctionAdaptor::UseGradientOn | ( | ) | [inline] |
Return the value of the last evaluation to the value of the cost function. Note that this method DOES NOT triggers a computation of the function or the derivatives, it only returns previous values. Therefore the values here are only valid after you invoke the f() or gradf() methods.
Definition at line 101 of file itkMultipleValuedVnlCostFunctionAdaptor.h.
The documentation for this class was generated from the following file:
