sdkagent

tifffile API reference

51 public APIs from tifffile (cgohlke/tifffile) — 19 classes, 16 functions, 16 methods. Signatures extracted by static analysis of the actual source.

Repository: cgohlke/tifffile

KindCount
Classes19
Functions16
Methods16

API list

functifffile._imagecodecs.float24_decode(data:bytes, *byteorder:Literal['>', '<'] | None=None, *out:Any=None) -> NDArray[Any]
Return float32 array from float24.
functifffile._imagecodecs.lzma_decode(data:bytes, *out:Any=None) -> bytes
Decompress LZMA.
functifffile._imagecodecs.lzma_encode(data:bytes | NDArray[Any], level:int | None=None, *check:int | None=None, *out:Any=None) -> bytes
Compress LZMA.
functifffile._imagecodecs.packbits_decode(encoded:bytes, *out:Any=None) -> bytes
Decompress PackBits encoded byte string.
functifffile._imagecodecs.packints_decode(data:bytes, dtype:DTypeLike | None, bitspersample:int, *bitorder:str | None=None, *runlen:int=0, *out:Any=None) -> NDArray[Any]
Decompress bytes to array of integers.
functifffile._imagecodecs.packints_encode(data:ArrayLike, bitspersample:int, *bitorder:str | None=None, *runlen:int=0, *out:Any=None) -> bytes | bytearray
Tightly pack integers.
functifffile._imagecodecs.zlib_decode(data:bytes, *out:Any=None) -> bytes
Decompress Zlib DEFLATE.
functifffile._imagecodecs.zlib_encode(data:bytes | NDArray[Any], level:int | None=None, *out:Any=None) -> bytes
Compress Zlib DEFLATE.
functifffile._imagecodecs.zstd_decode(data:bytes, *out:Any=None) -> bytes
Decompress ZSTD.
functifffile._imagecodecs.zstd_encode(data:bytes | NDArray[Any], level:int | None=None, *out:Any=None) -> bytes
Compress ZSTD.
classtifffile.geodb.Angular
Angular Units.
classtifffile.geodb.CT
Coordinate Transformation Codes.
classtifffile.geodb.Datum
Geodetic Datum Codes.
classtifffile.geodb.DatumE
Ellipsoid-Only Geodetic Datum Codes.
classtifffile.geodb.Ellipse
Ellipsoid Codes.
classtifffile.geodb.GCS
Geographic CS Type Codes.
classtifffile.geodb.GCSE
Unspecified GCS based on ellipsoid.
classtifffile.geodb.GeoKeys
Geo keys.
classtifffile.geodb.Linear
Linear Units.
classtifffile.geodb.ModelType
Model Type Codes.
classtifffile.geodb.PCS
Projected CS Type Codes.
classtifffile.geodb.PM
Prime Meridian Codes.
classtifffile.geodb.Proj
Projection Codes.
classtifffile.geodb.RasterPixel
Raster Type Codes.
classtifffile.geodb.VertCS
Vertical CS Type Codes.
functifffile.lsm2bin.main(argv:list[str] | None=None) -> int
Lsm2bin command line usage main function.
classtifffile.numcodecs.Tiff
TIFF codec for Numcodecs.
methodtifffile.numcodecs.Tiff.decode(buf:Any, out:Any=None) -> Any
Return decoded image as NumPy array.
methodtifffile.numcodecs.Tiff.encode(buf:Any) -> bytes
Return TIFF file as bytes.
functifffile.numcodecs.register_codec(cls:type[Codec]=Tiff, codec_id:str | None=None) -> None
Register :py:class:`Tiff` codec with Numcodecs.
functifffile.tiff2fsspec.main(argv:list[str] | None=None) -> int
Tiff2fsspec command line usage main function.
functifffile.tiffcomment.main(argv:list[str] | None=None) -> int
Tiffcomment command line usage main function.
classtifffile.zarr.Tiff
TIFF codec for Zarr 3.
methodtifffile.zarr.Tiff.compute_encoded_size(input_byte_length:int, chunk_spec:ArraySpec) -> int
Compute size of encoded chunk in bytes.
methodtifffile.zarr.Tiff.from_dict(data:dict[str, JSON]) -> Self
Create instance of model from dictionary.
methodtifffile.zarr.Tiff.to_dict() -> dict[str, JSON]
Convert instance of model to dictionary.
classtifffile.zarr.ZarrFileSequenceStore
Zarr 3 store interface to image array in FileSequence.
methodtifffile.zarr.ZarrFileSequenceStore.exists(key:str) -> bool
Return whether key exists in store.
methodtifffile.zarr.ZarrFileSequenceStore.get(key:str, prototype:BufferPrototype, byte_range:ByteRequest | None=None) -> Buffer | None
Return value associated with key.
classtifffile.zarr.ZarrStore
Zarr 3 store base class.
methodtifffile.zarr.ZarrStore.delete(key:str) -> None
Remove key from store.
methodtifffile.zarr.ZarrStore.is_multiscales() -> bool
Return whether ZarrStore contains multiscales.
methodtifffile.zarr.ZarrStore.list() -> AsyncIterator[str]
Return all keys in store.
methodtifffile.zarr.ZarrStore.list_dir(prefix:str) -> AsyncIterator[str]
Return all keys and prefixes with prefix.
methodtifffile.zarr.ZarrStore.list_prefix(prefix:str) -> AsyncIterator[str]
Return all keys in store that begin with prefix.
methodtifffile.zarr.ZarrStore.set(key:str, value:Buffer) -> None
Store (key, value) pair.
methodtifffile.zarr.ZarrStore.supports_deletes() -> bool
Store supports deletes.
methodtifffile.zarr.ZarrStore.supports_listing() -> bool
Store supports listing.
methodtifffile.zarr.ZarrStore.supports_writes() -> bool
Store supports writes.
functifffile.zarr.register_codec() -> None
Register zarr 3 tifffile codec.
functifffile.zarr.zarr_selection(store:ZarrStore, selection:BasicSelection, *groupindex:str | None=None, *close:bool=True, *out:OutputType=None) -> NDArray[Any]
Return selection from Zarr store.

About this data

These signatures were extracted from the public source of cgohlke/tifffile using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries