locan.process.properties.locdata_statistics.ranges

locan.process.properties.locdata_statistics.ranges(locdata, loc_properties=None, special=None, epsilon=1)[source]

Provide data ranges for localization properties. If LocData is empty, None is returned. If LocData carries a single localization, the range will be (value, value + epsilon).

Parameters:

  • locdata (LocData) – Localization data.

  • loc_properties (Union[str, Iterable[str], Literal[True], None]) – Localization properties for which the range is determined. If None the ranges for all spatial coordinates are returned. If True the ranges for all localization properties are returned.

  • special (Optional[Literal['zero', 'link']]) – If None (min, max) ranges are determined from data and returned; if ‘zero’ (0, max) ranges with max determined from data are returned. if ‘link’ (min_all, max_all) ranges with min and max determined from all combined data are returned.

  • epsilon (float) – number to specify the range for single values in locdata.

Returns:

The data range (min, max) for each localization property. Array of shape (dimension, 2).

Return type:

npt.NDArray[np.float64] | None