sfplot

sfplot is a Python package for spatial structure analysis in spatial omics data. It implements the Search-and-Find Plot (SFplot) / Cell-GPS workflow used in our manuscript to quantify multiscale tissue architecture, compute cophenetic distance-based structure maps, and analyze cell-cell or transcript-cell spatial relationships.

This repository is being maintained as the code companion for manuscript review and future reuse.

What the package does

• Computes searcher-findee distance matrices from spatial coordinates and cell labels.
• Builds cophenetic distance matrices and StructureMap heatmaps from AnnData objects or plain pandas tables.
• Loads 10x Xenium outputs and prepares them for downstream spatial analysis.
• Supports transcript-by-cell analysis for locating transcripts relative to cell types.
• Includes memory-optimized workflows for large datasets.
• Provides plotting utilities such as clustered heatmaps, circular dendrograms, and related summary figures.

Repository layout

• src/sfplot/: core implementation.
• tests/: package tests and smoke checks.
• docs/: Sphinx documentation.
• sfplot-manuscript/: manuscript-specific notebooks, figures, and derived outputs.
• benchmarking/: benchmarking-related material.
• segmentation_methods/: supporting segmentation workflows.

Installation

Install directly from GitHub:

pip install git+https://github.com/hutaobo/sfplot.git

For local development or reviewer inspection:

git clone https://github.com/hutaobo/sfplot.git
cd sfplot
pip install -e .

The package requires Python 3.9 or later.

Quick start from a coordinate table

The minimal input is a table with spatial coordinates and a cell-type column.

import pandas as pd
from sfplot import compute_cophenetic_distances_from_df, plot_cophenetic_heatmap

df = pd.DataFrame(
    {
        "x": [0, 1, 5, 6],
        "y": [0, 1, 5, 6],
        "celltype": ["A", "A", "B", "B"],
    }
)

row_coph, col_coph = compute_cophenetic_distances_from_df(
    df=df,
    x_col="x",
    y_col="y",
    celltype_col="celltype",
)

plot_cophenetic_heatmap(
    row_coph,
    matrix_name="row_coph",
    output_dir="output",
    output_filename="StructureMap_example.pdf",
    sample="Example",
)

Quick start from Xenium output

from sfplot import load_xenium_data, compute_cophenetic_distances_from_adata

adata = load_xenium_data("/path/to/xenium/run", normalize=False)

row_coph, col_coph = compute_cophenetic_distances_from_adata(
    adata,
    cluster_col="Cluster",
    output_dir="output",
)

Useful public entry points

• load_xenium_data: load and preprocess Xenium data.
• compute_cophenetic_distances_from_df: compute structure matrices from a coordinate table.
• compute_cophenetic_distances_from_adata: compute structure matrices from AnnData.
• plot_cophenetic_heatmap: generate StructureMap and related clustered heatmaps.
• transcript_by_cell_analysis: analyze transcript-to-cell spatial structure at scale.
• compute_cophenetic_distances_from_df_memory_opt: memory-aware alternative for large tables.
• plot_circular_dendrogram_pycirclize: circular dendrogram visualization.

Notes for reviewers

• The package code used for the manuscript is in src/sfplot/.
• Manuscript-facing notebooks and generated figure assets are kept in sfplot-manuscript/.
• Raw experimental datasets are not bundled in this repository because of size and distribution constraints. The code expects standard spatial omics outputs such as Xenium folders or tabular coordinate inputs.
• A short repository walkthrough is available in REVIEWER_GUIDE.md.

Documentation

Sphinx documentation sources are available in docs/.

Citation

If you use this repository in connection with manuscript review, please cite the associated manuscript:

Cophenetic Spatial Topology Embedding reveals multiscale tissue architecture in spatial omics

License

This project is released under the MIT License. See LICENSE.