mitkConstraintCheckerInterface.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 CONSTRAINTCHECKER_INTERFACE_H
#define CONSTRAINTCHECKER_INTERFACE_H

#include "mitkModelBase.h"

#include "MitkModelFitExports.h"

namespace mitk
{
  class MITKMODELFIT_EXPORT ConstraintCheckerInterface
  {
  public:

    typedef ConstraintCheckerInterface Self;

    typedef double PenaltyValueType;
    typedef itk::Array<PenaltyValueType> PenaltyArrayType;
    typedef itk::Array<double> SignalType;
    typedef ModelBase::ParametersType ParametersType;

    virtual PenaltyArrayType GetPenalties(const ParametersType &parameters) const = 0;

    virtual PenaltyValueType GetPenaltySum(const ParametersType &parameters) const = 0;

    virtual unsigned int GetNumberOfConstraints() const = 0;

    virtual PenaltyValueType GetFailedConstraintValue() const = 0;

  protected:

    ConstraintCheckerInterface()
    {}

    virtual ~ConstraintCheckerInterface()
    {}

  private:
    ConstraintCheckerInterface(const ConstraintCheckerInterface& source);
    void operator=(const ConstraintCheckerInterface&);  //purposely not implemented
  };

}

#endif // MODELFITCOSTFUNCTION_H