Medical Imaging Interaction Toolkit
2024.06.99-caca2dd0
Medical Imaging Interaction Toolkit
|
This class is used to add constraints to any multi valued model fit cost function. More...
#include <mitkMVConstrainedCostFunctionDecorator.h>
Public Types | |
typedef MVConstrainedCostFunctionDecorator | Self |
typedef mitk::MVModelFitCostFunction | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
typedef Superclass::SignalType | SignalType |
typedef ConstraintCheckerBase::PenaltyValueType | PenaltyValueType |
Public Types inherited from mitk::MVModelFitCostFunction | |
typedef MVModelFitCostFunction | Self |
typedef itk::MultipleValuedCostFunction | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
typedef ModelFitCostFunctionInterface::SignalType | SignalType |
typedef Superclass::MeasureType | MeasureType |
typedef Superclass::DerivativeType | DerivativeType |
Public Types inherited from mitk::ModelFitCostFunctionInterface | |
typedef ModelFitCostFunctionInterface | Self |
typedef itk::Array< double > | SignalType |
Public Member Functions | |
virtual void | SetWrappedCostFunction (const MVModelFitCostFunction *_arg) |
virtual const MVModelFitCostFunction * | GetWrappedCostFunction () |
virtual void | SetConstraintChecker (const ConstraintCheckerBase *_arg) |
virtual const ConstraintCheckerBase * | GetConstraintChecker () |
virtual void | SetFailureThreshold (PenaltyValueType _arg) |
virtual PenaltyValueType | GetFailureThreshold () const |
virtual void | SetActivateFailureThreshold (bool _arg) |
virtual bool | GetActivateFailureThreshold () const |
virtual unsigned int | GetEvaluationCount () const |
double | GetPenaltyRatio () const |
double | GetFailureRatio () const |
ParametersType::size_type | GetFailedParameter () const |
Public Member Functions inherited from mitk::MVModelFitCostFunction | |
void | SetSample (const SignalType &sampleSet) override |
MeasureType | GetValue (const ParametersType ¶meter) const override |
void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const override |
unsigned int | GetNumberOfValues (void) const override |
unsigned int | GetNumberOfParameters (void) const override |
virtual void | SetModel (const ModelBase *_arg) |
virtual const ModelBase * | GetModel () |
virtual void | SetDerivativeStepLength (double _arg) |
virtual double | GetDerivativeStepLength () const |
Public Member Functions inherited from mitk::ModelFitCostFunctionInterface | |
virtual const ModelBase * | GetModel () const =0 |
Static Public Member Functions | |
static Pointer | New () |
Protected Member Functions | |
MeasureType | CalcMeasure (const ParametersType ¶meters, const SignalType &signal) const override |
MVConstrainedCostFunctionDecorator () | |
~MVConstrainedCostFunctionDecorator () override | |
Protected Member Functions inherited from mitk::MVModelFitCostFunction | |
MVModelFitCostFunction () | |
~MVModelFitCostFunction () override | |
Protected Member Functions inherited from mitk::ModelFitCostFunctionInterface | |
ModelFitCostFunctionInterface () | |
virtual | ~ModelFitCostFunctionInterface () |
Protected Attributes | |
ConstraintCheckerBase::ConstPointer | m_ConstraintChecker |
MVModelFitCostFunction::ConstPointer | m_WrappedCostFunction |
PenaltyValueType | m_FailureThreshold |
bool | m_ActivateFailureThreshold |
unsigned int | m_EvaluationCount |
unsigned int | m_PenaltyCount |
unsigned int | m_FailureCount |
ParametersType::size_type | m_LastFailedParameter |
Protected Attributes inherited from mitk::MVModelFitCostFunction | |
SignalType | m_Sample |
This class is used to add constraints to any multi valued model fit cost function.
MVConstrainedCostFunctionDecorator is used to extend a given cost function with the functionality to regard given constraints for the measure. To add this functionality to a cost function, instantiate the decorator, set the wrapped cost function (that will be extended) and set a constraint checker that defines the type of constraints.
The decorator has a failure threshold. An evaluation can always be accounted as a failure if the sum of penalties given by the checker is greater or equal to the threshold. If the evaluation is a failure the wrapped cost function will not be evaluated. Otherwise the penalty will be added to every measure of the cost function.
Definition at line 37 of file mitkMVConstrainedCostFunctionDecorator.h.
typedef itk::SmartPointer< const Self > mitk::MVConstrainedCostFunctionDecorator::ConstPointer |
Definition at line 44 of file mitkMVConstrainedCostFunctionDecorator.h.
typedef ConstraintCheckerBase::PenaltyValueType mitk::MVConstrainedCostFunctionDecorator::PenaltyValueType |
Definition at line 49 of file mitkMVConstrainedCostFunctionDecorator.h.
Definition at line 43 of file mitkMVConstrainedCostFunctionDecorator.h.
Definition at line 41 of file mitkMVConstrainedCostFunctionDecorator.h.
Definition at line 46 of file mitkMVConstrainedCostFunctionDecorator.h.
Definition at line 42 of file mitkMVConstrainedCostFunctionDecorator.h.
|
inlineprotected |
Definition at line 81 of file mitkMVConstrainedCostFunctionDecorator.h.
|
inlineoverrideprotected |
Definition at line 86 of file mitkMVConstrainedCostFunctionDecorator.h.
|
overrideprotectedvirtual |
Implements mitk::MVModelFitCostFunction.
|
virtual |
|
virtual |
|
virtual |
Returns the number of evaluations done by the cost function instance since creation.
ParametersType::size_type mitk::MVConstrainedCostFunctionDecorator::GetFailedParameter | ( | ) | const |
Returns the index of the first (in terms of index position) failed parameter in the last failed evaluation.
double mitk::MVConstrainedCostFunctionDecorator::GetFailureRatio | ( | ) | const |
Returns the ration between evaluations that where beyond the failure thershold and all evaluation since creation of the instance. 0.0 means no evaluation was a failure (but some may be penalized); 1.0 all evaluations were failures.
|
virtual |
double mitk::MVConstrainedCostFunctionDecorator::GetPenaltyRatio | ( | ) | const |
Returns the ration between evaluations that were penaltized and all evaluation since creation of the instance. 0.0 means no evaluation was penalized; 1.0 all evaluations were. (evaluations that hit the failure threshold count as penalized too.)
|
virtual |
|
static |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
protected |
Definition at line 91 of file mitkMVConstrainedCostFunctionDecorator.h.
|
protected |
Definition at line 88 of file mitkMVConstrainedCostFunctionDecorator.h.
|
mutableprotected |
Definition at line 92 of file mitkMVConstrainedCostFunctionDecorator.h.
|
mutableprotected |
Definition at line 94 of file mitkMVConstrainedCostFunctionDecorator.h.
|
protected |
Definition at line 90 of file mitkMVConstrainedCostFunctionDecorator.h.
|
mutableprotected |
Definition at line 95 of file mitkMVConstrainedCostFunctionDecorator.h.
|
mutableprotected |
Definition at line 93 of file mitkMVConstrainedCostFunctionDecorator.h.
|
protected |
Definition at line 89 of file mitkMVConstrainedCostFunctionDecorator.h.