gemd.entity.value.normal_real module

A normally distributed real value.

class gemd.entity.value.normal_real.NormalReal(mean=None, std=None, units=None)

Bases: ContinuousValue

Normal distribution over real numbers, parameterized by a mean and standard deviation.

Parameters
  • mean (float) – Mean of the distribution.

  • std (float) – Standard deviation of the normal distribution.

  • units (str) – A string describing the units. Units must be present and they must be parseable by Pint. An empty string can be used for the units of a dimensionless quantity.

as_dict() Dict[str, Any]

Convert the object to a dictionary.

Returns

A dictionary representation of the object, where the keys are its fields.

Return type

dict

static build(d: Mapping[str, Any]) DictSerializableType

Build an object from a JSON dictionary.

This differs from from_dict in that the values themselves may also be dictionaries corresponding to serialized DictSerializable objects.

Parameters

d (dict) – The object as a serialized dictionary.

Returns

The deserialized object.

Return type

DictSerializable

dump() Dict[str, Any]

Convert the object to a JSON dictionary, so that every entry is serialized.

Uses the json encoder client, so objects with uids are converted to LinkByUID dictionaries.

Returns

A string representation of the object as a dictionary.

Return type

str

classmethod from_dict(d: Mapping[str, Any]) DictSerializableType

Reconstitute the object from a dictionary.

Parameters

d (dict) – The object as a dictionary of key-value pairs that correspond to the object’s fields.

Returns

The deserialized object.

Return type

DictSerializable

skip = {}
typ = 'normal_real'
property units: str

Get the units of the value.