normal

pmrf.parameters.normal(loc: Array | ndarray | bool | number | bool | int | float | complex, sigma: 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 normal prior in declared space.

sigma is the distribution’s standard deviation. scale sets the parameter’s units. The distribution is in declared space.

Parameters:
  • loc (ArrayLike) – Prior location in declared space.

  • sigma (ArrayLike) – Prior standard deviation in declared space.

  • constraint (AbstractConstraint, optional) – A 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