mpas_analysis.shared.plot.plot_1D

mpas_analysis.shared.plot.plot_1D(config, xArrays, fieldArrays, errArrays, lineColors=None, lineStyles=None, markers=None, lineWidths=None, legendText=None, title=None, xlabel=None, ylabel=None, fileout='plot_1D.png', figsize=(10, 4), dpi=None, xLim=None, yLim=None, invertYAxis=False, maxTitleLength=None, titleFontSize=None, axisFontSize=None, defaultFontSize=None)[source]

Plots a 1D line plot with error bars if available.

Parameters:

  • config (instance of ConfigParser) – the configuration, containing a [plot] section with options that control plotting

  • xArrays (list of float arrays) – x array (latitude, or any other x axis except time)

  • fieldArrays (list of float arrays) – y array (any field as function of x)

  • errArrays (list of float arrays) – error array (y errors)

  • lineColors (list of str, optional) – control line color, style, marker, and corresponding legend text. Default is black, solid line with no marker, and no legend.

  • lineStyles (list of str, optional) – control line color, style, marker, and corresponding legend text. Default is black, solid line with no marker, and no legend.

  • markers (list of str, optional) – control line color, style, marker, and corresponding legend text. Default is black, solid line with no marker, and no legend.

  • legendText (list of str, optional) – control line color, style, marker, and corresponding legend text. Default is black, solid line with no marker, and no legend.

  • lineWidths (list of float, optional) – control line width. Default is 1.0.

  • title (str, optional) – title of plot

  • xlabel (str, optional) – label of x- and y-axis

  • ylabel (str, optional) – label of x- and y-axis

  • fileout (str, optional) – the file name to be written

  • figsize (tuple of float, optional) – size of the figure in inches

  • dpi (int, optional) – the number of dots per inch of the figure, taken from section plot option dpi in the config file by default

  • xLim (float array, optional) – x range of plot

  • yLim (float array, optional) – y range of plot

  • invertYAxis (logical, optional) – if True, invert Y axis

  • maxTitleLength (int or None, optional) – the maximum number of characters in the title, beyond which it is truncated with a trailing ellipsis. The default is from the maxTitleLength config option.

  • titleFontSize (int, optional) – size of the title font

  • axisFontSize (int, optional) – size of the title font

  • defaultFontSize (int, optional) – the size of text other than the title