hookeai.ioput.plots.scatter_xny_data

scatter_xny_data(data_xy_list, data_labels=None, is_error_bar=False, range_type='min-max', x_lims=(None, None), y_lims=(None, None), title=None, x_label=None, y_label=None, x_scale='linear', y_scale='linear', x_tick_format=None, y_tick_format=None, is_latex=False)[source]

Scatter data in xy axes with given range of y-values for each x-value.

Parameters:

  • data_xy_list (list[np.ndarray(2d)]) – List of data arrays. Each data array contains plot data stored columnwise such that data_array[:, 0] holds the x-axis data and data_array[:, 1:] holds the y-axis data.

  • data_labels (list, default=None) – Labels of data sets (x_i, y_i) provided in data_xy and sorted accordingly. If None, then no labels are displayed.

  • is_error_bar (bool, default=False) – If True, then plot error bar according with range type.

  • range_type ({'min-max', 'mean-std', None}, default='min-max') – Type of range of y-values to be plotted for each x-value around the mean. If None, only the mean is plotted. Only effective if is_error_bar is set to True.

  • x_lims (tuple, default=(None, None)) – x-axis limits in data coordinates.

  • y_lims (tuple, default=(None, None)) – y-axis limits in data coordinates.

  • title (str, default=None) – Plot title.

  • x_label (str, default=None) – x-axis label.

  • y_label (str, default=None) – y-axis label.

  • x_scale (str {'linear', 'log'}, default='linear') – x-axis scale. If None or invalid format, then default scale is set. Scale ‘log’ overrides any x-axis ticks formatting.

  • y_scale (str {'linear', 'log'}, default='linear') – y-axis scale. If None or invalid format, then default scale is set. Scale ‘log’ overrides any y-axis ticks formatting.

  • x_tick_format ({'int', 'float', 'exp'}, default=None) – x-axis ticks formatting. If None or invalid format, then default formatting is set.

  • y_tick_format ({'int', 'float', 'exp'}, default=None) – y-axis ticks formatting. If None or invalid format, then default formatting is set.

  • is_latex (bool, default=False) – If True, then render all strings in LaTeX. If LaTex is not available, then this option is silently set to False and all input strings are processed to remove $(…)$ enclosure.

Returns:

  • figure (Matplotlib Figure) – Figure.

  • axes (Matplotlib Axes) – Axes.