rxmc.params.Parameter#

class rxmc.params.Parameter(name, dtype=<class 'float'>, unit='', latex_name=None, bounds=(-inf, inf))[source]#

Bases: object

A single scalar model parameter.

Parameters:

  • name (str) – Human-readable name of the parameter.

  • dtype (type, optional) – Data type of the parameter value. Defaults to float.

  • unit (str, optional) – Physical unit string (e.g. "MeV"). Defaults to "".

  • latex_name (str, optional) – LaTeX representation used in plots and documentation. Defaults to name when not supplied.

  • bounds (tuple of float, optional) – (lower, upper) bounds for the parameter. Defaults to (-np.inf, np.inf). Stored as a tuple of floats.

Notes

Equality and hashing are by value (all five fields), so equal parameters are interchangeable as dict keys and set members. Sharing one sampled value between covariance terms is by object identity (see rxmc.covariance); two equal-but-distinct parameters are two parameters.

__init__(name, dtype=<class 'float'>, unit='', latex_name=None, bounds=(-inf, inf))[source]#

Methods

__init__(name[, dtype, unit, latex_name, bounds])