mitkSimpleBarrierConstraintChecker.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 SIMPLE_BARRIER_CONSTRAINT_CHECKER_H
#define SIMPLE_BARRIER_CONSTRAINT_CHECKER_H

#include "mitkConstraintCheckerBase.h"

#include "MitkModelFitExports.h"

namespace mitk
{

  class MITKMODELFIT_EXPORT SimpleBarrierConstraintChecker : public ConstraintCheckerBase
  {
  public:
    typedef SimpleBarrierConstraintChecker Self;
    typedef ConstraintCheckerBase Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;

    itkFactorylessNewMacro(Self);

    typedef Superclass::PenaltyValueType PenaltyValueType;
    typedef Superclass::PenaltyArrayType PenaltyArrayType;
    typedef Superclass::SignalType SignalType;
    typedef Superclass::ParametersType ParametersType;

    typedef double BarrierValueType;
    typedef double BarrierWidthType;
    typedef ParametersType::SizeValueType ParameterIndexType;
    typedef std::vector<ParameterIndexType> ParameterIndexVectorType;

    struct Constraint
    {
      ParameterIndexVectorType parameters;
      BarrierValueType barrier;
      BarrierWidthType width;
      bool upperBarrier;
      Constraint(): barrier(0), width(0), upperBarrier(true)
      {};
    };

    PenaltyArrayType GetPenalties(const ParametersType& parameters) const override;

    unsigned int GetNumberOfConstraints() const override;

    PenaltyValueType GetFailedConstraintValue() const override;

    void SetLowerBarrier(ParameterIndexType parameterID, BarrierValueType barrier,
                         BarrierWidthType width = 0.0);
    void SetUpperBarrier(ParameterIndexType parameterID, BarrierValueType barrier,
                         BarrierWidthType width = 0.0);
    void SetLowerSumBarrier(const ParameterIndexVectorType& parameterIDs, BarrierValueType barrier,
                            BarrierWidthType width = 0.0);
    void SetUpperSumBarrier(const ParameterIndexVectorType& parameterIDs, BarrierValueType barrier,
                            BarrierWidthType width = 0.0);

    /*returns the constraint with the given index.
     @pre The index must exist.*/
    Constraint& GetConstraint(unsigned int index);
    /*returns the constraint with the given index.
     @pre The index must exist.*/
    const Constraint& GetConstraint(unsigned int index) const;

    /*removes a constraint. Indicated by the index. If the index does not exist,
     nothing will be removed and the state of the checker stays untouched.*/
    void DeleteConstraint(unsigned int index);

    void ResetConstraints();

    itkSetMacro(MaxConstraintPenalty, PenaltyValueType);
    itkGetConstMacro(MaxConstraintPenalty, PenaltyValueType);

  protected:

    typedef std::vector<Constraint> ConstraintVectorType;
    ConstraintVectorType m_Constraints;

    PenaltyValueType CalcPenalty(const ParametersType& parameters, const Constraint& constraint) const;

    SimpleBarrierConstraintChecker() : m_MaxConstraintPenalty(1e15)
    {
    }

    ~SimpleBarrierConstraintChecker() override {}

  private:
    PenaltyValueType m_MaxConstraintPenalty;
  };

}

#endif // SimpleBarrierConstraintChecker_H