class foxes.output.SeqFlowAnimationPlugin(foxes.algorithms.sequential.SequentialPlugin)[source]

Plugin for creating data for a 2D flow animation during sequential iterations

Attributes

orientation: str

The orientation, either “yx”, “xz” or “yz”

title_fun: callable

A function that takes the current iteration and state index and returns a title string.

data_pars: dict

Additional parameters for plot data calculation

Public members

SeqFlowAnimationPlugin(orientation, title_fun=None, **data_pars)[source]

Constructor.

initialize(algo)[source]

Initialize data based on the intial iterator

update(algo, fres, pres=None)[source]

Updates data based on current iteration

gen_images(ax, **plot_pars)[source]

Parameters

ax: matplotlib.Axis

The plotting axis

plot_pars: dict, optional

Additional parameters for plotting

finalize(algo)[source]

Finalize data based on the final iterator