imread¶
- tifffile.imread(files: str | os.PathLike[Any] | FileHandle | IO[bytes] | Sequence[str | os.PathLike[Any]] | None = None, *, selection: Any | None = None, aszarr: Literal[False] = False, key: int | slice | Iterable[int] | None = None, series: int | None = None, level: int | None = None, squeeze: bool | None = None, maxworkers: int | None = None, buffersize: int | None = None, mode: Literal['r', 'r+'] | None = None, name: str | None = None, offset: int | None = None, size: int | None = None, pattern: str | None = None, axesorder: Sequence[int] | None = None, categories: dict[str, dict[str, int]] | None = None, imread: Callable[..., NDArray[Any]] | None = None, sort: Callable[..., Any] | bool | None = None, container: str | os.PathLike[Any] | None = None, chunkshape: tuple[int, ...] | None = None, dtype: DTypeLike | None = None, axestiled: dict[int, int] | Sequence[tuple[int, int]] | None = None, ioworkers: int | None = 1, chunkmode: CHUNKMODE | int | str | None = None, fillvalue: int | float | None = None, zattrs: dict[str, Any] | None = None, multiscales: bool | None = None, omexml: str | None = None, out: OutputType = None, out_inplace: bool | None = None, _multifile: bool | None = None, _useframes: bool | None = None, **kwargs: Any) NDArray[Any] ¶
- tifffile.imread(files: str | os.PathLike[Any] | FileHandle | IO[bytes] | Sequence[str | os.PathLike[Any]] | None = None, *, selection: Any | None = None, aszarr: Literal[True], key: int | slice | Iterable[int] | None = None, series: int | None = None, level: int | None = None, squeeze: bool | None = None, maxworkers: int | None = None, buffersize: int | None = None, mode: Literal['r', 'r+'] | None = None, name: str | None = None, offset: int | None = None, size: int | None = None, pattern: str | None = None, axesorder: Sequence[int] | None = None, categories: dict[str, dict[str, int]] | None = None, imread: Callable[..., NDArray[Any]] | None = None, imreadargs: dict[str, Any] | None = None, sort: Callable[..., Any] | bool | None = None, container: str | os.PathLike[Any] | None = None, chunkshape: tuple[int, ...] | None = None, chunkdtype: DTypeLike | None = None, axestiled: dict[int, int] | Sequence[tuple[int, int]] | None = None, ioworkers: int | None = 1, chunkmode: CHUNKMODE | int | str | None = None, fillvalue: int | float | None = None, zattrs: dict[str, Any] | None = None, multiscales: bool | None = None, omexml: str | None = None, out: OutputType = None, out_inplace: bool | None = None, _multifile: bool | None = None, _useframes: bool | None = None, **kwargs: Any) ZarrTiffStore | ZarrFileSequenceStore
- tifffile.imread(files: str | os.PathLike[Any] | FileHandle | IO[bytes] | Sequence[str | os.PathLike[Any]] | None = None, *, selection: Any | None = None, aszarr: bool = False, key: int | slice | Iterable[int] | None = None, series: int | None = None, level: int | None = None, squeeze: bool | None = None, maxworkers: int | None = None, buffersize: int | None = None, mode: Literal['r', 'r+'] | None = None, name: str | None = None, offset: int | None = None, size: int | None = None, pattern: str | None = None, axesorder: Sequence[int] | None = None, categories: dict[str, dict[str, int]] | None = None, imread: Callable[..., NDArray[Any]] | None = None, imreadargs: dict[str, Any] | None = None, sort: Callable[..., Any] | bool | None = None, container: str | os.PathLike[Any] | None = None, chunkshape: tuple[int, ...] | None = None, chunkdtype: DTypeLike | None = None, axestiled: dict[int, int] | Sequence[tuple[int, int]] | None = None, ioworkers: int | None = 1, chunkmode: CHUNKMODE | int | str | None = None, fillvalue: int | float | None = None, zattrs: dict[str, Any] | None = None, multiscales: bool | None = None, omexml: str | None = None, out: OutputType = None, out_inplace: bool | None = None, _multifile: bool | None = None, _useframes: bool | None = None, **kwargs: Any) NDArray[Any] | ZarrTiffStore | ZarrFileSequenceStore
Return image from TIFF file(s) as NumPy array or Zarr 2 store.
The first image series in the file(s) is returned by default.
- Parameters:
files – File name, seekable binary stream, glob pattern, or sequence of file names. May be None if container is specified.
selection – Subset of image to be extracted. If not None, a Zarr 2 array is created, indexed with the selection value, and returned as a NumPy array. Only segments that are part of the selection will be read from file. Refer to the Zarr 2 documentation for valid selections. Depending on selection size, image size, and storage properties, it may be more efficient to read the whole image from file and then index it.
aszarr – Return file sequences, series, or single pages as Zarr 2 store instead of NumPy array if selection is None.
mode – Passed to
TiffFile
.name – Passed to
TiffFile
.offset – Passed to
TiffFile
.size – Passed to
TiffFile
.omexml – Passed to
TiffFile
._multifile – Passed to
TiffFile
._useframes – Passed to
TiffFile
.key – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.series – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.level – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.squeeze – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.maxworkers – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.buffersize – Passed to
TiffFile.asarray()
orTiffFile.aszarr()
.imread – Passed to
FileSequence
.container – Passed to
FileSequence
.sort – Passed to
FileSequence
.pattern – Passed to
FileSequence
.axesorder – Passed to
FileSequence
.axestiled – Passed to
FileSequence
.categories – Passed to
FileSequence
.ioworkers – Passed to
FileSequence
.chunkmode – Passed to
ZarrTiffStore
orZarrFileSequenceStore
.fillvalue – Passed to
ZarrTiffStore
orZarrFileSequenceStore
.zattrs – Passed to
ZarrTiffStore
orZarrFileSequenceStore
.multiscales – Passed to
ZarrTiffStore
orZarrFileSequenceStore
.chunkshape – Passed to
FileSequence.asarray()
orZarrFileSequenceStore
.chunkdtype – Passed to
FileSequence.asarray()
orZarrFileSequenceStore
.out_inplace – Passed to
FileSequence.asarray()
out – Passed to
TiffFile.asarray()
,FileSequence.asarray()
, orzarr_selection()
.imreadargs – Additional arguments passed to
FileSequence.imread
.**kwargs – Additional arguments passed to
TiffFile
orFileSequence.imread
.
- Returns:
Images from specified files, series, or pages. Zarr 2 store instances must be closed after use. See
TiffPage.asarray()
for operations that are applied (or not) to the image data stored in the file.