spatialdata_io.xenium_aligned_image

spatialdata_io.xenium_aligned_image(image_path, alignment_file, imread_kwargs=mappingproxy({}), image_models_kwargs=mappingproxy({}))

Read an image aligned to a Xenium dataset, with an optional alignment file.

Parameters:

• image_path (str | Path) – Path to the image.

• alignment_file (str | Path | None) – Path to the alignment file, if not passed it is assumed that the image is aligned.

• image_models_kwargs (Mapping[str, Any] (default: mappingproxy({}))) – Keyword arguments to pass to the image models.

Return type:

MultiscaleSpatialImage

Returns:

: The single-scale or multi-scale aligned image element.