dynamo.pl.plot_nullclines
- dynamo.pl.plot_nullclines(vecfld, vecfld_dict=None, lw=3, background=None, save_show_or_return='return', save_kwargs={}, ax=None)[source]
Plot nullclines stored in the VectorField2D class.
- Parameters:
vecfld (
VectorField2D) – an instance of the VectorField2D class which presumably has fixed points computed and stored.vecfld_dict (
Optional[Dict[str,Any]]) – a dict with entries to create a VectorField2D instance. Defaults to None.lw (
float) – the linewidth of the nullcline. Defaults to 3.background (
Optional[float]) – 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_nullclines’, “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.