uniform (pmrf.uniform)

pmrf.uniform(lower: Array | ndarray | bool | number | bool | int | float | complex, upper: Array | ndarray | bool | number | bool | int | float | complex, *, constraint: AbstractConstraint | None = None, value: Array | ndarray | bool | number | bool | int | float | complex | None = None, fixed: bool = False, name: str | None = None, scale: float | None = None, metadata: Any | None = None) → Param

Create a random parameter with a uniform prior in declared space.

Unlike pmrf.bounded(), this parameter has a prior. The arguments are passed to pmrf.stats.distributions.Uniform and pmrf.random().

Parameters:
  • lower (ArrayLike) – The prior’s bounds in declared space.

  • upper (ArrayLike) – The prior’s bounds in declared space.

  • constraint (AbstractConstraint, optional) – An additional range to truncate the prior to.

  • value (ArrayLike, optional) – Initial declared value; defaults to the prior mean.

  • fixed (bool, optional) – Whether the parameter is fixed.

  • name (str, optional) – Parameter name.

  • scale (float, optional) – Units multiplier from declared to physical space.

  • metadata (Any, optional) – Arbitrary metadata.

Returns:

The random parameter.

Return type:

pmrf.Param