Skip to main content

Converter for Large Image.

Project description

Large Image Build Status codecov.io License

Python modules to work with large multiresolution images.

Quick Installation via pip

In addition to installing the large-image package, you’ll need at least one tile source (a large-image-source-xxx package). You can install everything from the main project with one of these commands:

  • Install all tile sources and all Girder plugins on linux: pip install large-image[all] girder-large-image-annotation[tasks] --find-links https://girder.github.io/large_image_wheels

  • Install all tile sources on linux: pip install large-image[all] --find-links https://girder.github.io/large_image_wheels

Modules

Large Image consists of several Python modules designed to work together. These include:

  • large-image: The core module. You can specify extras_require of the name of any tile source included with this repository, sources for all of the tile sources in the repository, memcached for using memcached for tile caching, or all for all of the tile sources and memcached.

  • large-image-converter: A utility for using pyvips and other libraries to convert images into pyramidal tiff files that can be read efficiently by large_image.

  • girder-large-image: Large Image as a Girder 3.x plugin. You can specify extras_require of tasks to install a Girder Worker task that can convert otherwise unreadable images to pyramidal tiff files.

  • girder-large-image-annotation: Annotations for large images as a Girder 3.x plugin.

  • large-image-tasks: A utility for running the converter via Girder Worker.

  • Tile sources:

    • large-image-source-tiff: A tile source for reading pyramidal tiff files in common compression formats.

    • large-image-source-openslide: A tile source using the OpenSlide library. This works with svs, ndpi, Mirax, tiff, vms, and other file formats.

    • large-image-source-ometiff: A tile source using the tiff library that can handle some multi-frame OMETiff files.

    • large-image-source-pil: A tile source for small images via the Python Imaging Library (Pillow).

    • large-image-source-gdal: A tile source for reading geotiff files via GDAL. This handles source data with more complex transforms than the mapnik tile source.

    • large-image-source-mapnik: A tile source for reading geotiff and netcdf files via Mapnik and GDAL. This handles more vector issues than the gdal tile source.

    • large-image-source-openjpeg: A tile source using the Glymur library to read jp2 (JPEG 2000) files.

    • large-image-source-nd2: A tile source for reading nd2 (NIS Element) images.

    • large-image-source-bioformats: A tile source for reading any file handled by the Java Bioformats library.

    • large-image-source-test: A tile source that generates test tiles, including a simple fractal pattern. Useful for testing extreme zoom levels.

    • large-image-source-dummy: A tile source that does nothing.

    Most tile sources can be used with girder-large-image.

Installation

To install all packages from source:

  1. Clone the repository:

    git clone https://github.com/girder/large_image.git

    Change to the source directory:

    cd large_image

  2. Install all packages and dependencies:

    pip install -e . -r requirements-dev.txt

Tile source prerequisites

Many tile sources have complex prerequisites. These can be installed directly using your system’s package manager or from some prebuilt Python wheels for Linux. The prebuilt wheels are not official packages, but they can be used by instructing pip to use them by preference:

pip install -e . -r requirements-dev.txt --find-links https://girder.github.io/large_image_wheels

Migration from Girder 2 to Girder 3

If you are migrating a Girder 2 instance with Large Image to Girder 3, you need to do a one time database update. Specifically, one of the tile sources’ internal name changed.

Access the Girder Mongo database. The command for this in a simple installation is:

mongo girder

Update the tile source name by issuing the Mongo command:

db.item.updateMany({"largeImage.sourceName": "svs"}, {$set: {"largeImage.sourceName": "openslide"}})

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

large-image-converter-1.3.3.dev64.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file large-image-converter-1.3.3.dev64.tar.gz.

File metadata

  • Download URL: large-image-converter-1.3.3.dev64.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for large-image-converter-1.3.3.dev64.tar.gz
Algorithm Hash digest
SHA256 4a5b1a529e1e53ecfc3e10f1bceee9bc863d906cb77ec4e47c4bfa22fc3c205f
MD5 96389aa79fe4d427d48c619116daee91
BLAKE2b-256 485717f44ba633c4eb1aa9257f27b79984ed8d45e47e15e68c70d227e7ea254a

See more details on using hashes here.

Provenance

File details

Details for the file large_image_converter-1.3.3.dev64-py3-none-any.whl.

File metadata

  • Download URL: large_image_converter-1.3.3.dev64-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for large_image_converter-1.3.3.dev64-py3-none-any.whl
Algorithm Hash digest
SHA256 bb16d59046c1596dd736ef2b62637751a1ba17836e46b81d2219bd2888f8cd90
MD5 9cf8dba23b02462c9aad4581901798a1
BLAKE2b-256 8c9f1129ead4df205d6bc54b704f72ac8b9d0fba2666d39b96c92165f02b1050

See more details on using hashes here.

Provenance

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