bento.ut.get_points

bento.ut.get_points(sdata, points_key='transcripts', astype='pandas', sync=True) DataFrame | DataFrame | GeoDataFrame

Get points data synchronized with cell boundaries.

Parameters:
  • sdata (SpatialData) – Input SpatialData object

  • points_key (str, default “transcripts”) – Key for points in sdata.points

  • astype (str, default “pandas”) – Return type: ‘pandas’, ‘dask’, or ‘geopandas’

  • sync (bool, default True) – Whether to sync points with instance_key shapes

Returns:

Points data in requested format

Return type:

Union[pd.DataFrame, dd.DataFrame, gpd.GeoDataFrame]

Raises:

ValueError – If points_key not found or invalid astype