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

Uploaded Source

Built Distribution

File details

Details for the file large-image-converter-1.20.4.dev22.tar.gz.

File metadata

File hashes

Hashes for large-image-converter-1.20.4.dev22.tar.gz
Algorithm Hash digest
SHA256 8e86d1f1cdc809d693e89a077d7ce96451d721f973bf556fef528bea637eaa8d
MD5 f0db0b36d09a4d371393b712d54af4c8
BLAKE2b-256 2e676f90ba54c1325726fc8d440df6145d048a9bdf260db4eaeac417ba1f4658

See more details on using hashes here.

Provenance

File details

Details for the file large_image_converter-1.20.4.dev22-py3-none-any.whl.

File metadata

File hashes

Hashes for large_image_converter-1.20.4.dev22-py3-none-any.whl
Algorithm Hash digest
SHA256 fecf7d83b53c54fe40b8cc963cf93368d3c3299558517bc2804cdcc719ff8267
MD5 a60cf88e1f9b827a7eb79c215b51fe18
BLAKE2b-256 009729752e7f219c59cfd10ca992bd854f22a185092dbb9cbe626b7d9cefe875

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