mesoscopy.analysis.plot

Functions

`add_textbox`(axis, text[, loc, fontsize])
`plot_dataset_1D`(id, var[, rescale_axes, ...])	Make a 1D plot for a given dataset.
`plot_dataset_2D`(id, var[, rescale_axes, ...])	Make a 2D plot for a given dataset.
`use_style`([name])

mesoscopy.analysis.plot.use_style(name=None)

mesoscopy.analysis.plot.add_textbox(axis, text, loc='best', fontsize=10, **kwargs)

mesoscopy.analysis.plot.plot_dataset_1D(id: int | str, var: str, rescale_axes: bool = True, multiply_by: Tuple[float, float] = (1, 1), complex_plot_type: str = 'mag_and_phase', complex_plot_phase: str = 'degrees', size=8, **kwargs: Any)

Make a 1D plot for a given dataset. The plot has a title comprising run id, measurement name and run timestamp.

**kwargs passed to matplotlib’s plotting function.

Args:

id: either run_id or guid var: variable to plot rescale_axes: True: tick labels and units of parameters are rescaled:

0.001V becomes 1mV.

multiply_by rescale axes with a factor. takes tuple for (x,y) complex_plot_type: convert complex-valued parameters to two

real-valued parameters. takes either "real_and_imag", "real", "imag", "mag_and_phase", "mag" or "phase".

complex_plot_phase: if plotting complex with type "mag_and phase" or "phase", takes either "radians" or "degrees".

Returns:

axes and colorbar handles

TODO: see dataset2D.

mesoscopy.analysis.plot.plot_dataset_2D(id: int | str, var: str, rescale_axes: bool = True, multiply_by: Tuple[float, float, float] = (1, 1, 1), complex_plot_type: str = 'mag_and_phase', complex_plot_phase: str = 'degrees', size=8, **kwargs: Any)

Make a 2D plot for a given dataset. The plot has a title that comprises run id, measurement name and run timestamp.

**kwargs passed to matplotlib’s plotting function.

Args:

id: either run_id or guid var: variable to plot rescale_axes: True: tick labels and units of parameters are rescaled:

0.001V becomes 1mV.

multiply_by: rescale axes with a factor. takes tuple for (x,y,z) complex_plot_type: convert complex-valued parameters to two

real-valued parameters. takes either "real_and_imag" or "mag_and_phase"

complex_plot_phase: if plotting complex with type "mag_and_phase",: takes either "radians" or "degrees".

Returns:

axes and colorbar handles

TODO:

rewrite so that it can be supplied with matplotlib axes or list of

axes, with colorbar axes.