hest.tiff_save

hest.tiff_save(img: ndarray, save_path: str, pixel_size: float, pyramidal=True, bigtiff=False) → None

Save an image stored in a numpy array to the generic tiff format

Parameters:

• img (np.ndarray) – image stored in a number array, shape must be H x W x C

• save_path (str) – full path to tiff (including filename)

• pixel_size (float) – pixel size (in um/px) that will be embedded in the tiff

• pyramidal (bool, optional) – whenever to save to a pyramidal format (WARNING saving to a pyramidal format is much slower). Defaults to True.

• bigtiff (bool, optional) – whenever to save as a generic BigTiff, must be set to true if the resulting image is more than 4.1 GB . Defaults to False.