Skip to content

docs: add multichannel & fluorescence images tutorial - #17

Open
timtreis wants to merge 2 commits into
mainfrom
feat/multichannel-images
Open

docs: add multichannel & fluorescence images tutorial#17
timtreis wants to merge 2 commits into
mainfrom
feat/multichannel-images

Conversation

@timtreis

Copy link
Copy Markdown
Member

Summary

Adds tutorials/multichannel_images.ipynb — the render_images story beyond a single channel, the biggest documentation gap for fluorescence / multiplexed-imaging users (Xenium, CODEX, IMC, CyCIF).

Uses the real Xenium cells dataset (squidpy.datasets.cells(), 2.8 MB, cached) — its morphology_focus image has four named fluorescence channels (DAPI, ATP1A1/CD45/E-Cadherin, 18S, AlphaSMA/Vimentin).

Covers:

  • channel= selection by name and by list
  • the default multichannel composite
  • per-channel contrast with PercentileNormalize (fluorescence is heavy-tailed) — pass a list of norms
  • cmap vs palette: per-channel palette LUTs for additive compositing, and the white-overlay warning that motivates palette over cmap
  • grayscale (3-channel desaturated view) and channels_as_legend

Executed against spatialdata-plot v0.4.1, committed with outputs. Adds the gallery card + toctree + thumbnail.

First of the documentation-expansion series from the 0.4.0/0.4.1 gap analysis (P0.1). Cross-links the pending normalization tutorial (#9) for norms in depth.

New tutorials/multichannel_images.ipynb using the real Xenium cells dataset
(squidpy), whose morphology_focus image has four named fluorescence channels
(DAPI, ATP1A1/CD45/E-Cadherin, 18S, AlphaSMA/Vimentin). Covers the render_images
surface beyond a single channel:

- channel= selection by name, and channel lists
- the default multichannel composite
- per-channel contrast with PercentileNormalize (fluorescence is heavy-tailed)
- cmap vs palette: per-channel palette LUTs for additive compositing (and the
  white-overlay warning that motivates palette over cmap)
- grayscale (3-channel desaturated view) and channels_as_legend

Executed against spatialdata-plot v0.4.1; committed with outputs. Adds the
gallery card + toctree entry and a thumbnail. Closes the P0.1 gap from the
0.4.0/0.4.1 doc-coverage analysis.
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown

📖 Docs preview: https://scverse.org/spatialdata-plot-tutorials/pr-17/gallery.html

Built from 933bbfc; redeployed on every push.

github-actions Bot pushed a commit that referenced this pull request Aug 18, 2026
github-actions Bot pushed a commit that referenced this pull request Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant