sopa.segmentation.aggregate

sopa.segmentation.aggregation.overlay_segmentation(sdata, shapes_key, gene_column=None, area_ratio_threshold=0.25, image_key=None, save_table=False)

Overlay a segmentation on top of an existing segmentation

Parameters:

Name	Type	Description	Default
sdata	SpatialData	A SpatialData object	required
shapes_key	str	The key of the new shapes to be added	required
gene_column	str | None	Key of the points dataframe containing the genes names	None
area_ratio_threshold	float	Threshold between 0 and 1. For each original cell overlapping with a new cell, we compute the overlap-area/cell-area, if above the threshold the cell is removed.	0.25
image_key	str | None	Optional key of the original image	None
save_table	bool	Whether to save the new table on-disk or not	False

Source code in sopa/segmentation/aggregation.py

def overlay_segmentation(
    sdata: SpatialData,
    shapes_key: str,
    gene_column: str | None = None,
    area_ratio_threshold: float = 0.25,
    image_key: str | None = None,
    save_table: bool = False,
):
    """Overlay a segmentation on top of an existing segmentation

    Args:
        sdata: A `SpatialData` object
        shapes_key: The key of the new shapes to be added
        gene_column: Key of the points dataframe containing the genes names
        area_ratio_threshold: Threshold between 0 and 1. For each original cell overlapping with a new cell, we compute the overlap-area/cell-area, if above the threshold the cell is removed.
        image_key: Optional key of the original image
        save_table: Whether to save the new table on-disk or not
    """
    average_intensities = False

    if "table" in sdata.tables and SopaKeys.UNS_KEY in sdata.tables["table"].uns:
        sopa_attrs = sdata.tables["table"].uns[SopaKeys.UNS_KEY]

        if sopa_attrs[SopaKeys.UNS_HAS_TRANSCRIPTS]:
            assert gene_column is not None, "Need 'gene_column' argument to count transcripts"
        else:
            gene_column = gene_column
        average_intensities = sopa_attrs[SopaKeys.UNS_HAS_INTENSITIES]

    aggr = Aggregator(sdata, image_key=image_key, shapes_key=shapes_key)
    aggr.overlay_segmentation(
        gene_column=gene_column,
        average_intensities=average_intensities,
        area_ratio_threshold=area_ratio_threshold,
        save_table=save_table,
    )

sopa.segmentation.aggregation.average_channels(sdata, image_key=None, shapes_key=None, expand_radius_ratio=0)

Average channel intensities per cell.

Parameters:

Name	Type	Description	Default
sdata	SpatialData	A SpatialData object	required
image_key	str	Key of sdata containing the image. If only one images element, this does not have to be provided.	None
shapes_key	str	Key of sdata containing the cell boundaries. If only one shapes element, this does not have to be provided.	None
expand_radius_ratio	float	Cells polygons will be expanded by expand_radius_ratio * mean_radius. This help better aggregate boundary stainings.	0

Returns:

Type	Description
ndarray	A numpy ndarray of shape (n_cells, n_channels)

Source code in sopa/segmentation/aggregation.py

def average_channels(
    sdata: SpatialData,
    image_key: str = None,
    shapes_key: str = None,
    expand_radius_ratio: float = 0,
) -> np.ndarray:
    """Average channel intensities per cell.

    Args:
        sdata: A `SpatialData` object
        image_key: Key of `sdata` containing the image. If only one `images` element, this does not have to be provided.
        shapes_key: Key of `sdata` containing the cell boundaries. If only one `shapes` element, this does not have to be provided.
        expand_radius_ratio: Cells polygons will be expanded by `expand_radius_ratio * mean_radius`. This help better aggregate boundary stainings.

    Returns:
        A numpy `ndarray` of shape `(n_cells, n_channels)`
    """
    image = get_spatial_image(sdata, image_key)

    geo_df = get_spatial_element(sdata.shapes, key=shapes_key)
    geo_df = to_intrinsic(sdata, geo_df, image)
    geo_df = expand_radius(geo_df, expand_radius_ratio)

    log.info(f"Averaging channels intensity over {len(geo_df)} cells with expansion {expand_radius}")
    return _average_channels_aligned(image, geo_df)

