Spatialdata-Io-Docs-Local Skill

Comprehensive assistance with spatialdata-io-docs-local development, generated from official documentation.

When to Use This Skill

This skill should be triggered when:

• Working with spatialdata-io-docs-local
• Asking about spatialdata-io-docs-local features or APIs
• Implementing spatialdata-io-docs-local solutions
• Debugging spatialdata-io-docs-local code
• Learning spatialdata-io-docs-local best practices

Quick Reference

Common Patterns

Pattern 1: spatialdata-io API spatialdataio.codex spatialdataio.cosmx spatialdataio.curio spatialdataio.dbit spatialdataio.experimental.iss spatialdataio.mcmicro spatialdataio.merscope spatialdataio.seqfish spatialdataio.steinbock spatialdataio.stereoseq spatialdataio.visium spatialdataio.visiumhd spatialdataio.xenium spatialdataio.generic spatialdataio.image spatialdataio.geojson spatialdataio.experimental.fromlegacyanndata spatialdataio.experimental.tolegacyanndata spatialdataio.xeniumalignedimage spatialdataio.xeniumexplorerselection CLI Changelog Contributing guide References .md .pdf CLI Contents spatialdataio codex cosmx curio dbit generic iss macsima mcmicro merscope seqfish steinbock stereoseq visium visium-hd xenium CLI# This section documents the Command Line Interface (CLI) for the spatialdataio package. spatialdataio# Convert standard technology data formats to SpatialData object. Usage: python -m spatialdataio <Command> -i <input> -o <output> For help on how to use a specific command, run: python -m spatialdataio <Command> –help spatialdataio [OPTIONS] COMMAND [ARGS]... codex# Codex conversion to SpatialData. spatialdataio codex [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --fcs <fcs># Whether the .fcs file is provided if False a .csv file is expected. [default: True] cosmx# Cosmic conversion to SpatialData. spatialdataio cosmx [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --dataset-id <datasetid># Name of the dataset [default: None] --transcripts <transcripts># Whether to load transcript information. [default: True] curio# Curio conversion to SpatialData. spatialdataio curio [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. dbit# Conversion of DBit-seq to SpatialData. spatialdataio dbit [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --anndata-path <anndatapath># Path to the counts and metadata file. [default: None] --barcode-position <barcodeposition># Path to the barcode coordinates file. [default: None] --image-path <imagepath># Path to the low resolution image file. [default: None] --dataset-id <datasetid># Dataset ID. [default: None] --border <border># Value pass internally to xy2edges. [default: True] --border-scale <borderscale># The factor by which the border is scaled. [default: 1] generic# Read generic data to SpatialData. spatialdataio generic [OPTIONS] Options -i, --input <input># Required Path to the image/shapes input file. Supported extensions: [‘.tif’, ‘.tiff’, ‘.png’, ‘.jpg’, ‘.jpeg’, ‘.geojson’] -o, --output <output># Required Path to zarr store to write to. If it does not exist yet, create new zarr store from input -n, --name <name># name of the element to be stored --data-axes <dataaxes># Axes of the data for image files. Valid values are permutations of ‘cyx’ and ‘czyx’. -c, --coordinate-system <coordinatesystem># Coordinate system in spatialdata object to which an element should belong iss# ISS conversion to SpatialData. spatialdataio iss [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --raw-relative-path <rawrelativepath># Required Relative path to raw raster image file. --labels-relative-path <labelsrelativepath># Required Relative path to label image file. --h5ad-relative-path <h5adrelativepath># Required Relative path to counts and metadata file. --instance-key <instancekey># Which column of the AnnData table contains the CellID. [default: None] --dataset-id <datasetid># Dataset ID [default: region] --multiscale-image <multiscaleimage># Whether to process the image into a multiscale image [default: True] --multiscale-labels <multiscalelabels># Whether to process the label image into a multiscale image [default: True] macsima# Read MACSima formatted dataset and convert to SpatialData. spatialdataio macsima [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --filter-folder-names <filterfoldernames># List of folder names to filter out when parsing multiple folders. [default: None] --subset <subset># Subset the image to the first ‘subset’ pixels in x and y dimensions. [default: None] --c-subset <csubset># Subset the image to the first ‘c-subset’ channels. [default: None] --max-chunk-size <maxchunksize># Maximum chunk size for x and y dimensions. [default: 1024] --c-chunks-size <cchunkssize># Chunk size for c dimension. [default: 1] --multiscale <multiscale># Whether to create a multiscale image. [default: True] --transformations <transformations># Whether to add a transformation from pixels to microns to the image. [default: True] --scale-factors <scalefactors># Scale factors to use for downsampling. If None, scale factors are calculated based on image size. [default: None] --default-scale-factor <defaultscalefactor># Default scale factor to use for downsampling. [default: 2] --nuclei-channel-name <nucleichannelname># Common string of the nuclei channel to separate nuclei from other channels. [default: ‘DAPI’] --split-threshold-nuclei-channel <splitthresholdnucleichannel># Threshold for splitting nuclei channels. [default: 2] --skip-rounds <skiprounds># List of round numbers to skip when parsing the data. [default: None] --include-cycle-in-channel-name <includecycleinchannelname># Whether to include the cycle number in the channel name. [default: False] mcmicro# Conversion of MCMicro to SpatialData. spatialdataio mcmicro [OPTIONS] Options -i, --input <input># Required Path to the mcmicro project directory. -o, --output <output># Required Path to the output.zarr file. merscope# Merscope conversion to SpatialData. spatialdataio merscope [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --vpt-outputs <vptoutputs># Optional argument to specify the path to the Vizgen postprocessing tool. [default: None] --z-layers <zlayers># Indices of the z-layers to consider. [default: 3] --region-name <regionname># Name of the ROI. [default: None] --slide-name <slidename># Name of the slide/run [default: None] --backend <backend># Either ‘daskimage’ or ‘rioxarray’. [default: None] Options: daskimage | rioxarray --transcripts <transcripts># Whether to read transcripts. [default: True] --cells-boundaries <cellsboundaries># Whether to read cells boundaries. [default: True] --cells-table <cellstable># Whether to read cells table. [default: True] --mosaic-images <mosaicimages># Whether to read the mosaic images. [default: True] seqfish# Seqfish conversion to SpatialData. spatialdataio seqfish [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --load-images <loadimages># Whether to load images. [default: True] --load-labels <loadlabels># Whether to load labels. [default: True] --load-points <loadpoints># Whether to load points. [default: True] --load-shapes <loadshapes># Whether to load shapes. [default: True] --cells-as-circles <cellsascircles># Whether to read cells as circles. [default: False] --rois <rois># Which sections to load. Provide one or more section indices. [default: All sections are loaded] steinbock# Steinbock conversion to SpatialData. spatialdataio steinbock [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --labels-kind <labelskind># What kind of labels to use. [default: ‘deepcell’] Options: deepcell | ilastik stereoseq# Stereoseq conversion to SpatialData. spatialdataio stereoseq [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --dataset-id <datasetid># Dataset ID. [default: None] --read-square-bin <readsquarebin># If True, will read the square bin {xx.GEFFILE!r} file and build corresponding points element. [default: True] --optional-tif <optionaltif># If True, will read {xx.TISSUETIF!r} files. [default: False] visium# Visium conversion to SpatialData. spatialdataio visium [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --dataset-id <datasetid># Dataset ID. [default: None] --counts-file <countsfile># Name of the counts file, defaults to {vx.FILTEREDCOUNTSFILE!r}. [default: None] --fullres-image-file <fullresimagefile># Path to the full resolution image. [default: None] --tissue-positions-file <tissuepositionsfile># Path to the tissue positions file. [default: None] --scalefactors-file <scalefactorsfile># Path to the scalefactors file. [default: None] visium-hd# Visium HD conversion to SpatialData. spatialdataio visium-hd [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --dataset-id <datasetid># Dataset ID. [default: None] --filtered-counts-file <filteredcountsfile># It sets the value of countsfile to {vx.FILTEREDCOUNTSFILE!r} (when True) or to`{vx.RAWCOUNTSFILE!r}` (when False). [default: True] --bin-size <binsize># When specified, load the data of a specific bin size, or a list of bin sizes. By default, it loads all the available bin sizes. [default: None] --bins-as-squares <binsassquares># If true, bins are represented as squares otherwise as circles. [default: True] --fullres-image-file <fullresimagefile># Path to the full resolution image. [default: None] --load-all-images <loadallimages># If False, load only the full resolution, high resolution, and low resolution images. If True, also the following images: {vx.IMAGECYTASSIST!r}. [default: False] --annotate-table-by-labels <annotatetablebylabels># If true, annotates the table by labels. [default: False] xenium# Xenium conversion to SpatialData. spatialdataio xenium [OPTIONS] Options -o, --output <output># Required Path to the output file. -i, --input <input># Required Path to the input file. --cells-boundaries <cellsboundaries># Whether to read cells boundaries. [default: True] --nucleus-boundaries <nucleusboundaries># Whether to read Nucleus boundaries. [default: True] --cells-as-circles <cellsascircles># Whether to read cells as circles. [default: None] --cells-labels <cellslabels># Whether to read cells labels (raster). [default: True] --nucleus-labels <nucleuslabels># Whether to read nucleus labels (raster). [default: True] --transcripts <transcripts># Whether to read transcripts. [default: True] --morphology-mip <morphologymip># Whether to read morphology mip image. [default: True] --morphology-focus <morphologyfocus># Whether to read morphology focus image. [default: True] --aligned-images <alignedimages># Whether to parse additional H&E or IF aligned images. [default: True] --cells-table <cellstable># Whether to read cells annotations in the AnnData table. [default: True] --n-jobs <njobs># Number of jobs. [default: 1] previous spatialdataio.xeniumexplorerselection next Changelog Contents spatialdataio codex cosmx curio dbit generic iss macsima mcmicro merscope seqfish steinbock stereoseq visium visium-hd xenium By scverse © Copyright 2025, scverse..

