fiesta.disperse.Network.plot_network#

Network.plot_network(fil_idxs=None, length_unit=None, colors=None, splines=False, cylinders=False, avg=None, save=None, **kwargs)[source]#

Plot the filament network in 3D.

Parameters:

  • fil_idxs (list of int`’s) – ID’s of the filaments to plot. If None (default), all filaments are plotted.

  • length_unit (Unit, optional) – The unit of length to use for the plot. If None (default), takes the value u.pix if scale='pixel', else u.cm if scale='physical'.

  • colors (list, optional) – A list of matplotlib-compatible color strings corresponding to each filament plotted. If None (default), colors are picked by cycling through matplotlib tab10 colour palette.

  • splines (bool, optional) – If True, plots the spline fit (filament function) of each filament. Default value is False.

  • cylinders (bool, optional) – If True, plots the AREPO cells that are part of the filament. Default value is False. Requires arepo_ids to be set.

  • avg (ArepoVoronoiGrid, optional) – The source ArepoVoronoiGrid snapshot to use for plotting the cells. Omitted if cylinders=False.

  • save (str, optional) – File path to save the plot. If None (default), plot is not saved.

  • **kwargs (dict, optional) – Additional matplotlib-based keyword arguments to control finer details of the plot.

Returns:

fig (Figure) – Main Figure instance.