ewoksfluo.units.convert_units_to_group_reference#

ewoksfluo.units.convert_units_to_group_reference(values, units, reference_units='first')[source]#

Convert values so that units sharing the same dimensionality are expressed in a common (reference) unit.

The reference unit is the first occurrence in each group.

Example:

units = [“um”, “mm”, “deg”, “rad”] -> [“um”, “um”, “deg”, “deg”]

Parameters:

  • values (Sequence[ndarray]) – sequence of numpy arrays (one per axis)

  • units (Sequence[Optional[str]]) – sequence of unit strings

  • reference_units (Literal['first', 'largest', 'smallest'])

Return type:

Tuple[List[ndarray], List[str]]

Returns:

(converted_values, normalized_units)