sopa.segmentation.aggregation._average_channels_aligned(image, geo_df)

Average channel intensities per cell. The image and cells have to be aligned, i.e. be on the same coordinate system.

Parameters:

Name	Type	Description	Default
image	DataArray	A DataArray of shape (n_channels, y, x)	required
geo_df	GeoDataFrame | list[Polygon]	A GeoDataFrame whose geometries are cell boundaries (polygons)	required

Returns:

Type	Description
ndarray	A numpy ndarray of shape (n_cells, n_channels)

Source code in sopa/segmentation/aggregation.py

def _average_channels_aligned(image: DataArray, geo_df: gpd.GeoDataFrame | list[Polygon]) -> np.ndarray:
    """Average channel intensities per cell. The image and cells have to be aligned, i.e. be on the same coordinate system.

    Args:
        image: A `DataArray` of shape `(n_channels, y, x)`
        geo_df: A `GeoDataFrame` whose geometries are cell boundaries (polygons)

    Returns:
        A numpy `ndarray` of shape `(n_cells, n_channels)`
    """
    cells = geo_df if isinstance(geo_df, list) else list(geo_df.geometry)
    tree = shapely.STRtree(cells)

    intensities = np.zeros((len(cells), len(image.coords["c"])))
    areas = np.zeros(len(cells))

    chunk_sizes = image.data.chunks
    offsets_y = np.cumsum(np.pad(chunk_sizes[1], (1, 0), "constant"))
    offsets_x = np.cumsum(np.pad(chunk_sizes[2], (1, 0), "constant"))

    def _average_chunk_inside_cells(chunk, iy, ix):
        ymin, ymax = offsets_y[iy], offsets_y[iy + 1]
        xmin, xmax = offsets_x[ix], offsets_x[ix + 1]

        patch = box(xmin, ymin, xmax, ymax)
        intersections = tree.query(patch, predicate="intersects")

        for index in intersections:
            cell = cells[index]
            bounds = shapes.pixel_outer_bounds(cell.bounds)

            sub_image = chunk[
                :,
                max(bounds[1] - ymin, 0) : bounds[3] - ymin,
                max(bounds[0] - xmin, 0) : bounds[2] - xmin,
            ]

            if sub_image.shape[1] == 0 or sub_image.shape[2] == 0:
                continue

            mask = shapes.rasterize(cell, sub_image.shape[1:], bounds)

            intensities[index] += np.sum(sub_image * mask, axis=(1, 2))
            areas[index] += np.sum(mask)

    with ProgressBar():
        tasks = [
            dask.delayed(_average_chunk_inside_cells)(chunk, iy, ix)
            for iy, row in enumerate(image.chunk({"c": -1}).data.to_delayed()[0])
            for ix, chunk in enumerate(row)
        ]
        dask.compute(tasks)

    return intensities / areas[:, None].clip(1)

sopa.segmentation.aggregation.count_transcripts(sdata, gene_column, shapes_key=None, points_key=None, geo_df=None)

Counts transcripts per cell.

Parameters:

Name	Type	Description	Default
sdata	SpatialData	A SpatialData object	required
gene_column	str	Column of the transcript dataframe containing the gene names	required
shapes_key	str	Key of sdata containing the cell boundaries. If only one shapes element, this does not have to be provided.	None
points_key	str	Key of sdata containing the transcripts. If only one points element, this does not have to be provided.	None
geo_df	GeoDataFrame | None	If the cell boundaries are not yet in sdata, a GeoDataFrame can be directly provided for cell boundaries	None

Returns:

Type	Description
AnnData	An AnnData object of shape (n_cells, n_genes) with the counts per cell

Source code in sopa/segmentation/aggregation.py

