ewoksfluo.units.convert_units_to_group_reference#

ewoksfluo.units.convert_units_to_group_reference(values, units, reference_units=None, fallback='smallest')[source]#

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

Priority: 1. Use explicit reference_units mapping per dimensionality 2. Otherwise fallback to strategy (“first”, “largest”, “smallest”)

Example:

units = [“um”, “mm”, “deg”, “rad”] reference_units = {“[angle]”: “deg”} fallback = “largest”

-> [“mm”, “mm”, “deg”, “deg”]

Parameters:

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

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

  • reference_units (Optional[Dict[str, str]]) – mapping dimensionality -> unit

  • fallback (Optional[Literal['first', 'largest', 'smallest']]) – strategy for unspecified dimensionalities

Return type:

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

Returns:

(converted_values, normalized_units)