pygeon.viz.plot_spanningtree module

pygeon.viz.plot_spanningtree.plot_spanningtree(spt, mdg, fig_name=None, **kwargs)

Create a graphical illustration of the spanning tree superimposed on the grid.

Parameters:

• spt (pg.SpanningTree) – The spanningtree object

• mdg (pg.MixedDimensionalGrid | pg.Grid) – The object representing the grid.

• fig_name (str) – The name of the figure file to save the visualization.

• **kwargs –

  Additional options:

  • draw_grid (bool): Plot the grid.

  • draw_tree (bool): Plot the tree spanning the cells.

  • draw_cotree (bool): Plot the tree spanning the nodes.

  • start_color (str): Color of the “starting” cells, next to the boundary