ScallopedStroke#

class metpy.plots.ScallopedStroke(offset=(0, 0), spacing=10.0, side='left', length=1.15, **kwargs)#

A line-based PathEffect which draws a path with a scalloped style.

The spacing, length, and side of the scallops can be controlled. This implementation is based off of matplotlib.patheffects.TickedStroke.

Create a scalloped path effect.

Parameters:
  • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

  • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

  • side (str) – Side of the path scallops appear on from the reference of walking along the curve. Options are left and right. Defaults to 'left'.

  • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

  • kwargs – Extra keywords are stored and passed through to GraphicsContextBase.

Methods Summary

__init__([offset, spacing, side, length])

Create a scalloped path effect.

draw_path(renderer, gc, path, affine[, rgbFace])

Draw the path with updated gc.

Methods Documentation

__init__(offset=(0, 0), spacing=10.0, side='left', length=1.15, **kwargs)[source]#

Create a scalloped path effect.

Parameters:
  • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

  • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

  • side (str) – Side of the path scallops appear on from the reference of walking along the curve. Options are left and right. Defaults to 'left'.

  • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

  • kwargs – Extra keywords are stored and passed through to GraphicsContextBase.

draw_path(renderer, gc, path, affine, rgbFace=None)[source]#

Draw the path with updated gc.