locan.data.filter.localizations_in_cluster_regions#

locan.data.filter.localizations_in_cluster_regions(locdata, collection, hull_type=HullType.CONVEX_HULL)[source]#

Identify localizations from locdata within the regions of all collection elements.

Parameters:

  • locdata (LocData) – Localization data that is tested for being inside the region

  • collection (LocData | list[LocData]) – A set of Locdata objects collected in a collection or list.

  • hull_type (HullType | str) – The hull type for each LocData object that is used to define the region.

Returns:

A collection of LocData objects with all elements of locdata contained by the region.

Return type:

LocData