:py:mod:`wsinfer.wsi`
=====================

.. py:module:: wsinfer.wsi


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

Classes
~~~~~~~

.. autoapisummary::

   wsinfer.wsi.CanReadRegion



Functions
~~~~~~~~~

.. autoapisummary::

   wsinfer.wsi.set_backend
   wsinfer.wsi.get_avg_mpp



Attributes
~~~~~~~~~~

.. autoapisummary::

   wsinfer.wsi.logger
   wsinfer.wsi.HAS_OPENSLIDE
   wsinfer.wsi.HAS_TIFFSLIDE
   wsinfer.wsi.WSI
   wsinfer.wsi.WSI


.. py:data:: logger

   

.. py:data:: HAS_OPENSLIDE
   :value: True

   

.. py:data:: HAS_TIFFSLIDE
   :value: True

   

.. py:function:: set_backend(name: Literal[openslide]) -> type[openslide.OpenSlide]
                 set_backend(name: Literal[tiffslide]) -> type[tiffslide.TiffSlide]


.. py:data:: WSI
   :type: type[openslide.OpenSlide] | type[tiffslide.TiffSlide]

   

.. py:data:: WSI

   

.. py:class:: CanReadRegion


   Bases: :py:obj:`Protocol`

   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing), for example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto(Protocol[T]):
           def meth(self) -> T:
               ...

   .. py:method:: read_region(location: tuple[int, int], level: int, size: tuple[int, int]) -> PIL.Image.Image



.. py:function:: get_avg_mpp(slide_path: pathlib.Path | str) -> float

   Return the average MPP of a whole slide image.

   The value is in units of micrometers per pixel and is
   the average of the X and Y dimensions.

   :raises CannotReadSpacing if the spacing cannot be read.: