plopp.mesh3d#

plopp.mesh3d(*, vertices, faces, vertexcolors=None, autoscale=True, camera=None, clabel=None, cmap='viridis', cmax=None, cmin=None, edgecolor=None, figsize=(600, 400), logc=None, nan_color=None, norm=None, title=None, vmax=None, vmin=None, **kwargs)[source]#

Create a 3D mesh plot.

Added in version 24.09.2.

Parameters:

  • vertices (Variable | DataArray | Dataset | DataGroup[Any] | ndarray | Node) – The vertices of the mesh. Must be a variable of dtype vector3.

  • faces (Variable | DataArray | Dataset | DataGroup[Any] | ndarray | Node) – The indices that construct the faces of the mesh.

  • vertexcolors (Variable | DataArray | Dataset | DataGroup[Any] | ndarray | Node | None, default: None) – The colors of the vertices of the mesh. If None, the mesh will have a single solid color.

  • autoscale (bool, default: True) – Automatically scale the colormap on updates if True.

  • camera (Camera | None, default: None) – Initial camera configuration (position, target).

  • clabel (str | None, default: None) – Label for colorscale (only applicable if cbar is True).

  • cmap (str, default: 'viridis') – The colormap to be used for the colorscale (only applicable if cbar is True).

  • cmax (Variable | float, default: None) – Upper limit for the colorscale (only applicable if cbar is True).

  • cmin (Variable | float, default: None) – Lower limit for the colorscale (only applicable if cbar is True).

  • edgecolor (str | None, default: None) – The color of the edges. If None, no edges are drawn.

  • figsize (tuple[int, int], default: (600, 400)) – The size of the 3d rendering area, in pixels: (width, height).

  • logc (bool | None, default: None) – Set to True for a logarithmic colorscale (only applicable if cbar is True).

  • nan_color (str | None, default: None) – Color to use for NaN values in color mapping (only applicable if cbar is True).

  • norm (Literal['linear', 'log', None], default: None) – Set to 'log' for a logarithmic colorscale (only applicable if cbar is True). Legacy, prefer logc instead.

  • title (str | None, default: None) – The figure title.

  • vmin (Variable | float, default: None) – Lower limit for the colorscale for (only applicable if cbar is True). Legacy, prefer cmin instead.

  • vmax (Variable | float, default: None) – Upper limit for the colorscale for (only applicable if cbar is True). Legacy, prefer cmax instead.

  • **kwargs – All other kwargs are forwarded the underlying plotting library.

Return type:

FigureLike