get_objs
get_objs ¶
get_objs(
area: GeoDataFrame | GeoSeries | Polygon,
objects: GeoDataFrame,
predicate: str = "intersects",
**kwargs: Any,
) -> gpd.GeoDataFrame
Select objects matching a spatial predicate against any input area.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
area
|
GeoDataFrame | GeoSeries | Polygon
|
Query geometries or a single polygon, in the same coordinate system and units as objects. Pixel coordinates remain pixel coordinates. |
required |
objects
|
GeoDataFrame
|
Indexed objects to select; geometry and attribute columns are preserved. |
required |
predicate
|
str
|
GeoPandas spatial-index predicate, applied from each area geometry to each object geometry. For example, "contains" selects objects contained by an area. |
'intersects'
|
**kwargs
|
Any
|
Additional arguments passed to the spatial-index query, including distance in the input coordinate units for "dwithin". |
{}
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Matching rows in their original positional order, with duplicate geometry |
GeoDataFrame
|
removed. An empty selection retains the object columns, index, and CRS. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the spatial-index predicate or its arguments are invalid. |
Examples:
>>> from histolytics.data import cervix_nuclei, cervix_tissue
>>> from histolytics.spatial_ops import get_objs
>>> # load the data
>>> nuc = cervix_nuclei()
>>> tis = cervix_tissue()
>>> # select the CIN tissue
>>> cin_tissue = tis[tis["class_name"] == "cin"]
>>>
>>> # select all the nuclei contained within CIN tissue
>>> nuc_within_cin = get_objs(cin_tissue, nuc, predicate="contains")
>>> print(nuc_within_cin.head(3))
geometry class_name
1 POLYGON ((906.01 5350.02, 906.01 5361, 908.01 ... connective
2 POLYGON ((866 5137.02, 862.77 5137.94, 860 513... squamous_epithel
3 POLYGON ((932 4777.02, 928 4778.02, 922.81 478... glandular_epithel
>>> ax = tis.plot(column="class_name", figsize=(5, 5), aspect=1, alpha=0.5)
>>> nuc_within_cin.plot(ax=ax, color="blue")
>>> ax.set_axis_off()
