Skip to main content

Package supports all bio-imaging functionality provided by TileDB

Project description

TileDB logo

TileDB-BioImaging CI Coverage Badge


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.

Note: this project is in pretty early stage and under heavy development. Breaking changes to the underlying data format and the API are to be expected.


Ingestion to TileDB Groups of Arrays

- OME-Zarr
- OME-Tiff
- Open-Slide

Ingestion from TileDB Groups of Arrays to:

- OME-Zarr
- OME-Tiff

Quick Installation

  • From PyPI:

    pip install tiledb-bioimg[full]
  • From source:

    git clone
    cd TileDB-BioImaging
    # If you use zsh replace .[full] with .\[full\]
    pip install -e .[full]

Note: For tiff support ([tiff] or [full] extra dependencies) on Python 3.7, you should first install our tifffile fork rather than the older PyPI upstream package:

  pip install tifffile@git+


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
cnv = OMEZarrConverter()
cnv.convert_image("path_to_ome_zarr_image", "tiledb_array_group_path")

OME-Tiff to TileDB Group of Arrays

from tiledb.bioimg.converters.ome_tiff import OMETiffConverter
cnv = OMETiffConverter()
cnv.convert_image("path_to_ome_tiff_image", "tiledb_array_group_path")

Open Slide to TileDB Group of Arrays

from tiledb.bioimg.converters.openslide import OpenSlideConverter
cnv = OpenSlideConverter()
cnv.convert_image("path_to_open_slide_image", "tiledb_array_group_path")


API Documentation is auto-generated. Following the instructions below:

cd docs && make html

will generate a docs/_build directory, where you can now open the index.html

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tiledb-bioimg-0.1.0.tar.gz (21.5 MB view hashes)

Uploaded Source

Built Distribution

tiledb_bioimg-0.1.0-py3-none-any.whl (20.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page