SheetVector¶

class tfv.visual.SheetVector(axes, extractor, expression, datum='sigma', limits=(0, 1), agg='mean', normalise=False, **kwargs)¶

Class for dynamic visualization of model result sheet extracts as gridded vector field

Parameters

axes (matplotlib.pyplot.Axes) – Axes object to display/render the graphics object
extractor (tfv.extractor.Extractor) – Extractor object which is extracting data
expression (tuple) – Tuple of string expressions that defines vector (vec_x, vec_y)
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.