def count_transcripts(
    sdata: SpatialData,
    gene_column: str,
    shapes_key: str = None,
    points_key: str = None,
    geo_df: gpd.GeoDataFrame | None = None,
) -> AnnData:
    """Counts transcripts per cell.

    Args:
        sdata: A `SpatialData` object
        gene_column: Column of the transcript dataframe containing the gene names
        shapes_key: Key of `sdata` containing the cell boundaries. If only one `shapes` element, this does not have to be provided.
        points_key: Key of `sdata` containing the transcripts. If only one `points` element, this does not have to be provided.
        geo_df: If the cell boundaries are not yet in `sdata`, a `GeoDataFrame` can be directly provided for cell boundaries

    Returns:
        An `AnnData` object of shape `(n_cells, n_genes)` with the counts per cell
    """
    points_key, points = get_spatial_element(sdata.points, key=points_key, return_key=True)

    if geo_df is None:
        geo_df = get_spatial_element(sdata.shapes, key=shapes_key)
        geo_df = to_intrinsic(sdata, geo_df, points_key)

    log.info(f"Aggregating transcripts over {len(geo_df)} cells")
    return _count_transcripts_aligned(geo_df, points, gene_column)

sopa.segmentation.aggregation._count_transcripts_aligned(geo_df, points, value_key)

Count transcripts per cell. The cells and points have to be aligned (i.e., in the same coordinate system)

Parameters:

Name	Type	Description	Default
geo_df	GeoDataFrame	Cells geometries	required
points	DataFrame	Transcripts dataframe	required
value_key	str	Key of points containing the genes names	required

Returns:

Type	Description
AnnData	An AnnData object of shape (n_cells, n_genes) with the counts per cell

Source code in sopa/segmentation/aggregation.py

def _count_transcripts_aligned(geo_df: gpd.GeoDataFrame, points: dd.DataFrame, value_key: str) -> AnnData:
    """Count transcripts per cell. The cells and points have to be aligned (i.e., in the same coordinate system)

    Args:
        geo_df: Cells geometries
        points: Transcripts dataframe
        value_key: Key of `points` containing the genes names

    Returns:
        An `AnnData` object of shape `(n_cells, n_genes)` with the counts per cell
    """
    points[value_key] = points[value_key].astype("category").cat.as_known()
    gene_names = points[value_key].cat.categories.astype(str)

    X = coo_matrix((len(geo_df), len(gene_names)), dtype=int)
    adata = AnnData(X=X, var=pd.DataFrame(index=gene_names))
    adata.obs_names = geo_df.index.astype(str)

    geo_df = geo_df.reset_index()

    X_partitions = []

    with ProgressBar():
        points.map_partitions(
            partial(_add_coo, X_partitions, geo_df, gene_column=value_key, gene_names=gene_names),
            meta=(),
        ).compute()

    for X_partition in X_partitions:
        adata.X += X_partition

    adata.X = adata.X.tocsr()
    return adata

sopa.segmentation.aggregation.Aggregator

Perform transcript count and channel averaging over a SpatialData object

Source code in sopa/segmentation/aggregation.py

