ws_intertropical_discontinuity

../../_images/WS_ITTDISCONTINUITY.png

Defines an intertropical discontinuity line Weather Symbol Object that can be visualised with plot().

New in Metview version 5.15.0.

Warning

The script-based Weather Symbol Object visualisation is currently restricted to the ‘screen’ output target (i.e. when the output is Metview’s plot window). On the one hand this requires the Metview GUI to be installed, on the other hand it limits the script-based visualisation to these cases:

  • execute the code in Metview’s Code Editor (the default output target here is already ‘screen’)

  • execute the code as a Jupyter notebook with the output target set to ‘screen’ (see setoutput()):

In any other cases, e.g. in batch mode, plot() does not work.

Note

This function performs the same task as the Ws Intertropical Discontinuity icon in Metview’s user interface. It accepts its parameters as keyword arguments, described below.

ws_intertropical_discontinuity(**kwargs)

Defines an intertropical discontinuity line Weather Symbol Object.

Parameters

  • colour_1 (str, default: "red") – Colour of the first segment.

  • colour_2 (str, default: "green") – Colour of the second segment.

  • line_thickness (number, default: 1) – Thickness of the curve.

  • symbol_width (number, default: 10) – Length of the line segments.

  • symbol_gap (number, default: 5) – Width of the gap between line segments.

  • x (ndarray or list of numbers, default: 0) – The x coordinates of the control points of the curve. At least two points must be specified.

  • y (ndarray or list of numbers, default: 0) – The y coordinates of the control points of the curve. At least two points must be specified.

  • geolock (on_off, default: off) – Sets the geolock on the item for interactive editing in the plot window.

  • tooltip (str) – Text that appears as a tooltip when the visualised object is hovered over in Metview’s plot window.

Return type

Request