mahos.meas.confocal.ConfocalIO#

class mahos.meas.confocal.ConfocalIO(logger=None)#

IO class for Confocal.

save_image(filename: str, image: Image, note: str = '') → bool#

Save image to filename. return True on success.

load_image(filename: str) → Image | None#

Load image from filename. return None if load is failed.

export_image(filename: str, image: Image, params: dict | None = None) → bool#

Export the image to text or image files.

Parameters:

  • params.only (bool) – set True to use image only mode

  • params.pos (tuple[float,float]|None) – if given, position crosshair is plotted

  • params.vmin (float) – lower limit of intensity value

  • params.vmax (float) – upper limit of intensity value

  • params.invX (bool) – set True to invert x-axis

  • params.invY (bool) – set True to invert y-axis

  • params.cmap (str) – matplotlib colormap name

  • params.aspect (str|float) – matplotlib aspect

  • params.figsize (tuple[float, float]) – matplotlib figure size (w, h)

  • params.fontsize (float) – matplotlib fontsize

  • params.dpi (float) – matplotlib dpi

save_trace(filename: str, trace: Trace, note: str = '')#

Save trace to filename. return True on success.

load_trace(filename: str) → Trace | None#

Load trace from filename. return None if load is failed.

export_trace(filename: str, trace: Trace, params: dict | None = None) → bool#

Export the trace to text or image files.