class Aggregator:
    """Perform transcript count and channel averaging over a `SpatialData` object"""

    def __init__(
        self,
        sdata: SpatialData,
        overwrite: bool = True,
        image_key: str | None = None,
        shapes_key: str | None = None,
    ):
        """
        Args:
            sdata: A `SpatialData` object
            overwrite: If `True`, will overwrite `sdata.table` if already existing
            image_key: Key of `sdata` with the image to be averaged. If only one image, this does not have to be provided.
            shapes_key: Key of `sdata` with the shapes corresponding to the cells boundaries
        """
        self.sdata = sdata
        self.overwrite = overwrite

        self.image_key, self.image = get_spatial_image(sdata, image_key, return_key=True)

        if shapes_key is None:
            self.shapes_key, self.geo_df = get_boundaries(sdata, return_key=True)
        else:
            self.shapes_key = shapes_key
            self.geo_df = self.sdata[shapes_key]

        self.table = None
        self._had_table = False
        if SopaKeys.TABLE in self.sdata.tables:
            table = self.sdata.tables[SopaKeys.TABLE]
            if len(self.geo_df) == table.n_obs:
                log.info("Using existing table for aggregation")
                self.table = table
                self._had_table = True

    def overlay_segmentation(
        self,
        gene_column: str | None = None,
        average_intensities: bool = True,
        area_ratio_threshold: float = 0.25,
        save_table: bool = True,
    ):
        old_table: AnnData = self.sdata.tables[SopaKeys.TABLE]
        self.sdata.tables[SopaKeys.OLD_TABLE] = old_table
        del self.sdata.tables[SopaKeys.TABLE]

        old_shapes_key = old_table.uns["spatialdata_attrs"]["region"]
        instance_key = old_table.uns["spatialdata_attrs"]["instance_key"]

        if isinstance(old_shapes_key, list):
            assert len(old_shapes_key) == 1, "Can't overlap segmentation on multi-region SpatialData object"
            old_shapes_key = old_shapes_key[0]

        old_geo_df = self.sdata[old_shapes_key]
        geo_df = to_intrinsic(self.sdata, self.geo_df, old_geo_df)

        geo_df.index.name = "index_right"  # to reuse the index name later
        gdf_join = gpd.sjoin(old_geo_df, geo_df)
        gdf_join["geometry_right"] = gdf_join["index_right"].map(lambda i: geo_df.geometry.iloc[i])
        gdf_join["overlap_ratio"] = gdf_join.apply(_overlap_area_ratio, axis=1)
        gdf_join: gpd.GeoDataFrame = gdf_join[gdf_join.overlap_ratio >= area_ratio_threshold]

        table_crop = old_table[~np.isin(old_table.obs[instance_key], gdf_join.index)].copy()
        table_crop.obs[SopaKeys.CELL_OVERLAY_KEY] = False

        self.compute_table(gene_column=gene_column, average_intensities=average_intensities, save_table=False)
        self.table.obs[SopaKeys.CELL_OVERLAY_KEY] = True

        self.table = anndata.concat([table_crop, self.table], uns_merge="first", join="outer", fill_value=0)
        _fillna(self.table.obs)

        self.shapes_key = f"{old_shapes_key}+{self.shapes_key}"
        geo_df_cropped = old_geo_df.loc[~old_geo_df.index.isin(gdf_join.index)]
        self.geo_df = pd.concat([geo_df_cropped, geo_df], join="outer", axis=0)
        self.geo_df.attrs = old_geo_df.attrs

        self.add_standardized_table(save_table=save_table)

    def add_standardized_table(self, save_table: bool = True):
        self.table.obs_names = list(map(str_cell_id, range(self.table.n_obs)))

        self.geo_df.index = list(self.table.obs_names)
        self.sdata.shapes[self.shapes_key] = self.geo_df
        if self.sdata.is_backed():
            self.sdata.delete_element_from_disk(self.shapes_key)
            self.sdata.write_element(self.shapes_key)

        self.table.obsm["spatial"] = np.array([[centroid.x, centroid.y] for centroid in self.geo_df.centroid])
        self.table.obs[SopaKeys.REGION_KEY] = pd.Series(self.shapes_key, index=self.table.obs_names, dtype="category")
        self.table.obs[SopaKeys.SLIDE_KEY] = pd.Series(self.image_key, index=self.table.obs_names, dtype="category")
        self.table.obs[SopaKeys.INSTANCE_KEY] = self.geo_df.index

        self.table.obs[SopaKeys.AREA_OBS] = self.geo_df.area.values

        if "spatialdata_attrs" in self.table.uns:
            del self.table.uns["spatialdata_attrs"]

        self.table = TableModel.parse(
            self.table,
            region_key=SopaKeys.REGION_KEY,
            region=self.shapes_key,
            instance_key=SopaKeys.INSTANCE_KEY,
        )

        self.sdata.tables[SopaKeys.TABLE] = self.table

        if save_table and self.sdata.is_backed():
            if self._had_table:
                self.sdata.delete_element_from_disk(SopaKeys.TABLE)
            self.sdata.write_element(SopaKeys.TABLE)

    def filter_cells(self, where_filter: np.ndarray):
        log.info(f"Filtering {where_filter.sum()} cells")

        self.geo_df = self.geo_df[~where_filter]

        self.sdata.shapes[self.shapes_key] = self.geo_df

        if self.table is not None:
            self.table = self.table[~where_filter]

    def update_table(self, *args, **kwargs):
        log.warn("'update_table' is deprecated, use 'compute_table' instead")
        self.compute_table(*args, **kwargs)

    def compute_table(
        self,
        gene_column: str | None = None,
        average_intensities: bool = True,
        expand_radius_ratio: float = 0,
        min_transcripts: int = 0,
        min_intensity_ratio: float = 0,
        save_table: bool = True,
    ):
        """Perform aggregation and update the spatialdata table

        Args:
            gene_column: Column key of the transcript dataframe containing the gene names
            average_intensities: Whether to average the channels intensities inside cells polygons
            expand_radius_ratio: Cells polygons will be expanded by `expand_radius_ratio * mean_radius` for channels averaging **only**. This help better aggregate boundary stainings
            min_transcripts: Minimum amount of transcript to keep a cell
            min_intensity_ratio: Cells whose mean channel intensity is less than `min_intensity_ratio * quantile_90` will be filtered
            save_table: Whether the table should be saved on disk or not
        """
        does_count = (self.table is not None and isinstance(self.table.X, csr_matrix)) or gene_column is not None

        assert (
            average_intensities or does_count
        ), "You must choose at least one aggregation: transcripts or fluorescence intensities"

        if gene_column is not None:
            if self.table is not None:
                log.warn("sdata.table is already existing. Transcripts are not count again.")
            else:
                self.table = count_transcripts(self.sdata, gene_column, shapes_key=self.shapes_key)

        if does_count and min_transcripts > 0:
            self.filter_cells(self.table.X.sum(axis=1) < min_transcripts)

        if average_intensities:
            mean_intensities = average_channels(
                self.sdata,
                image_key=self.image_key,
                shapes_key=self.shapes_key,
                expand_radius_ratio=expand_radius_ratio,
            )

            if min_intensity_ratio > 0:
                means = mean_intensities.mean(axis=1)
                intensity_threshold = min_intensity_ratio * np.quantile(means, 0.9)
                where_filter = means < intensity_threshold
                self.filter_cells(where_filter)
                mean_intensities = mean_intensities[~where_filter]

            if not does_count:
                self.table = AnnData(
                    mean_intensities,
                    dtype=mean_intensities.dtype,
                    var=pd.DataFrame(index=self.image.coords["c"].values.astype(str)),
                    obs=pd.DataFrame(index=self.geo_df.index),
                )
            else:
                self.table.obsm[SopaKeys.INTENSITIES_OBSM] = pd.DataFrame(
                    mean_intensities,
                    columns=self.image.coords["c"].values.astype(str),
                    index=self.table.obs_names,
                )

        self.table.uns[SopaKeys.UNS_KEY] = {
            "version": sopa.__version__,
            SopaKeys.UNS_HAS_TRANSCRIPTS: does_count,
            SopaKeys.UNS_HAS_INTENSITIES: average_intensities,
        }

        self.add_standardized_table(save_table=save_table)

