sme_contrib.plot.concentration_heatmap3D

sme_contrib.plot.concentration_heatmap3D(simulation_result: SimulationResult, species: list[str], cmap: str | ndarray | LookupTable = 'viridis', show_cmap: bool = False, plotter_kwargs: None | dict[str, Any] = None, plotfunc_kwargs: None | dict[str, dict[str, Any]] = None) → Plotter

Plot a 3D facet grid of species concentrations. This function creates a 3D facet grid of species concentrations. Each panel will be a 3D plot of the concentration of a single species. This function is a wrapper around the facet_grid_3D function.

Parameters:

• simulation_result (sme.SimulationResult) – a single simulation result object, i.e., a single recorded frame of the simulations

• species (list[str]) – A list of species strings

• cmap (str | np.ndarray | LookupTable, optional) – Name of a matplotlib colorbar. Defaults to “viridis”.

• show_cmap (bool, optional) – Whether or not to show the colorbar on the plot. Defaults to False.

• plotter_kwargs (dict[str, Any], optional) – Additional keyword arguments for the used pyVista.Plotter. Defaults to None.

• plotfunc_kwargs (dict[str, dict[str, Any]], optional) – Additional keyword arguments passed to each species’ plotting call, keyed by species label. Each value is forwarded to plotter.add_mesh for that subplot. Defaults to None. Example: {“A_nucl”: {“opacity”: 0.5}, “A_cell”: {“opacity”: 0.2}}.

Raises:

• ValueError – if the data is not 3D

• ValueError – if a given species is not found in the simulation result

Returns:

pyvista.Plotter object the data has been plotted into

Return type:

Plotter