SheetContour¶

class tfv.visual.SheetContour(axes, extractor, expression, datum='sigma', limits=(0, 1), agg='mean', mask_dry=True, **kwargs)¶

Class for dynamic visualization of model result sheet extracts as contours

Parameters:

axes (matplotlib.pyplot.Axes) – Axes object to display/render the graphics object
extractor (tfv.extractor.Extractor) – Extractor object which is extracting data
expression (string) – Expression that defines a variable
datum ({'sigma', 'depth', 'height', 'elevation'}) – Vertical depth-averaging datum i.e sigma, depth, height, elevation, top, bottom.
limits (tuple) – Vertical depth-averaging limits (z1, z2) relative to vertical datum.
agg ({'mean', 'min', 'max'}, optional) – Depth-averaging aggregation function. Defaults to ‘mean’.
mask_dry (bool, optional) – If True, dry cells are masked. Defaults to True.
zorder (integer) – Layer order in which graphics object will be rendered (0 is bottom/first)
cmap (matplotlib.colors.LinearSegmentedColormap) – Colormap object for mapping normalized data (0 - 1) to rgb colors
norm (matplotlib.colors.BoundaryNorm) – Normalization object for normalizing raw data to (0 - 1) based on (min, max)
clim (tuple) – Colour limits of the underlying matplotlib.collections.PatchCollection object (min, max)
edgecolor (string) – Sets the mesh edge colouring of the underlying matplotlib.collections object
antialiased (bool) – Sets the antialiasing state for rendering the underlying matplotlib.collections object
alpha (float) – Sets the transparencies of the underlying matplotlib.collections object