__init__(sdata, overwrite=True, image_key=None, shapes_key=None)

Parameters:

Name	Type	Description	Default
sdata	SpatialData	A SpatialData object	required
overwrite	bool	If True, will overwrite sdata.table if already existing	True
image_key	str | None	Key of sdata with the image to be averaged. If only one image, this does not have to be provided.	None
shapes_key	str | None	Key of sdata with the shapes corresponding to the cells boundaries	None

Source code in sopa/segmentation/aggregation.py

def __init__(
    self,
    sdata: SpatialData,
    overwrite: bool = True,
    image_key: str | None = None,
    shapes_key: str | None = None,
):
    """
    Args:
        sdata: A `SpatialData` object
        overwrite: If `True`, will overwrite `sdata.table` if already existing
        image_key: Key of `sdata` with the image to be averaged. If only one image, this does not have to be provided.
        shapes_key: Key of `sdata` with the shapes corresponding to the cells boundaries
    """
    self.sdata = sdata
    self.overwrite = overwrite

    self.image_key, self.image = get_spatial_image(sdata, image_key, return_key=True)

    if shapes_key is None:
        self.shapes_key, self.geo_df = get_boundaries(sdata, return_key=True)
    else:
        self.shapes_key = shapes_key
        self.geo_df = self.sdata[shapes_key]

    self.table = None
    self._had_table = False
    if SopaKeys.TABLE in self.sdata.tables:
        table = self.sdata.tables[SopaKeys.TABLE]
        if len(self.geo_df) == table.n_obs:
            log.info("Using existing table for aggregation")
            self.table = table
            self._had_table = True

