ovrlpy.plot_signal_integrity
============================

.. py:function:: ovrlpy.plot_signal_integrity(ovrlp, *, signal_threshold = _SIGNAL_THRESHOLD, cmap = BIH_CMAP, histogram = True, scalebar = SCALEBAR_PARAMS, figsize = (9, 6), **kwargs)

   Plots the determined signal integrity of the tissue sample in a signal integrity map.

   :param ovrlp:
   :type ovrlp: Ovrlp
   :param signal_threshold: Threshold below which the signal is faded out in the plot,
                            to avoid displaying noisy areas with low predictive confidence.
                            Pixels below the threshold are not counted in the histogram.
   :type signal_threshold: float, optional
   :param cmap: Colormap for display.
   :type cmap: str | matplotlib.colors.Colormap, optional
   :param histogram: Whether to plot a histogram of integrity values alongside the map.
   :type histogram: bool, optional
   :param scalebar: If `None` no scalebar will be plotted. Otherwise a dictionary with
                    additional kwargs for ``matplotlib_scalebar.scalebar.ScaleBar``.
                    By default :py:attr:`ovrlpy.SCALEBAR_PARAMS`
   :type scalebar: dict[str, typing.Any] | None
   :param figsize: Size of the figure in inches.
   :type figsize: tuple[float, float]
   :param kwargs: Other keyword arguments are passed to :py:func:`matplotlib.pyplot.subplots`

   :rtype: matplotlib.figure.Figure