mitkMVConstrainedCostFunctionDecorator.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MV_CONSTRAINED_COST_FUNCTION_DECORATOR_H
#define MV_CONSTRAINED_COST_FUNCTION_DECORATOR_H

#include <mitkMVModelFitCostFunction.h>
#include <mitkConstraintCheckerBase.h>

#include "MitkModelFitExports.h"

namespace mitk
{

class MITKMODELFIT_EXPORT MVConstrainedCostFunctionDecorator : public mitk::MVModelFitCostFunction
{
public:

    typedef MVConstrainedCostFunctionDecorator Self;
    typedef mitk::MVModelFitCostFunction Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;

    itkNewMacro(Self);

    typedef Superclass::SignalType SignalType;
    typedef ConstraintCheckerBase::PenaltyValueType PenaltyValueType;

    itkSetConstObjectMacro(WrappedCostFunction, MVModelFitCostFunction);
    itkGetConstObjectMacro(WrappedCostFunction, MVModelFitCostFunction);

    itkSetConstObjectMacro(ConstraintChecker, ConstraintCheckerBase);
    itkGetConstObjectMacro(ConstraintChecker, ConstraintCheckerBase);

    itkSetMacro(FailureThreshold, PenaltyValueType);
    itkGetConstMacro(FailureThreshold, PenaltyValueType);
    itkSetMacro(ActivateFailureThreshold, bool);
    itkGetConstMacro(ActivateFailureThreshold, bool);

    itkGetConstMacro(EvaluationCount, unsigned int);

    double GetPenaltyRatio() const;
    double GetFailureRatio() const;

    ParametersType::size_type GetFailedParameter() const;
protected:

    MeasureType CalcMeasure(const ParametersType &parameters, const SignalType& signal) const override;

    MVConstrainedCostFunctionDecorator() : m_FailureThreshold(1e15), m_ActivateFailureThreshold(true),
      m_EvaluationCount(0), m_PenaltyCount(0), m_FailureCount(0), m_LastFailedParameter(-1)
    {
    }

    ~MVConstrainedCostFunctionDecorator() override{}

    ConstraintCheckerBase::ConstPointer m_ConstraintChecker;
    MVModelFitCostFunction::ConstPointer m_WrappedCostFunction;
    PenaltyValueType m_FailureThreshold;
    bool m_ActivateFailureThreshold;
    mutable unsigned int m_EvaluationCount;
    mutable unsigned int m_PenaltyCount;
    mutable unsigned int m_FailureCount;
    mutable ParametersType::size_type m_LastFailedParameter;
};

}

#endif