Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow SlideData to use existing h5path files #337

Open
wants to merge 22 commits into
base: load-data-in-workers
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update h5path documentation
  • Loading branch information
tddough98 committed Oct 14, 2022
commit be5ed26f852a49ac6098e1f1c94fd797d1b49c72
5 changes: 4 additions & 1 deletion docs/source/h5path.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,10 @@ Whole-slide masks are stored in the ``masks/`` Group. All masks are enforced to
However, when running a pipeline, these masks are moved to the tile-level and stored within the tile groups.
The slide-level masks are therefore not saved when calling :meth:`SlideData.write() <pathml.core.SlideData.write>`.

We use ``float16`` as the data type for all Datasets.
By default, we use ``float16`` as the data type for all Datasets and HDF5's
`ENUM type <https://docs.h5py.org/en/stable/special.html#enumerated-types>`
for masks, which are stored as 8-bit integers. Changing the `dtype` in
the Slide constructor changes the data type used to store images.

.. note:: Be aware that the ``h5path`` format specification may change between major versions

Expand Down