dataset._data_plot._DataArrayPlotterFM

dataset._data_plot._DataArrayPlotterFM(self, da)

Plot a DataArray with a GeometryFM geometry.

If DataArray has multiple time steps, the first step will be plotted.

If DataArray is 3D the surface layer will be plotted.

Examples

import mikeio
da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot()

Methods

Name	Description
contour	Plot data as contour lines.
contourf	Plot data as filled contours.
hist	Plot DataArray as histogram (using ax.hist).
line	Plot data as lines (timeseries if time is present).
mesh	Plot mesh only.
outline	Plot domain outline (using the boundary_polylines property).
patch	Plot data as coloured patches.

contour

dataset._data_plot._DataArrayPlotterFM.contour(ax=None, figsize=None, **kwargs)

Plot data as contour lines.

Examples

da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot.contour()

contourf

dataset._data_plot._DataArrayPlotterFM.contourf(ax=None, figsize=None, **kwargs)

Plot data as filled contours.

Examples

da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot.contourf()

hist

dataset._data_plot._DataArrayPlotterFM.hist(
    ax=None,
    figsize=None,
    title=None,
    **kwargs,
)

Plot DataArray as histogram (using ax.hist).

Parameters

Name	Type	Description	Default
bins	(int or sequence or str)	If bins is an integer, it defines the number of equal-width bins in the range. If bins is a sequence, it defines the bin edges, including the left edge of the first bin and the right edge of the last bin. by default: rcParams[“hist.bins”] (default: 10)	required
ax	Axes | None	Adding to existing axis, instead of creating new fig	None
figsize	tuple[float, float] | None	specify size of figure	None
title	str | None	axes title	None
**kwargs	Any	additional arguments passed to the plotting function	{}

See Also

matplotlib.pyplot.hist

Returns

Name	Type	Description
	<matplotlib.axes>

line

dataset._data_plot._DataArrayPlotterFM.line(ax=None, figsize=None, **kwargs)

Plot data as lines (timeseries if time is present).

mesh

dataset._data_plot._DataArrayPlotterFM.mesh(ax=None, figsize=None, **kwargs)

Plot mesh only.

Examples

da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot.mesh()

outline

dataset._data_plot._DataArrayPlotterFM.outline(ax=None, figsize=None, **kwargs)

Plot domain outline (using the boundary_polylines property).

Examples

da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot.outline()

patch

dataset._data_plot._DataArrayPlotterFM.patch(ax=None, figsize=None, **kwargs)

Plot data as coloured patches.

Examples

da = mikeio.read("../data/HD2D.dfsu")["Surface elevation"]
da.plot.patch()