mpas_analysis.shared.plot.plot_global_comparison¶
- mpas_analysis.shared.plot.plot_global_comparison(config, Lons, Lats, modelArray, refArray, diffArray, colorMapSectionName, fileout, title=None, modelTitle='Model', refTitle='Observations', diffTitle='Model-Observations', cbarlabel='units', titleFontSize=None, defaultFontSize=None, figsize=None, dpi=None, lineWidth=1, lineColor='black', maxTitleLength=None, extend='both')[source]¶
Plots a data set as a longitude/latitude map.
- Parameters
config (mpas_tools.config.MpasConfigParser) – the configuration, containing a [plot] section with options that control plotting
Lons (numpy.ndarray) – longitude and latitude arrays
Lats (numpy.ndarray) – longitude and latitude arrays
modelArray (numpy.ndarray) – model and observational or control run data sets
refArray (numpy.ndarray) – model and observational or control run data sets
diffArray (float array) – difference between modelArray and refArray
colorMapSectionName (str) – section name in
config
where color map info can be found.fileout (str) – the file name to be written
title (str, optional) – the subtitle of the plot
modelTitle (str, optional) – title of the model panel
refTitle (str, optional) – title of the observations or control run panel
diffTitle (str, optional) – title of the difference (bias) panel
cbarlabel (str, optional) – label on the colorbar
titleFontSize (int, optional) – size of the title font
defaultFontSize (int, optional) – the size of text other than the title
figsize (tuple of float, optional) – the size of the figure in inches
dpi (int, optional) – the number of dots per inch of the figure, taken from section
plot
optiondpi
in the config file by defaultlineWidth (int, optional) – the line width of contour lines (if specified)
lineColor (str, optional) – the color of contour lines (if specified)
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.extend ({'neither', 'both', 'min', 'max'}, optional) – Determines the
contourf
-coloring of values that are outside the range of the levels provided if using an indexed colormap.