dynamo.pl.plot_fixed_points

dynamo.pl.plot_fixed_points(vecfld, vecfld_dict=None, marker='o', markersize=200, c='w', cmap=None, filltype=['full', 'top', 'none'], background=None, save_show_or_return='return', save_kwargs={}, plot_method='matplotlib', ax=None, **kwargs)[source]

Plot fixed points stored in the VectorField class.

Parameters:

  • vecfld (Topography2D) – an instance of the vector_field class.

  • vecfld_dict (Optional[Dict[str, Any]]) – a dict with entries to create a VectorField2D instance. Defaults to None.

  • marker (str) – the marker type. Any string supported by matplotlib.markers. Defaults to “o”.

  • markersize (int) – the size of the marker. Defaults to 200.

  • c (str) – the marker colors. Defaults to “w”.

  • cmap (Optional[str]) – the name of a matplotlib colormap to use for coloring or shading the confidence of fixed points. If None, the default color map will set to be viridis (inferno) when the background is white (black). Defaults to None.

  • filltype (List[str]) – the fill type used for stable, saddle, and unstable fixed points. Default is ‘full’, ‘top’ and ‘none’, respectively. Defaults to [“full”, “top”, “none”].

  • background (Optional[str]) – the background color of the plot. Defaults to None.

  • save_show_or_return (Literal['save', 'show', 'return']) – whether to save, show or return the figure. Defaults to “return”.

  • save_kwargs (Dict[str, Any]) – a dictionary that will be passed to the save_show_ret function. By default, it is an empty dictionary and the save_show_ret function will use the {“path”: None, “prefix”: ‘plot_fixed_points’, “dpi”: None, “ext”: ‘pdf’, “transparent”: True, “close”: True, “verbose”: True} as its parameters. Otherwise, you can provide a dictionary that properly modify those keys according to your needs. Defaults to {}.

  • plot_method (Literal['pv', 'matplotlib']) – the method to plot 3D points. Options include pv (pyvista) and matplotlib.

  • ax (Optional[Axes]) – the matplotlib axes or pyvista plotter used for plotting. Default is to use the current axis. Defaults to None.

Return type:

Optional[Axes]

Returns:

None would be returned by default. If save_show_or_return is set to be ‘return’, the Axes of the generated figure would be returned.