spatialdata_io

Pattern 2: Usage:

spatialdata_io [OPTIONS] COMMAND [ARGS]...

Pattern 3: spatialdata-io API spatialdataio.codex spatialdataio.cosmx spatialdataio.curio spatialdataio.dbit spatialdataio.experimental.iss spatialdataio.mcmicro spatialdataio.merscope spatialdataio.seqfish spatialdataio.steinbock spatialdataio.stereoseq spatialdataio.visium spatialdataio.visiumhd spatialdataio.xenium spatialdataio.generic spatialdataio.image spatialdataio.geojson spatialdataio.experimental.fromlegacyanndata spatialdataio.experimental.tolegacyanndata spatialdataio.xeniumalignedimage spatialdataio.xeniumexplorerselection CLI Changelog Contribution guide References .rst .pdf spatialdataio.xeniumalignedimage Contents xeniumalignedimage() spatialdataio.xeniumalignedimage# spatialdataio.xeniumalignedimage(imagepath, alignmentfile, imreadkwargs=mappingproxy({}), imagemodelskwargs=mappingproxy({}), dims=None, rgba=False, ccoords=None)# Read an image aligned to a Xenium dataset, with an optional alignment file. Parameters: imagepath (str | Path) – Path to the image. alignmentfile (str | Path | None) – Path to the alignment file, if not passed it is assumed that the image is aligned. imagemodelskwargs (Mapping[str, Any] (default: mappingproxy({}))) – Keyword arguments to pass to the image models. dims (tuple[str, ...] | None (default: None)) – Dimensions of the image (tuple of axes names); valid strings are “c”, “x” and “y”. If not passed, the function will try to infer the dimensions from the image shape. Please use this argument when the default behavior fails. Example: for an image with shape (1, y, 1, x, 3), use dims=(“anystring”, “y”, “dummy”, “x”, “c”). Values that are not “c”, “x” or “y” are considered dummy dimensions and will be squeezed (the data must have len 1 for those axes). rgba (bool (default: False)) – Interprets the c channel as RGBA, by setting the channel names to r, g, b (a). When ccoords is not None, this argument is ignored. ccoords (list[str] | None (default: None)) – Channel names for the image. By default, the function will try to infer the channel names from the image shape and name (by detecting if the name suggests that the image is a H&E image). Example: for an RGB image with shape (3, y, x), use ccoords=[“r”, “g”, “b”]. Return type: DataTree Returns: : The single-scale or multi-scale aligned image element. previous spatialdataio.experimental.tolegacyanndata next spatialdataio.xeniumexplorerselection Contents xeniumaligned_image() By scverse © Copyright 2025, scverse.

