dynamo.pl.plot_fixed_points_2d
- dynamo.pl.plot_fixed_points_2d(vecfld, marker='o', markersize=200, cmap=None, filltype=['full', 'top', 'none'], background=None, save_show_or_return='return', save_kwargs={}, ax=None)[source]
Plot fixed points stored in the VectorField2D class.
- Parameters:
vecfld (
VectorField2D) – an instance of the VectorField2D class which presumably has fixed points computed and stored.marker (
str) – the marker type. Any string supported by matplotlib.markers. Defaults to “o”.markersize (
float) – the size of the marker. Defaults to 200.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 {}.ax (
Optional[Axes]) – the matplotlib axes used for plotting. Default is to use the current axis. Defaults to None.
- Return type:
- 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.