bento.ut.get_points

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

Get points DataFrame synced to AnnData object.

Parameters:
  • data (SpatialData) – Spatial formatted SpatialData object

  • key (str, optional) – Key for data.points to use, by default “transcripts”

  • astype (str, optional) – Whether to return a ‘pandas’ DataFrame, ‘dask’ DataFrame, or ‘geopandas’ GeoDataFrame, by default “pandas”

  • sync (bool, optional) – Whether to set and retrieve points synced to instance_key shape. Default True.

Returns:

Returns data.points[key] as a [Geo]DataFrame or ‘Dask DataFrame’

Return type:

DataFrame or GeoDataFrame