xenium_aligned_image()

Pattern 4: dims (tuple[str, ...] | None (default: None)) – Dimensions of the image (tuple of axes names); valid strings are “c”, “x” and “y”. If not passed, the function will try to infer the dimensions from the image shape. Please use this argument when the default behavior fails. Example: for an image with shape (1, y, 1, x, 3), use dims=(“anystring”, “y”, “dummy”, “x”, “c”). Values that are not “c”, “x” or “y” are considered dummy dimensions and will be squeezed (the data must have len 1 for those axes).

tuple

Reference Files

This skill includes comprehensive documentation in references/:

• api.md - Api documentation
• cli.md - Cli documentation
• core.md - Core documentation
• other.md - Other documentation
• platforms_10x.md - Platforms 10X documentation
• platforms_commercial.md - Platforms Commercial documentation
• platforms_experimental.md - Platforms Experimental documentation
• platforms_imaging.md - Platforms Imaging documentation

Use view to read specific reference files when detailed information is needed.

Working with This Skill

For Beginners

Start with the getting_started or tutorials reference files for foundational concepts.

For Specific Features

Use the appropriate category reference file (api, guides, etc.) for detailed information.

For Code Examples

The quick reference section above contains common patterns extracted from the official docs.

Resources

references/

Organized documentation extracted from official sources. These files contain:

• Detailed explanations
• Code examples with language annotations
• Links to original documentation
• Table of contents for quick navigation

scripts/

Add helper scripts here for common automation tasks.

assets/

Add templates, boilerplate, or example projects here.

Notes

• This skill was automatically generated from official documentation
• Reference files preserve the structure and examples from source docs
• Code examples include language detection for better syntax highlighting
• Quick reference patterns are extracted from common usage examples in the docs

Updating

To refresh this skill with updated documentation:

1. Re-run the scraper with the same configuration
2. The skill will be rebuilt with the latest information