Medical Imaging Interaction Toolkit  2024.06.99-b3904305
Medical Imaging Interaction Toolkit
mitk::ConstraintCheckerBase Class Reference

This class is the base class for constraint checker. More...

#include <mitkConstraintCheckerBase.h>

Inheritance diagram for mitk::ConstraintCheckerBase:
Collaboration diagram for mitk::ConstraintCheckerBase:

Public Types

typedef ConstraintCheckerBase Self
typedef ConstraintCheckerInterface Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer
typedef Superclass::PenaltyValueType PenaltyValueType
typedef Superclass::PenaltyArrayType PenaltyArrayType
typedef Superclass::SignalType SignalType
typedef Superclass::ParametersType ParametersType
- Public Types inherited from mitk::ConstraintCheckerInterface
typedef ConstraintCheckerInterface Self
typedef double PenaltyValueType
typedef itk::Array< PenaltyValueTypePenaltyArrayType
typedef itk::Array< double > SignalType
typedef ModelBase::ParametersType ParametersType

Public Member Functions

PenaltyValueType GetPenaltySum (const ParametersType &parameters) const override
- Public Member Functions inherited from mitk::ConstraintCheckerInterface
virtual PenaltyArrayType GetPenalties (const ParametersType &parameters) const =0
virtual unsigned int GetNumberOfConstraints () const =0
virtual PenaltyValueType GetFailedConstraintValue () const =0

Protected Member Functions

 ConstraintCheckerBase ()
 ~ConstraintCheckerBase () override
- Protected Member Functions inherited from mitk::ConstraintCheckerInterface
 ConstraintCheckerInterface ()
virtual ~ConstraintCheckerInterface ()

Detailed Description

This class is the base class for constraint checker.

All functions of the ConstraintCheckerInterface must be implemented thread save because it will be used in a multi threaded environment.

Definition at line 31 of file mitkConstraintCheckerBase.h.

Member Typedef Documentation

◆ ConstPointer

◆ ParametersType

◆ PenaltyArrayType

◆ PenaltyValueType

◆ Pointer

◆ Self

◆ SignalType

◆ Superclass

Constructor & Destructor Documentation

◆ ConstraintCheckerBase()

mitk::ConstraintCheckerBase::ConstraintCheckerBase ( )

Definition at line 49 of file mitkConstraintCheckerBase.h.

◆ ~ConstraintCheckerBase()

mitk::ConstraintCheckerBase::~ConstraintCheckerBase ( )

Definition at line 53 of file mitkConstraintCheckerBase.h.

Member Function Documentation

◆ GetPenaltySum()

PenaltyValueType mitk::ConstraintCheckerBase::GetPenaltySum ( const ParametersType parameters) const

Returns the sum of all penalties.

defined constraints must address valid parameters in the passed parameters set.

Implements mitk::ConstraintCheckerInterface.

The documentation for this class was generated from the following file: