locan.process.properties.locdata_statistics.range_from_collection¶
- locan.process.properties.locdata_statistics.range_from_collection(locdatas, loc_properties=None, special=None, epsilon=1)[source]¶
Compute the maximum range from all combined localizations for each dimension.
- Parameters:
locdatas (
list[LocData]) – Collection of localization datasets.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 locdata.data 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:
A namedtuple(‘Ranges’, locdata.coordinate_keys) of namedtuple(‘Range’, ‘min max’).
- Return type:
namedtuple