compute_table(gene_column=None, average_intensities=True, expand_radius_ratio=0, min_transcripts=0, min_intensity_ratio=0, save_table=True)

Perform aggregation and update the spatialdata table

Parameters:

Name	Type	Description	Default
gene_column	str | None	Column key of the transcript dataframe containing the gene names	None
average_intensities	bool	Whether to average the channels intensities inside cells polygons	True
expand_radius_ratio	float	Cells polygons will be expanded by expand_radius_ratio * mean_radius for channels averaging only. This help better aggregate boundary stainings	0
min_transcripts	int	Minimum amount of transcript to keep a cell	0
min_intensity_ratio	float	Cells whose mean channel intensity is less than min_intensity_ratio * quantile_90 will be filtered	0
save_table	bool	Whether the table should be saved on disk or not	True

Source code in sopa/segmentation/aggregation.py

def compute_table(
    self,
    gene_column: str | None = None,
    average_intensities: bool = True,
    expand_radius_ratio: float = 0,
    min_transcripts: int = 0,
    min_intensity_ratio: float = 0,
    save_table: bool = True,
):
    """Perform aggregation and update the spatialdata table

    Args:
        gene_column: Column key of the transcript dataframe containing the gene names
        average_intensities: Whether to average the channels intensities inside cells polygons
        expand_radius_ratio: Cells polygons will be expanded by `expand_radius_ratio * mean_radius` for channels averaging **only**. This help better aggregate boundary stainings
        min_transcripts: Minimum amount of transcript to keep a cell
        min_intensity_ratio: Cells whose mean channel intensity is less than `min_intensity_ratio * quantile_90` will be filtered
        save_table: Whether the table should be saved on disk or not
    """
    does_count = (self.table is not None and isinstance(self.table.X, csr_matrix)) or gene_column is not None

    assert (
        average_intensities or does_count
    ), "You must choose at least one aggregation: transcripts or fluorescence intensities"

    if gene_column is not None:
        if self.table is not None:
            log.warn("sdata.table is already existing. Transcripts are not count again.")
        else:
            self.table = count_transcripts(self.sdata, gene_column, shapes_key=self.shapes_key)

    if does_count and min_transcripts > 0:
        self.filter_cells(self.table.X.sum(axis=1) < min_transcripts)

    if average_intensities:
        mean_intensities = average_channels(
            self.sdata,
            image_key=self.image_key,
            shapes_key=self.shapes_key,
            expand_radius_ratio=expand_radius_ratio,
        )

        if min_intensity_ratio > 0:
            means = mean_intensities.mean(axis=1)
            intensity_threshold = min_intensity_ratio * np.quantile(means, 0.9)
            where_filter = means < intensity_threshold
            self.filter_cells(where_filter)
            mean_intensities = mean_intensities[~where_filter]

        if not does_count:
            self.table = AnnData(
                mean_intensities,
                dtype=mean_intensities.dtype,
                var=pd.DataFrame(index=self.image.coords["c"].values.astype(str)),
                obs=pd.DataFrame(index=self.geo_df.index),
            )
        else:
            self.table.obsm[SopaKeys.INTENSITIES_OBSM] = pd.DataFrame(
                mean_intensities,
                columns=self.image.coords["c"].values.astype(str),
                index=self.table.obs_names,
            )

    self.table.uns[SopaKeys.UNS_KEY] = {
        "version": sopa.__version__,
        SopaKeys.UNS_HAS_TRANSCRIPTS: does_count,
        SopaKeys.UNS_HAS_INTENSITIES: average_intensities,
    }

    self.add_standardized_table(save_table=save_table)