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. IfNone
(default), all filaments are plotted.length_unit (
Unit
, optional) – The unit of length to use for the plot. IfNone
(default), takes the valueu.pix
ifscale='pixel'
, elseu.cm
ifscale='physical'
.colors (
list
, optional) – A list of matplotlib-compatible color strings corresponding to each filament plotted. IfNone
(default), colors are picked by cycling through matplotlib tab10 colour palette.splines (
bool
, optional) – IfTrue
, plots the spline fit (filament function) of each filament. Default value isFalse
.cylinders (
bool
, optional) – IfTrue
, plots the AREPO cells that are part of the filament. Default value isFalse
. Requiresarepo_ids
to be set.avg (
ArepoVoronoiGrid
, optional) – The sourceArepoVoronoiGrid
snapshot to use for plotting the cells. Omitted ifcylinders=False
.save (
str
, optional) – File path to save the plot. IfNone
(default), plot is not saved.**kwargs (
dict
, optional) – Additional matplotlib-based keyword arguments to control finer details of the plot.
- Returns: