openlifu.plan.param_constraint.ParameterConstraint

class openlifu.plan.param_constraint.ParameterConstraint(operator: "Annotated[Literal['<', '<=', '>', '>=', 'within', 'inside', 'outside', 'outside_inclusive'], OpenLIFUFieldData('Constraint operator', 'Constraint operator used to evaluate parameter values')]", warning_value: "Annotated[float | int | Tuple[float | int, float | int] | None, OpenLIFUFieldData('Warning value', 'Threshold or range that triggers a warning')]" = None, error_value: "Annotated[float | int | Tuple[float | int, float | int] | None, OpenLIFUFieldData('Error value', 'Threshold or range that triggers an error')]" = None)

Bases: DictMixin

error_value: Annotated[float | int | Tuple[float | int, float | int] | None, OpenLIFUFieldData(name='Error value', description='Threshold or range that triggers an error')] = None

Threshold or range that triggers an error

operator: Annotated[Literal['<', '<=', '>', '>=', 'within', 'inside', 'outside', 'outside_inclusive'], OpenLIFUFieldData(name='Constraint operator', description='Constraint operator used to evaluate parameter values')]

Constraint operator used to evaluate parameter values

to_table() → DataFrame

Convert the parameter constraint to a table format.

warning_value: Annotated[float | int | Tuple[float | int, float | int] | None, OpenLIFUFieldData(name='Warning value', description='Threshold or range that triggers a warning')] = None

Threshold or range that triggers a warning