Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
mitk::SimpleBarrierConstraintChecker Class Reference

This class implements constraints as simple barrier functions. More...

#include <mitkSimpleBarrierConstraintChecker.h>

Inheritance diagram for mitk::SimpleBarrierConstraintChecker:
Inheritance graph
[legend]
Collaboration diagram for mitk::SimpleBarrierConstraintChecker:
Collaboration graph
[legend]

Classes

struct  Constraint
 

Public Types

typedef SimpleBarrierConstraintChecker Self
 
typedef ConstraintCheckerBase Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
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
 
- Public Types inherited from mitk::ConstraintCheckerBase
typedef ConstraintCheckerBase Self
 
typedef ConstraintCheckerInterface Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
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< PenaltyValueType > PenaltyArrayType
 
typedef itk::Array< double > SignalType
 
typedef ModelBase::ParametersType ParametersType
 

Public Member Functions

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)
 
Constraint & GetConstraint (unsigned int index)
 
const Constraint & GetConstraint (unsigned int index) const
 
void DeleteConstraint (unsigned int index)
 
void ResetConstraints ()
 
virtual void SetMaxConstraintPenalty (PenaltyValueType _arg)
 
virtual PenaltyValueType GetMaxConstraintPenalty () const
 
- Public Member Functions inherited from mitk::ConstraintCheckerBase
PenaltyValueType GetPenaltySum (const ParametersType &parameters) const override
 
- Public Member Functions inherited from mitk::ConstraintCheckerInterface
virtual PenaltyArrayType GetPenalties (const ParametersType &parameters) const =0
 

Static Public Member Functions

static Pointer New ()
 

Protected Types

typedef std::vector< Constraint > ConstraintVectorType
 

Protected Member Functions

PenaltyValueType CalcPenalty (const ParametersType &parameters, const Constraint &constraint) const
 
 SimpleBarrierConstraintChecker ()
 
 ~SimpleBarrierConstraintChecker () override
 
- Protected Member Functions inherited from mitk::ConstraintCheckerBase
 ConstraintCheckerBase ()
 
 ~ConstraintCheckerBase () override
 
- Protected Member Functions inherited from mitk::ConstraintCheckerInterface
 ConstraintCheckerInterface ()
 
virtual ~ConstraintCheckerInterface ()
 

Protected Attributes

ConstraintVectorType m_Constraints
 

Detailed Description

This class implements constraints as simple barrier functions.

SimpleBarrierConstraintChecker is used to check parameters against inequality constraints realized as simple barrier functions.
Inequality constraints will be transformed to an inequality greater or equal zero (c(x)>= 0). The BarrierSize indicates the size of the region in front of the border of the legal value range. The barrier function is modelled by log(c(x)/BarrierSize).
Example:
The given constraint is 500<= param_1. Its barriersize is 50, so the barrier region is between 500 and 550.
The constraint will be transformed in 0 <= param_1 - 500. The barrier function will 0 for any param_1 > 550 and min(-log((param_1 - 500)/50), MaxConstraintPenalty) for any other value of param_1.
If you have set a sum barrier, it will be checked against the value sum of the specified parameters.

Definition at line 42 of file mitkSimpleBarrierConstraintChecker.h.

Member Typedef Documentation

◆ BarrierValueType

typedef double mitk::SimpleBarrierConstraintChecker::BarrierValueType

Definition at line 57 of file mitkSimpleBarrierConstraintChecker.h.

◆ BarrierWidthType

typedef double mitk::SimpleBarrierConstraintChecker::BarrierWidthType

Definition at line 58 of file mitkSimpleBarrierConstraintChecker.h.

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::SimpleBarrierConstraintChecker::ConstPointer

Definition at line 48 of file mitkSimpleBarrierConstraintChecker.h.

◆ ConstraintVectorType

typedef std::vector<Constraint> mitk::SimpleBarrierConstraintChecker::ConstraintVectorType
protected

Definition at line 105 of file mitkSimpleBarrierConstraintChecker.h.

◆ ParameterIndexType

typedef ParametersType::SizeValueType mitk::SimpleBarrierConstraintChecker::ParameterIndexType

Definition at line 59 of file mitkSimpleBarrierConstraintChecker.h.

◆ ParameterIndexVectorType

typedef std::vector<ParameterIndexType> mitk::SimpleBarrierConstraintChecker::ParameterIndexVectorType

Definition at line 60 of file mitkSimpleBarrierConstraintChecker.h.

◆ ParametersType

typedef Superclass::ParametersType mitk::SimpleBarrierConstraintChecker::ParametersType

Definition at line 55 of file mitkSimpleBarrierConstraintChecker.h.

◆ PenaltyArrayType

typedef Superclass::PenaltyArrayType mitk::SimpleBarrierConstraintChecker::PenaltyArrayType

Definition at line 53 of file mitkSimpleBarrierConstraintChecker.h.

◆ PenaltyValueType

typedef Superclass::PenaltyValueType mitk::SimpleBarrierConstraintChecker::PenaltyValueType

Definition at line 50 of file mitkSimpleBarrierConstraintChecker.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::SimpleBarrierConstraintChecker::Pointer

Definition at line 47 of file mitkSimpleBarrierConstraintChecker.h.

◆ Self

typedef SimpleBarrierConstraintChecker mitk::SimpleBarrierConstraintChecker::Self

Definition at line 45 of file mitkSimpleBarrierConstraintChecker.h.

◆ SignalType

typedef Superclass::SignalType mitk::SimpleBarrierConstraintChecker::SignalType

Definition at line 54 of file mitkSimpleBarrierConstraintChecker.h.

◆ Superclass

typedef ConstraintCheckerBase mitk::SimpleBarrierConstraintChecker::Superclass

Definition at line 46 of file mitkSimpleBarrierConstraintChecker.h.

Constructor & Destructor Documentation

◆ SimpleBarrierConstraintChecker()

mitk::SimpleBarrierConstraintChecker::SimpleBarrierConstraintChecker ( )
inlineprotected

Definition at line 114 of file mitkSimpleBarrierConstraintChecker.h.

◆ ~SimpleBarrierConstraintChecker()

mitk::SimpleBarrierConstraintChecker::~SimpleBarrierConstraintChecker ( )
inlineoverrideprotected

Definition at line 118 of file mitkSimpleBarrierConstraintChecker.h.

Member Function Documentation

◆ CalcPenalty()

mitk::SimpleBarrierConstraintChecker::PenaltyValueType mitk::SimpleBarrierConstraintChecker::CalcPenalty ( const ParametersType &  parameters,
const Constraint &  constraint 
) const
protected

Definition at line 143 of file mitkSimpleBarrierConstraintChecker.cpp.

References mitk::SimpleBarrierConstraintChecker::Constraint::barrier, min(), mitkThrow, mitk::SimpleBarrierConstraintChecker::Constraint::parameters, mitk::SimpleBarrierConstraintChecker::Constraint::upperBarrier, and mitk::SimpleBarrierConstraintChecker::Constraint::width.

Referenced by GetPenalties().

◆ DeleteConstraint()

void mitk::SimpleBarrierConstraintChecker::DeleteConstraint ( unsigned int  index)

Definition at line 126 of file mitkSimpleBarrierConstraintChecker.cpp.

References GetNumberOfConstraints(), and m_Constraints.

◆ GetConstraint() [1/2]

mitk::SimpleBarrierConstraintChecker::Constraint & mitk::SimpleBarrierConstraintChecker::GetConstraint ( unsigned int  index)

Definition at line 101 of file mitkSimpleBarrierConstraintChecker.cpp.

References GetNumberOfConstraints(), m_Constraints, and mitkThrow.

◆ GetConstraint() [2/2]

const mitk::SimpleBarrierConstraintChecker::Constraint & mitk::SimpleBarrierConstraintChecker::GetConstraint ( unsigned int  index) const

Definition at line 114 of file mitkSimpleBarrierConstraintChecker.cpp.

References GetNumberOfConstraints(), m_Constraints, and mitkThrow.

◆ GetFailedConstraintValue()

mitk::SimpleBarrierConstraintChecker::PenaltyValueType mitk::SimpleBarrierConstraintChecker::GetFailedConstraintValue ( ) const
overridevirtual

Returns the penalty value that indicates at least one failed constrained.

Implements mitk::ConstraintCheckerInterface.

Definition at line 41 of file mitkSimpleBarrierConstraintChecker.cpp.

◆ GetMaxConstraintPenalty()

virtual PenaltyValueType mitk::SimpleBarrierConstraintChecker::GetMaxConstraintPenalty ( ) const
virtual

◆ GetNumberOfConstraints()

unsigned int mitk::SimpleBarrierConstraintChecker::GetNumberOfConstraints ( ) const
overridevirtual

Returns the number of defined constraints, that will be checked. Thus also the size of the penalty vector.

Implements mitk::ConstraintCheckerInterface.

Definition at line 35 of file mitkSimpleBarrierConstraintChecker.cpp.

References m_Constraints.

Referenced by DeleteConstraint(), and GetConstraint().

◆ GetPenalties()

mitk::SimpleBarrierConstraintChecker::PenaltyArrayType mitk::SimpleBarrierConstraintChecker::GetPenalties ( const ParametersType &  parameters) const
override

Definition at line 20 of file mitkSimpleBarrierConstraintChecker.cpp.

References CalcPenalty(), and m_Constraints.

◆ New()

static Pointer mitk::SimpleBarrierConstraintChecker::New ( )
static

