stem.plot_utils module

class stem.plot_utils.PlotUtils

Bases: object

Utility class for plotting geometry.

static create_geometry_figure(ndim: int, geometry: Geometry, show_volume_ids: bool = False, show_surface_ids: bool = False, show_line_ids: bool = False, show_point_ids: bool = False) → Figure

Creates the geometry of the model in a plotly graph object figure.

Args:

  • ndim (int): Number of dimensions of the geometry. Either 2 or 3.

  • geometry (stem.geometry.Geometry): Geometry object.

  • show_volume_ids (bool): If True, the volume ids are shown in the plot.

  • show_surface_ids (bool): If True, the surface ids are shown in the plot.

  • show_line_ids (bool): If True, the line ids are shown in the plot.

  • show_point_ids (bool): If True, the point ids are shown in the plot.

Returns:

  • plotly.graph_objects.Figure: graph object figure