wsinfer.wsi

Module Contents

Classes

CanReadRegion

Base class for protocol classes.

Functions

set_backend(…)
get_avg_mpp(→ float)	Return the average MPP of a whole slide image.

Attributes

logger
HAS_OPENSLIDE
HAS_TIFFSLIDE
WSI
WSI

wsinfer.wsi.logger

wsinfer.wsi.HAS_OPENSLIDE = True

wsinfer.wsi.HAS_TIFFSLIDE = True

wsinfer.wsi.set_backend(name: Literal[openslide]) → type[openslide.OpenSlide]

wsinfer.wsi.set_backend(name: Literal[tiffslide]) → type[tiffslide.TiffSlide]

wsinfer.wsi.WSI: type[openslide.OpenSlide] | type[tiffslide.TiffSlide]

wsinfer.wsi.WSI

class wsinfer.wsi.CanReadRegion

Bases: 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:
        ...

read_region(location: tuple[int, int], level: int, size: tuple[int, int]) → PIL.Image.Image

wsinfer.wsi.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. –