Target Diagram Options - PeterRochford/SkillMetrics Wiki

Original URL: https://github.com/PeterRochford/SkillMetrics/wiki/Target-Diagram-Options

🚨 github-wiki-see.page does not render ReStructuredText. Source for crawling below. Please visit the Original URL! 🚨


An exhaustive list of options is available to customize the appearance of the target diagram and are listed below for convenience of reference. The format for their use is "option = value". For example, to produce a target diagram that labels the points and changes the axis options for BIAS and CRMSD, the command would appear as (cf. target2.py)

sm.target_diagram(bias,crmsd,rmsd, markerLabel = label, ticks = np.arange(-50,60,10))

These options can also be obtained by calling the target diagram function without arguments at a Python command line:
::

% python

>>> import skill_metrics as sm

>>> sm.target_diagram()

General Options
---------------

.. list-table::
   :widths: 2 10

   * - overlay
     - 'on' / 'off' (default): Switch to overlay current statistics on target diagram. Only markers will be displayed.
   * - colormap
     - 'on' / 'off' (default): Switch to map color shading of markers to colormap ("on") or min to max range of RMSDz values ("off"). Set to same value as option "nonRMSDz".

Marker Options
--------------

.. list-table::
   :widths: 2 10

   * - MarkerDisplayed
     - 'marker' (default): Experiments are represented by individual symbols
   * - 
     - 'colorBar': Experiments are represented by a color described n a colorbar

Options when MarkerDisplayed is 'marker'
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
   :widths: 2 10

   * - markerLabel
     - Labels for markers
   * - markerLabelColor
     - Marker label color (Default: black)
   * - markercolor
     - Marker color
   * - markerLegend
     - 'on' / 'off' (default): Use legend for markers
   * - markerSize
     - Marker size (Default: 10)
   * - markerSymbol
     - Marker symbol (Default: 'o')

Options when MarkerDisplayed is 'colorbar'
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
   :widths: 2 10

   * - nonRMSDz
     - 'on' / 'off' (default): Values in RMSDs do not correspond to total RMS Differences. (Used to make range of RMSDs values appear above color bar.
   * - titleColorBar
     - Title of the colorbar.

Axes Options
------------

.. list-table::
   :widths: 2 10

   * - ticks
     - define tick positions (default is that used by axis function)
   * - xtickLabelPos
     - position of the tick labels along the x-axis (empty by default)
   * - ytickLabelPos
     - position of the tick labels along the y-axis (empty by default)
   * - equalAxes
     - 'on' / 'off' (default): Set axes to be equal
   * - limitAxis
     - Max for the Bias & uRMSD axis'on' / 'off' (default): Set axes to be equal

Diagram Options
---------------

.. list-table::
   :widths: 2 10

   * - alpha
     - Blending of symbol face color (0.0 transparent through 1.0 opaque)
   * - axismax
     - Maximum for the Bias & uRMSD axis
   * - circles
     - define the radii of circles to draw (default of (maximum RMSDs)*[.7 1], [.7 1] when normalized diagram)
   * - circleLineSpec
     - Circle line specification (default dashed black, '--k')
   * - circleLineWidth
     - Circle line width
   * - obsUncertainty
     - Observational Uncertainty (default of 0)
   * - normalized
     - 'on' / 'off' (default): normalized target diagram