locan.process.properties.misc.distance_to_point

locan.process.properties.misc.distance_to_point(locdata, point)[source]

Determine the distance to the given point for all localizations.

Parameters:
  • locdata (Union[LocData, _Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]]) – Localizations for which distances are determined.

  • point (Union[_Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]]) – Single point.

Returns:

Distance for each localization.

Return type:

npt.NDArray[np.float64]