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

Uploaded Source

Built Distribution

File details

Details for the file large-image-converter-1.20.2.dev40.tar.gz.

File metadata

File hashes

Hashes for large-image-converter-1.20.2.dev40.tar.gz
Algorithm Hash digest
SHA256 b211a89e0c04355606d7685a170196e0fdf8484abb3b5ca285eb50daf57ae537
MD5 9f900e8383664ccfc1651b415b3c98d3
BLAKE2b-256 e679a3eecb76c38267f7afafdecc970698c179ab451d43b47f721edc709803d4

See more details on using hashes here.

Provenance

File details

Details for the file large_image_converter-1.20.2.dev40-py3-none-any.whl.

File metadata

File hashes

Hashes for large_image_converter-1.20.2.dev40-py3-none-any.whl
Algorithm Hash digest
SHA256 77c339228161f53da6a4442eae6bb514112bef5b587656e84b764dc6e1d25b9b
MD5 41a08f0aa0a2da1b1b2a26cbc523b639
BLAKE2b-256 d17cf4c763ba89b16c9fcf103e0c4ff5e0546f9861706fcc5ccde6269cf86a54

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