A Girder plugin to view multiresolution images, using several viewers.
Clone or download
manthey Merge pull request #323 from girder/remove-file
Handle deleting a file from a largeImage item.
Latest commit 2550d65 Dec 5, 2018


Large Image Build Status codecov.io License

As a Girder Plugin

A Girder plugin to create, serve, and display large multiresolution images.

Upload image files to Girder. If they are not already in a tiled-format, they can be converted to tiled images. The plugin has a variety of viewers to examine the images.

Note that some features will not be available unless MongoDB version 3.4 or later is used for Girder's database.

As a stand-alone Python module

A Python module to work with large multiresolution images.


  1. Install OpenSlide

    If you are using Ubuntu 14.04, there is a known bug in OpenJPEG that will prevent OpenSlide from reading certain files. This requires building OpenJPEG, libtiff, and OpenSlide from source to work around the problem. For more information, there is an ansible script that builds these libraries, and some notes on the process.

    You may want to install optional utilities:

    • memcached - this allows memcached to be used for caching
  2. pip install --user numpy==1.10.2

    The python libtiff library fails to include numpy as a dependency, which means that it must be installed manually before you can install large_image.

    You may want to pip install optional modules:

    • psutil - this helps determine how much memory is available for caching
  3. git clone https://github.com/girder/large_image.git

  4. cd large_image

  5. Install the base dependencies with:

    pip install -e .

    or all optional dependencies with:

    pip install -e .[openslide,memcached]