File size: 2,045 Bytes
12d2e9e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
Core API
========
SlideData
---------
The central class in ``PathML`` for representing a whole-slide image.
.. autoapiclass:: pathml.core.SlideData
Convenience SlideData Classes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoapiclass:: pathml.core.HESlide
.. autoapiclass:: pathml.core.VectraSlide
.. autoapiclass:: pathml.core.MultiparametricSlide
.. autoapiclass:: pathml.core.CODEXSlide
Slide Types
-----------
.. autoapiclass:: pathml.core.SlideType
:exclude-members: tma, platform, rgb, stain, volumetric, time_series
We also provide instantiations of common slide types for convenience:
============================= ======= ======== ======= ======= ========== ===========
Type stain platform rgb tma volumetric time_series
============================= ======= ======== ======= ======= ========== ===========
``pathml.core.types.HE`` 'HE' None True False False False
``pathml.core.types.IHC`` 'IHC' None True False False False
``pathml.core.types.IF`` 'Fluor' None False False False False
``pathml.core.types.CODEX`` 'Fluor' 'CODEX' False False False False
``pathml.core.types.Vectra`` 'Fluor' 'Vectra' False False False False
============================= ======= ======== ======= ======= ========== ===========
Tile
----
.. autoapiclass:: pathml.core.Tile
SlideDataset
------------
.. autoapiclass:: pathml.core.SlideDataset
Tiles and Masks helper classes
------------------------------
.. autoapiclass:: pathml.core.Tiles
.. autoapiclass:: pathml.core.Masks
Slide Backends
--------------
OpenslideBackend
^^^^^^^^^^^^^^^^
.. autoapiclass:: pathml.core.OpenSlideBackend
BioFormatsBackend
^^^^^^^^^^^^^^^^^
.. autoapiclass:: pathml.core.BioFormatsBackend
DICOMBackend
^^^^^^^^^^^^
.. autoapiclass:: pathml.core.DICOMBackend
h5pathManager
-------------
.. autoapiclass:: pathml.core.h5managers.h5pathManager
|