pyoculus.utils.convergence_domain.plot_convergence_domain

pyoculus.utils.convergence_domain.plot_convergence_domain(X1s: array, X2s: array, assigned_to: array, fixed_points: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], colors=None, **kwargs) → tuple

Plot the convergence domain for the FixedPoint solver in the X1s-X2s plane. If ax is None, a new figure is created, otherwise the plot is added to the existing figure.

Parameters:

  • X1s (np.ndarray) – The x1 values of the meshgrid.

  • X2s (np.ndarray) – The x2 values of the meshgrid.

  • assigned_to (np.ndarray) – The assigned number for each point in the meshgrid.

  • fixed_points (list) – The list of fixed points object (FixedPoint.OutputData).

  • colors (np.ndarray, optional) – The colors to use. Defaults to None. Should be of dimension (k, 3 or 4) for RGB/RGBA with k at least the number of fixed points plus one.

Keyword Arguments:

ax (matplotlib.axes.Axes, optional) – The axes to plot on. Defaults to None.

Returns:

A tuple containing:

  • fig (matplotlib.figure.Figure): The figure object.

  • ax (matplotlib.axes.Axes): The axes object.

Return type:

tuple