sparty.pp.subsetSamples

Contents

sparty.pp.subsetSamples#

sparty.pp.subsetSamples(sdata, sample, regions, manip, fov_locations, scale_factor=0.2125, region='cell_boundaries', techno='Xenium')#

Subset SpatialData object based on specified regions and sample.

Parameters:
  • sdata (SpatialData) – SpatialData object.

  • sample (str) – Sample identifier.

  • regions (list) – List of regions to subset.

  • manip (dict) – Dictionary containing manipulation metadata.

  • fov_locations (DataFrame) – DataFrame containing field of view locations.

  • scale_factor (float (default: 0.2125)) – Scale factor to convert pixel dimensions to microns.

  • region (str (default: 'cell_boundaries')) – Region key in SpatialData object.

  • techno (str (default: 'Xenium')) – Technology type (e.g., ‘Xenium’).

Return type:

SpatialData

Returns:

sd.SpatialData Subsetted SpatialData object.