Constrained (pmrf.Constrained)

pmrf.Constrained(constraint: AbstractConstraint, value: Array | ndarray | bool | number | bool | int | float | complex, *, scale: float = 1.0, fixed: bool = False) → Param

Create a parameter constrained to a specific domain.

See pmrf.constraints for built-in constraints.

Parameters:

  • constraint (AbstractConstraint) – The constraint to apply to the parameter.

  • value (ArrayLike) – The initial value of the parameter.

  • scale (float, optional) – The scaling factor to apply, by default 1.0.

  • fixed (bool, optional) – Whether to freeze the parameter, by default False.

Returns:

The constrained parameter.

Return type:

pmrf.Param