TiffPageSeries¶
- final class tifffile.TiffPageSeries(pages, /, shape=None, dtype=None, axes=None, *, attr=None, coords=None, index=None, parent=None, name=None, kind=None, truncated=False, multifile=False, squeeze=True, transform=None)¶
Sequence of TIFF pages making up multi-dimensional image.
Many TIFF based formats, such as OME-TIFF, use series of TIFF pages to store chunks of larger, multi-dimensional images. The image shape and position of chunks in the multi-dimensional image is defined in format-specific metadata. All pages in a series must have the same
TiffPage.hash()
, that is, the same shape, data type, and storage properties. Items of a series may be None (missing) or instances ofTiffPage
orTiffFrame
, possibly belonging to different files.- Parameters:
pages (Sequence[TiffPage | TiffFrame | None]) – List of TiffPage, TiffFrame, or None. The file handles of TiffPages or TiffFrames may not be open.
shape (Sequence[int] | None) – Shape of image array in series.
dtype (DTypeLike | None) – Data type of image array in series.
axes (str | None) – Character codes for dimensions in shape. Length must match shape.
attr (dict[str, Any] | None) – Arbitrary metadata associated with series.
index (int | None) – Index of series in multi-series files.
parent (TiffFile | None) – TiffFile instance series belongs to.
name (str | None) – Name of series.
kind (str | None) – Nature of series, such as, ‘ome’ or ‘imagej’.
truncated (bool) – Series is truncated, for example, ImageJ hyperstack > 4 GB.
multifile (bool) – Series contains pages from multiple files.
squeeze (bool) – Remove length-1 dimensions (except X and Y) from shape and axes by default.
transform (Callable[[NDArray[Any]], NDArray[Any]] | None) – Function to transform image data after decoding.
coords (Mapping[str, NDArray[Any] | None] | None)
- levels: list[TiffPageSeries]¶
Multi-resolution, pyramidal levels.
levels[0] is self
.
- dtype: numpy.dtype[Any]¶
Data type (native byte order) of image array in series.
- kind: str¶
Nature of series.
- name: str¶
Name of image series from metadata.
- transform: Callable[[NDArray[Any]], NDArray[Any]] | None¶
Function to transform image data after decoding.
- is_multifile: bool¶
Series contains pages from multiple files.
- is_truncated: bool¶
Series contains single page describing multi-dimensional image.
- property shape: tuple[int, ...]¶
Shape of image array in series.
- property axes: str¶
Character codes for dimensions in image array.
- property coords: dict[str, NDArray[Any]]¶
Ordered map of dimension names to coordinate arrays.
- get_shape(squeeze=None)¶
Return default, squeezed, or expanded shape of series.
- Parameters:
squeeze (bool | None) – Remove length-1 dimensions from shape.
- Return type:
tuple[int, …]
- get_axes(squeeze=None)¶
Return default, squeezed, or expanded axes of series.
- Parameters:
squeeze (bool | None) – Remove length-1 dimensions from axes.
- Return type:
str
- get_coords(squeeze=None)¶
Return default, squeezed, or expanded coords of series.
- Parameters:
squeeze (bool | None) – Remove length-1 dimensions from coords.
- Return type:
dict[str, NDArray[Any]]
- asarray(*, level=None, **kwargs)¶
Return images from series of pages as NumPy array.
- Parameters:
level (int | None) – Pyramid level to return. By default, the base layer is returned.
**kwargs (Any) – Additional arguments passed to
TiffFile.asarray()
.
- Return type:
NDArray[Any]
- aszarr(*, level=None, **kwargs)¶
Return image array from series of pages as Zarr store.
- Parameters:
level (int | None) – Pyramid level to return. By default, a multi-resolution store is returned.
**kwargs (Any) – Additional arguments passed to
ZarrTiffStore
.
- Return type:
- property dataoffset: int | None¶
Offset to contiguous image data in file.
- property is_pyramidal: bool¶
Series contains multiple resolutions.
- property attr: dict[str, Any]¶
Arbitrary metadata associated with series.
- property ndim: int¶
Number of array dimensions.
- property dims: tuple[str, ...]¶
Names of dimensions in image array.
- property sizes: dict[str, int]¶
Ordered map of dimension names to lengths.
- property size: int¶
Number of elements in array.
- property nbytes: int¶
Number of bytes in array.