ovrlpy.plot_region_of_interest

ovrlpy.plot_region_of_interest(ovrlp, x, y, *, window_size=30, signal_threshold=5.0, scalebar=SCALEBAR_PARAMS, figsize=(12, 8), **kwargs)

Plot an overview of a zoomed-in region of interest.

Parameters:

  • ovrlp (Ovrlp) – Ovrlp object containing the fitted model

  • x (float) – x coordinate of the region of interest

  • y (float) – y coordinate of the region of interest

  • window_size (int, optional) – Size of the window to display.

  • signal_threshold (float, optional) – Threshold for the signal plot.

  • scalebar (dict[str, Any] | None) – If None no scalebar will be plotted. Otherwise a dictionary with additional kwargs for matplotlib_scalebar.scalebar.ScaleBar. By default ovrlpy.SCALEBAR_PARAMS

  • figsize (tuple[float, float]) – Size of the figure in inches.

  • kwargs – Other keyword arguments are passed to matplotlib.pyplot.figure()

Return type:

Figure