Referenced by mitk::StandardToftsModelFactory::CreateDefaultConstraints(), mitk::OneTissueCompartmentModelFactory::CreateDefaultConstraints(), mitk::TwoTissueCompartmentFDGModelFactory::CreateDefaultConstraints(), mitk::TwoTissueCompartmentModelFactoryBase< NumericTwoTissueCompartmentModelParameterizer >::CreateDefaultConstraints(), mitk::ExtendedToftsModelFactory::CreateDefaultConstraints(), mitk::T2DecayModelFactory::CreateDefaultConstraints(), mitk::TwoCompartmentExchangeModelFactoryBase< TwoCompartmentExchangeModelParameterizer >::CreateDefaultConstraints(), mitk::ExtendedOneTissueCompartmentModelFactory::CreateDefaultConstraints(), mitkMVConstrainedCostFunctionDecoratorTest(), mitkSimpleBarrierConstraintCheckerTest(), QmitkSimpleBarrierModel::QmitkSimpleBarrierModel(), and QmitkSimpleBarrierModel::setChecker().

◆ ResetConstraints()

void mitk::SimpleBarrierConstraintChecker::ResetConstraints ( )

Definition at line 137 of file mitkSimpleBarrierConstraintChecker.cpp.

References m_Constraints.

◆ SetLowerBarrier()

void mitk::SimpleBarrierConstraintChecker::SetLowerBarrier ( ParameterIndexType  parameterID,
BarrierValueType  barrier,
BarrierWidthType  width = 0.0 
)

Sets a lower barrier for one parameter

Definition at line 46 of file mitkSimpleBarrierConstraintChecker.cpp.

References mitk::SimpleBarrierConstraintChecker::Constraint::barrier, m_Constraints, mitk::SimpleBarrierConstraintChecker::Constraint::parameters, mitk::SimpleBarrierConstraintChecker::Constraint::upperBarrier, and mitk::SimpleBarrierConstraintChecker::Constraint::width.

◆ SetLowerSumBarrier()

void mitk::SimpleBarrierConstraintChecker::SetLowerSumBarrier ( const ParameterIndexVectorType &  parameterIDs,
BarrierValueType  barrier,
BarrierWidthType  width = 0.0 
)

Sets a lower sum barrier for a set of parameter

Definition at line 74 of file mitkSimpleBarrierConstraintChecker.cpp.

References mitk::SimpleBarrierConstraintChecker::Constraint::barrier, m_Constraints, mitk::SimpleBarrierConstraintChecker::Constraint::parameters, mitk::SimpleBarrierConstraintChecker::Constraint::upperBarrier, and mitk::SimpleBarrierConstraintChecker::Constraint::width.

◆ SetMaxConstraintPenalty()

virtual void mitk::SimpleBarrierConstraintChecker::SetMaxConstraintPenalty ( PenaltyValueType  _arg)
virtual

◆ SetUpperBarrier()

void mitk::SimpleBarrierConstraintChecker::SetUpperBarrier ( ParameterIndexType  parameterID,
BarrierValueType  barrier,
BarrierWidthType  width = 0.0 
)

Sets an upper barrier for one parameter

Definition at line 60 of file mitkSimpleBarrierConstraintChecker.cpp.

References mitk::SimpleBarrierConstraintChecker::Constraint::barrier, m_Constraints, mitk::SimpleBarrierConstraintChecker::Constraint::parameters, mitk::SimpleBarrierConstraintChecker::Constraint::upperBarrier, and mitk::SimpleBarrierConstraintChecker::Constraint::width.

◆ SetUpperSumBarrier()

void mitk::SimpleBarrierConstraintChecker::SetUpperSumBarrier ( const ParameterIndexVectorType &  parameterIDs,
BarrierValueType  barrier,
BarrierWidthType  width = 0.0 
)

Sets an upper sum barrier for a set of parameter

Definition at line 87 of file mitkSimpleBarrierConstraintChecker.cpp.

References mitk::SimpleBarrierConstraintChecker::Constraint::barrier, m_Constraints, mitk::SimpleBarrierConstraintChecker::Constraint::parameters, mitk::SimpleBarrierConstraintChecker::Constraint::upperBarrier, and mitk::SimpleBarrierConstraintChecker::Constraint::width.

Member Data Documentation

◆ m_Constraints

ConstraintVectorType mitk::SimpleBarrierConstraintChecker::m_Constraints
protected

Definition at line 110 of file mitkSimpleBarrierConstraintChecker.h.

Referenced by DeleteConstraint(), GetConstraint(), GetNumberOfConstraints(), GetPenalties(), ResetConstraints(), SetLowerBarrier(), SetLowerSumBarrier(), SetUpperBarrier(), and SetUpperSumBarrier().

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