Package supports all bio-imaging functionality provided by TileDB
Project description
TileDB-BioImaging
Python package for:
- converting images stored in popular Biomedical Imaging formats to groups of TileDB arrays (& vice versa)
- exposing an expressive and efficient API (powered by TileDB) for querying such data.
Features
Ingestion to TileDB Groups of Arrays
- OME-Zarr
- OME-Tiff
- Open-Slide
Export from TileDB-Bioimaging Arrays to:
- OME-Zarr
- OME-Tiff
Visualization Options
- TileDB Cloud includes a built-in, pyramidal multi-resolution viewer: log in to TileDB Cloud to see an example image preview here
- Napari: https://github.com/TileDB-Inc/napari-tiledb-bioimg
Quick Installation
-
From PyPI:
pip install 'tiledb-bioimg[full]'
-
From source:
git clone https://github.com/TileDB-Inc/TileDB-BioImaging.git cd TileDB-BioImaging pip install -e '.[full]'
Windows Installation
After installing Openslide
you should make sure that you create a link between your installation path and
the following default path C:\openslide-win64\
.
mklink /D C:\openslide-win64\ [your-installation-path]\openslide-win64-20221217\
You can install the latest versions of Openslide
for windows using the pre-built packages
found in the project's github page:
https://github.com/openslide/openslide-bin/releases
or in their website:
https://openslide.org/download/
Examples
How to convert imaging data from standard biomedical formats to group of TileDB arrays.
OME-Zarr to TileDB Group of Arrays
from tiledb.bioimg.converters.ome_zarr import OMEZarrConverter
OMEZarrConverter.to_tiledb("path_to_ome_zarr_image", "tiledb_array_group_path")
OME-Tiff to TileDB Group of Arrays
from tiledb.bioimg.converters.ome_tiff import OMETiffConverter
OMETiffConverter.to_tiledb("path_to_ome_tiff_image", "tiledb_array_group_path")
Open Slide to TileDB Group of Arrays
from tiledb.bioimg.converters.openslide import OpenSlideConverter
OpenSlideConverter.to_tiledb("path_to_open_slide_image", "tiledb_array_group_path")
Documentation
API Documentation
is auto-generated. Following the instructions below:
quartodoc build && quarto preview
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tiledb_bioimg-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 458162c95dafc8f6d9b0dd274e2d23425f327f94e96b41cd41b5e3088d79b9f5 |
|
MD5 | 8d4a670ccb9d73d97c4edc41d057e5b1 |
|
BLAKE2b-256 | 23eff6272815a077afeeee6c4936179e02d7b00d53c844e07f4eeb0b26d5f911 |