timflow.steady.plots.PlotSteady.contour#

timflow.steady.plots.PlotSteady.contour(win, ngr=20, layers=0, levels=20, layout=True, labels=True, decimals=0, color=None, ax=None, figsize=None, legend=True, return_contours=False, **kwargs)#

Head contour plot.

Parameters:

  • win (list or tuple) – [xmin, xmax, ymin, ymax]

  • ngr (scalar, tuple or list) – if scalar: number of grid points in x and y direction if tuple or list: nx, ny, number of grid points in x and y directions

  • layers (integer, list or array) – layers for which grid is returned

  • levels (integer or array (default 20)) – levels that are contoured

  • layout (boolean (default True)) – plot layout of elements

  • labels (boolean (default True)) – print labels along contours

  • decimals (integer (default 0)) – number of decimals of labels along contours

  • color (str or list of strings) – color of contour lines

  • ax (matplotlib.Axes) – axes to plot on, default is None which creates a new figure

  • figsize (tuple of 2 values (default is mpl default)) – size of figure

  • legend (list or boolean (default True)) – add legend to figure if list of strings: use strings as names in legend

  • return_contours (bool, optional) – if True, return list of contour sets for each contoured layer

Returns:

  • ax (matplotlib.Axes) – axes with plot

  • cs (list) – of contour sets for each contoured layer, only if return_contours=True