blue_sampler.plot

blue_sampler.plot(points, auto_zoom=False, max_points=30000, ax=None, return_fig=False, figsize=(8, 8), **scatter_kw)[source]

Scatter plot of a 2-D or 3-D point set.

If auto_zoom is set to True:

For large point sets the view is automatically zoomed so that at most max_points points are displayed.

Parameters:

  • points (NDArray) – Point coordinates, with D in {2, 3}. Higher-dimensional arrays are silently projected onto the first 3 axes.

  • auto_zoom (bool) – Whether to apply auto_zoom for large point sets.

  • max_points (int) – Maximum number of points to draw used for auto_zoom.

  • ax (Axes | None) – Existing axes to draw into. If None, a new figure is created.

  • return_fig (bool) – If True, returns (fig, ax). If False, displays the figure and returns None.

  • **scatter_kw – Extra keyword arguments forwarded to ax.scatter.

Return type:

tuple[Figure, Axes] | None