load_image

load_image(location: str, key: str, dim_order: str | None = None) → BioImage[source]

Load key as BioIO image from specified location.

Method will load from the S3 bucket if the location begins with the s3:// protocol, otherwise it assumes the location is a local path.

Method currently only supports .tiff and ome.tiff images.

Parameters:

  • location – Object location (local path or S3 bucket).

  • key – Object key ending in .tiff or ome.tiff.

  • dim_order – Image dimensions order.

Returns:

Loaded image.