The following output files from Xenium Onboard Analysis (XOA) are required as inputs for Xenium Ranger:
transcripts.zarr.zip
ortranscripts.zarr
cells.zarr.zip
orcells.zarr
morphology.ome.tif
morphology_mip.ome.tif
(required for XOA v1.0 - 1.9 datasets)- 2D autofocus image(s):
morphology_focus/
directory (required for XOA v2.0 and later datasets)morphology_focus.ome.tif
(required for XOA v1.0 - 1.9 datasets)
experiment.xenium
metrics_summary.csv
analysis_summary.html
gene_panel.json
(required for XOA v1.0 - 1.4 datasets)
For descriptions of these files, see the Xenium Onboard Analysis documentation. Xenium Ranger expects these files in one directory, which is specified by the --xenium-bundle
argument.
Here is an example for a XOA v2.0 dataset with Cell Segmentation Staining:
└── outs
├── analysis_summary.html
├── cells.zarr.zip
├── experiment.xenium
├── gene_panel.json
├── metrics_summary.csv
├── morphology.ome.tif
├── morphology_focus
│ ├── morphology_focus_0000.ome.tif
│ ├── morphology_focus_0001.ome.tif
│ ├── morphology_focus_0002.ome.tif
│ └── morphology_focus_0003.ome.tif
└── transcripts.zarr.zip
Depending on the Xenium Ranger pipeline, additional input files include:
- For the
relabel
pipeline: the gene panel JSON file to use for relabeling decoded transcripts - For the
import-segmentation
pipeline: Xenium Ranger accepts segmentation files from XOA and community-developed tools. Compatible file formats and specifications are described here.