spateo.io.image
===============

.. py:module:: spateo.io.image

.. autoapi-nested-parse::

   Image IO.



Functions
---------

.. autoapisummary::

   spateo.io.image.read_image


Module Contents
---------------

.. py:function:: read_image(adata: anndata.AnnData, filename: str, scale_factor: float, slice: Optional[str] = None, img_layer: Optional[str] = None) -> anndata.AnnData

   Load an image into the AnnData object.

   :param adata: AnnData object
   :param filename: The path of the image
   :param scale_factor: The scale factor of the image. Define: pixels/DNBs
   :param slice: Name of the slice. Will be used when displaying multiple slices.
   :param img_layer: Name of the image layer.

   :returns: * :attr:`~anndata.AnnData.uns`\ `['spatial'][slice]['images'][img_layer]` -- The stored image
             * :attr:`~anndata.AnnData.uns`\ `['spatial'][slice]['scalefactors'][img_layer]` -- The scale factor for the spots