scispy.tl.get_sdata_polygon

scispy.tl.get_sdata_polygon#

scispy.tl.get_sdata_polygon(sdata, shape_key='myshapes', polygon_name_key='name', polygon_name=None, color_key='celltype', target_coordinates='microns', figsize=(8, 2))#

SpatialData polygon object using sd.polygon_query()

Parameters:

  • sdata (SpatialData) – SpatialData object.

  • shape_key (str (default: 'myshapes')) – sdata shape element key where to locate the polygon object

  • polygon_name_key (str (default: 'name')) – polygon name key in the sdata shape element

  • polygon_name (Optional[str] (default: None)) – polygon name

  • color_key (str (default: 'celltype')) – color key for UMAP plot, needed to sync sdata.table.uns[color_key + “_colors”]

  • target_coordinates (str (default: 'microns')) – target_coordinates system of sdata object

  • figsize (tuple (default: (8, 2))) – figure size

Return type:

SpatialData

Returns:

sdata polygon object.

Contents