ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkSingleValuedVnlCostFunctionAdaptor.h>
This class is an Adaptor that allows to pass itk::SingleValuedCostFunctions to vnl_optimizers expecting a vnl_cost_function.
This class returns a single valued.
Definition at line 36 of file itkSingleValuedVnlCostFunctionAdaptor.h.
Public Types | |
typedef SingleValuedCostFunction::DerivativeType | DerivativeType |
typedef vnl_vector< double > | InternalDerivativeType |
typedef double | InternalMeasureType |
typedef vnl_vector< double > | InternalParametersType |
typedef SingleValuedCostFunction::MeasureType | MeasureType |
typedef SingleValuedCostFunction::ParametersType | ParametersType |
typedef Array< double > | ScalesType |
Protected Member Functions | |
void | ReportIteration (const EventObject &event) const |
Private Member Functions | |
virtual const ScalesType & | GetInverseScales () const |
typedef SingleValuedCostFunction::DerivativeType itk::SingleValuedVnlCostFunctionAdaptor::DerivativeType |
Derivatives of the SingleValuedCostFunction
Definition at line 54 of file itkSingleValuedVnlCostFunctionAdaptor.h.
typedef vnl_vector< double > itk::SingleValuedVnlCostFunctionAdaptor::InternalDerivativeType |
InternalGradientType typedef.
Definition at line 48 of file itkSingleValuedVnlCostFunctionAdaptor.h.
typedef double itk::SingleValuedVnlCostFunctionAdaptor::InternalMeasureType |
InternalMeasureType typedef.
Definition at line 45 of file itkSingleValuedVnlCostFunctionAdaptor.h.
typedef vnl_vector< double > itk::SingleValuedVnlCostFunctionAdaptor::InternalParametersType |
InternalParametersType typedef.
Definition at line 42 of file itkSingleValuedVnlCostFunctionAdaptor.h.
Type of the SingleValuedCostFunction value
Definition at line 57 of file itkSingleValuedVnlCostFunctionAdaptor.h.
typedef SingleValuedCostFunction::ParametersType itk::SingleValuedVnlCostFunctionAdaptor::ParametersType |
Parameters of the SingleValuedCostFunction
Definition at line 51 of file itkSingleValuedVnlCostFunctionAdaptor.h.
typedef Array< double > itk::SingleValuedVnlCostFunctionAdaptor::ScalesType |
Scales typedef
Definition at line 60 of file itkSingleValuedVnlCostFunctionAdaptor.h.
itk::SingleValuedVnlCostFunctionAdaptor::SingleValuedVnlCostFunctionAdaptor | ( | unsigned int | spaceDimension | ) |
Constructor with size
unsigned long itk::SingleValuedVnlCostFunctionAdaptor::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 |
Delegate computation of value and gradient to the costFunction.
void itk::SingleValuedVnlCostFunctionAdaptor::ConvertExternalToInternalGradient | ( | const DerivativeType & | input, |
InternalDerivativeType & | output | ||
) | const |
Convert external derviative measures into internal type
|
virtual |
Delegate computation of the value to the CostFunction.
const ParametersType& itk::SingleValuedVnlCostFunctionAdaptor::GetCachedCurrentParameters | ( | ) | const |
const DerivativeType& itk::SingleValuedVnlCostFunctionAdaptor::GetCachedDerivative | ( | ) | const |
const MeasureType& itk::SingleValuedVnlCostFunctionAdaptor::GetCachedValue | ( | ) | const |
|
inline |
Get the CostFunction deriving from SingleValuedCostFunction
Definition at line 70 of file itkSingleValuedVnlCostFunctionAdaptor.h.
References m_CostFunction.
|
privatevirtual |
Get current parameters scaling.
bool itk::SingleValuedVnlCostFunctionAdaptor::GetNegateCostFunction | ( | ) | const |
|
virtual |
Delegate computation of the gradient to the costFunction.
|
inline |
Definition at line 106 of file itkSingleValuedVnlCostFunctionAdaptor.h.
References m_NegateCostFunction.
|
inline |
Definition at line 105 of file itkSingleValuedVnlCostFunctionAdaptor.h.
References m_NegateCostFunction.
|
protected |
This method is intended to be called by the derived classes in order to notify of an iteration event to any Command/Observers
|
inline |
Set the CostFunction deriving from SingleValuedCostFunction
Definition at line 66 of file itkSingleValuedVnlCostFunctionAdaptor.h.
References m_CostFunction.
void itk::SingleValuedVnlCostFunctionAdaptor::SetNegateCostFunction | ( | bool | value | ) |
Set/Get Negate cost function. The purpose of this boolean flag is to make possible to take certain VNL optimizers that are only minimizers, and use them for maximizing functions. When the boolean flag is set to true, the values returned by GetValue in the internal ITK cost function will be multiplied by -1 before returning it in the f() function. Similar operations will be done for the gradf() and compute() methods. When the boolean flag is set to false, then the values returned by the ITK cost function will be passed unchanged to the VNL optimizers.
void itk::SingleValuedVnlCostFunctionAdaptor::SetScales | ( | const ScalesType & | scales | ) |
Set current parameters scaling.
|
mutableprivate |
Definition at line 143 of file itkSingleValuedVnlCostFunctionAdaptor.h.
|
mutableprivate |
Definition at line 142 of file itkSingleValuedVnlCostFunctionAdaptor.h.
|
mutableprivate |
Definition at line 141 of file itkSingleValuedVnlCostFunctionAdaptor.h.
|
private |
Definition at line 133 of file itkSingleValuedVnlCostFunctionAdaptor.h.
Referenced by GetCostFunction(), and SetCostFunction().
|
private |
Definition at line 137 of file itkSingleValuedVnlCostFunctionAdaptor.h.
|
private |
Definition at line 138 of file itkSingleValuedVnlCostFunctionAdaptor.h.
Referenced by NegateCostFunctionOff(), and NegateCostFunctionOn().
|
private |
Definition at line 139 of file itkSingleValuedVnlCostFunctionAdaptor.h.
|
private |
Definition at line 136 of file itkSingleValuedVnlCostFunctionAdaptor.h.