Skip to main content

Converter for Large Image.

Project description

Convert a variety of images into the most efficient format for Large Image.

Geospatial files are converted into cloud-optimized geotiff via gdal_translate. Single-image non-geospatial files are converted into pyramidal tiff files via pyvips. Multi-image tiff files are converted into tiff files with multiple pyramidal tiff images and have a custom image description to store frame details.

Some files can be read via the various tile sources in large_image without conversion but are inefficient (for example, uncompressed data in nd2 files). Converting these files will result in more efficient data access.

Installation

To install via pip with custom-built wheels:

pip install large-image-converter[sources] --find-links https://girder.github.io/large_image_wheels

The [sources] extra requirement is optional. When specified, all of the default large-image tile sources are installed for additional metadata extraction and format support.

Requirements

If the custom-built wheels do not cover your platform, or you want to use different versions of tools, you can install the prerequisites manually. For full functionality, the following packages and libraries are needed:

  • GDAL 3.1.0 or greater, including the command-line tools and the python library

  • libtiff, including the command-line tools

  • libvips

Additionally, the various tile sources for large_image can be used to read input files to extract and preserve metadata and to read files that can’t be read via libvips or GDAL. The requirements of those sources need to be installed.

Usage

Command Line

In the simplest use, an image can be converted via:

large_image_converter <source path>

An output image will be generated in the same directory as the source image.

The full list of options can be obtained via:

large_image_converter --help

From Python

The convert function contains all of the main functionality:

from large_image_converter import convert

convert(<source path>)

# See the options
print(convert.__doc__)

From Girder

The converter is installed by default when girder-large-image is installed. It relies on Girder Worker to actually run the conversion.

The conversion task can be reached via the user interface on the item details pages, via the createImageItem method on the ImageItem model, or via the POST item/{itemId}/tiles endpoint.

Limitations and Future Development

There are some limitations that may be improved with additional development.

  • For some multi-image files, such as OME Tiff files that cannot be read by an existing large_image tile source, the specific channel, z-value, or time step is not converted to readily usable metadata.

  • Whether the original file is stored in a lossy or lossless format is not always determined. If unknown, the output defaults to lossless, which may be needlessly large.

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.26.3.dev16.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file large-image-converter-1.26.3.dev16.tar.gz.

File metadata

File hashes

Hashes for large-image-converter-1.26.3.dev16.tar.gz
Algorithm Hash digest
SHA256 e3b9fb9d52d8714d8cab1252032d1616385a109d132c80d6eca38416550a7070
MD5 e8f62bd6f9cf8352a1e8f2f3178d67d9
BLAKE2b-256 e2fdf255bb6fd5f269761ac6abc59fc90f50b143f31e273da8aeb2cec87bd7ba

See more details on using hashes here.

Provenance

File details

Details for the file large_image_converter-1.26.3.dev16-py3-none-any.whl.

File metadata

File hashes

Hashes for large_image_converter-1.26.3.dev16-py3-none-any.whl
Algorithm Hash digest
SHA256 c227b5cb705003d7af5e4cf20a8189254f8a35e4e6a253dd697a21b62d72ecd0
MD5 d2992149acdf7ad542e62c4ab7af347c
BLAKE2b-256 26fcb49c7c4bdda28fb4aedd96ae986a7fa43271752dc01eb43ed57cf665f325

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