locan.data.properties.misc.distance_to_region#

locan.data.properties.misc.distance_to_region(locdata, region)[source]#

Determine the distance to the nearest point within region for all localizations. Returns zero if localization is within the region.

Parameters:

  • locdata (LocData) – Localizations for which distances are determined.

  • region (Region) – Region from which the closest point is selected.

Returns:

Distance for each localization.

Return type:

npt.NDArray[np.float64]