ess.imaging.io.export_image_stacks_as_tiff#
- ess.imaging.io.export_image_stacks_as_tiff(*, output_dir, image_stacks, merge_image_by_key, overwrite, progress_wrapper=<function dummy_progress_wrapper>, image_prefix_map={ImageKey.DARK_CURRENT: 'dc', ImageKey.OPEN_BEAM: 'ob', ImageKey.SAMPLE: 'sample'})[source]#
Save images into disk.
- Parameters:
image_stacks (
io.AllImageStacks
(dict
)) – Image stacks to save.merge_image_by_key (
bool
) – Flag to merge images into one file.overwrite (
bool
) – Flag to overwrite existing files. If True, it will clear the output directory before saving images.image_prefix_map (
dict
[ImageKey
,str
], default:{<ImageKey.SAMPLE: 0>: 'sample', <ImageKey.DARK_CURRENT: 2>: 'dc', <ImageKey.OPEN_BEAM: 1>: 'ob'}
) – Map of image name prefixes to their corresponding image key.
- Return type: