dask_image.imread package

dask_image.imread package

dask_image.imread.imread(fname, nframes=1, *, arraytype='numpy')[source]

Read image data into a Dask Array.

Provides a simple, fast mechanism to ingest image data into a Dask Array. This uses the pims package to open images.

Parameters
  • fname (str or pathlib.Path) – A glob like string that may match one or multiple filenames. Where multiple filenames match, they are sorted using natural (as opposed to alphabetical) sort.

  • nframes (int, optional) – Number of the frames to include in each chunk (default: 1).

  • arraytype (str, optional) – Array type for dask chunks. Available options: “numpy”, “cupy”.

Returns

array – A Dask Array representing the contents of all image files.

Return type

dask.array.Array

Warning

There are several known issues with this function, and users are recommended to use dask.array.image.imread or bioio instead.