ParticlesScatter

class tfv.visual.ParticlesScatter(axes, extractor, expression=None, datum=None, limits=None, show=None, show_method='any', highlight=None, highlight_method='any', track=0, scale=0.001, shape='tri', **kwargs)

Class for dynamic visualization of particle tracking model results as collection of patches

Parameters:

  • axes (matplotlib.pyplot.Axes) – Axes object to display/render the graphics object

  • extractor (tfv.particles.FvParticles) – Extractor object which is extracting data

  • expression (string) – Expression used to color the particles

  • datum ({'sigma', 'depth', 'height', 'elevation'}) – Vertical datum applied for particle selection

  • limits (tuple) – Vertical limits (z1, z2) applied for particle selection.

  • show (dict) – Expression used to select particles for display (works on top of vertical selection)

  • show_method (str) – String either ‘any’ or ‘all’ applied to the show dictionary. Equivilent to OR or AND boolean.

  • highlight (dict) – Expression used to highlight particles

  • highlight_method (str) – String either ‘any’ or ‘all’ applied to the highlight dictionary. Equivilent to OR or AND boolean.

  • scale (float) – Number used to scale marker size (this is in map units i.e metres or degrees)

  • shape ({'tri','square','o','star','diamond'}) – Shape of marker

  • 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 edge colouring of the underlying matplotlib.collections object

  • facecolor (string) – Sets the face 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

zoom()

Abstract method which zooms axis to extent of graphics object