mpas_analysis.sea_ice.plot_climatology_map_subtask.PlotClimatologyMapSubtask.set_plot_info¶
-
PlotClimatologyMapSubtask.set_plot_info(self, outFileLabel, fieldNameInTitle, mpasFieldName, refFieldName, refTitleLabel, diffTitleLabel, unitsLabel, imageDescription, imageCaption, galleryGroup, groupSubtitle, groupLink, galleryName, maskValue=None)[source]¶ Store attributes related to plots, plot file names and HTML output.
- Parameters
- outFileLabelstr
The prefix on each plot and associated XML file
- fieldNameInTitlestr
The name of the field being plotted, as used in the plot title
- mpasFieldNamestr
The name of the variable in the MPAS timeSeriesStatsMonthly output
- refFieldNamestr
The name of the variable to use from the observations or reference run file
- refTitleLabelstr
the title of the observations or control run subplot
- diffTitleLabelstr
the title of the difference (e.g. bias) subplot
- unitsLabelstr
the units of the plotted field, to be displayed on color bars
- imageDescriptionstr
the caption when mousing over the plot
- imageCaptionstr
the caption when displaying the plot full screen
- galleryGroupstr
the name of the group of galleries in which this plot belongs
- groupSubtitlestr
the subtitle of the group in which this plot belongs (or blank if none)
- groupLinkstr
a short name (with no spaces) for the link to the gallery group
- galleryNamestr
the name of the gallery in which this plot belongs
- maskValuefloat, optional
a value to mask out in plots