neuralib.plot.plot.diag_histplot

neuralib.plot.plot.diag_histplot(x, y, bins=30, *, anchor='above', hist_width=0.3, scatter_kws=None, polygon_kws=None, ax=None)[source]

Scatter plot with an overlaid histogram along the diagonal

Dimension parameters:

N = number of sample points

Parameters:

  • x (ndarray[tuple[Any, ...], dtype[Any]] | Sequence[Any] | pd.Series | pl.Series) – Numerical array. Array[float, N]

  • y (ndarray[tuple[Any, ...], dtype[Any]] | Sequence[Any] | pd.Series | pl.Series) – Numerical array. Array[float, N]

  • bins (int | Sequence[float] | str) – Number of bins (or bin specification) for np.histogram()

  • anchor (Literal['above', 'below']) – Whether the histogram bars extend above or below the main diagonal

  • hist_width (float) – Maximum length of histogram bars in the rotated space

  • scatter_kws (dict | None) – Keyword arguments passed to ax.scatter()

  • polygon_kws (dict | None) – Keyword arguments passed to each Polygon() patch

  • ax (Axes | None) – Axes

Returns:

Return type:

None