prose.Image.save#

Image.save(filepath, image_dtype='float64', low_data=False)[source]#

Save the image to a file using pickle.

Note that the pickle will hold the Image dataclass dict attributes.

Parameters:
  • filepath (str) – The path to the file to save.

  • image_dtype (str, optional) – The data type to use for the image data, by default “int16”.

  • low_data (bool, optional) – Whether to scale the data to a lower range, by default True.

Return type:

None