Commit bea98338 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Magplot docu update

parent 694e0d46
......@@ -543,7 +543,7 @@ Operator catalog:
-------------------------------------------------------------
Magplot contour Contour plot
Magplot shaded Shaded contour plot
Magplot grfill Shaded grid boxes
Magplot grfill Shaded gridfill plot
Magvector vector Vector arrows plot
Magvector stream Streamlines plot
Maggraph graph Line graph plot
......
......@@ -36,6 +36,8 @@ case "${HOSTNAME}" in
--with-hdf5=$HOME/local/hdf5-1.8.15-threadsafe \
--with-udunits2=/opt/local \
--with-curl=/opt/local \
--with-libxml2=/usr \
--with-magics=$HOME/local/Magics-2.25.3 \
--with-proj=/opt/local \
--with-szlib=$HOME/local"
......
......@@ -64,7 +64,7 @@
{Magics Software Package},
from the
\href{https://www.ecmwf.int}
{European Centre for Medium-Range Weather Forecasts (ECMWF))}
{European Centre for Medium-Range Weather Forecasts (ECMWF)}
\bibitem[MPIOM]{MPIOM} \ \\
\href{http://www.mpimet.mpg.de/en/wissenschaft/modelle/mpiom/mpiom-description.html}
......
......@@ -3,26 +3,25 @@
The Climate Data Operators ({\CDO}) software is a collection of operators
for standard processing of climate and forecast model data.
This document describes additional {\CDO} operators to ....
This document describes additional {\CDO} operators to be used for generating plots.
Magics++ is the latest generation of the ECMWF's Meteorological plotting software MAGICS.
Magics++ supports the plotting of contours, wind fields, observations, satellite images, symbols, text,
axis and graphs (including box plots). Data fields to be plotted may be presented in various formats, for
instance GRIB 1 and 2 code data, gaussian grid, regularly spaced grid and fitted data,BUFR and
instance GRIB 1 and 2 code data, gaussian grid, regularly spaced grid and fitted data, BUFR and
NetCDF format or retrieved from an ODB database. The produced meteorological plots can be saved in
various formats, such as PostScript, EPS, PDF, GIF, PNG and SVG.[1]
various formats, such as PostScript, EPS, PDF, GIF, PNG and SVG. \cite{Magics}
In order to rapidly generate high quality pictures from the data obtained from the existing CDO
operators, the CDO has been interfaced with Magics++ library. As a first step,some new CDO plotting
operators, the CDO has been interfaced with Magics++ library. As a first step, some CDO plotting
operators are created to cater to the most essential/ frequently used plotting features viz., graph,
contour, vector. These operators rely on the Magics++ and generate output files in the various formats
supported by Magics++.
supported by Magics++. These operators can be used as terminal operators and chained with the existing
operators.
Magics++ provides a vast number of parameters to control the attributes of various plotting
features. Keeping in view, the usability of CDO users, currently only a few of these parameters are
supported and accessible to the CDO users as command line arguments for the respective operators.
The users are requested to refer to the Magics++ manual[1] for detailed description of the various
parameters available for the various features. An option is provided to CDO users to input some of
these parameters in an XML file which can be passed as an argument for the CDO plotting operators.
The description of the new plotting operators and the various arguments that can be passed for these
operators is provided in the subsequent sections.
The users are requested to refer to the Magics++ manual \cite{Magics} for detailed description of the various
parameters available for the various features. The description of the plotting operators and the
various arguments that can be passed for these operators is provided in the subsequent sections.
\chapter{\label{refman}Graphic reference manual}
This section gives a description of all {\CDO} operators to ...
This section gives a description of all {\CDO} operators to generate plots.
Related operators are grouped to modules.
For easier description all single input files are named {\tt ifile} or {\tt ifile1}, {\tt ifile2}, etc.,
and an arbitrary number of input files are named {\tt ifiles}.
......
......@@ -7,9 +7,10 @@
@Operators = contour shaded grfill
@BeginDescription
This operator generates 2D Lon/Lat plots.
The operators in this module generates 2D Lon/Lat plots.
The data for the plot is read from @file{ifile}.
The result is written to @file{ofile}. The default format is XXX, this can be changed with the device parameter.
The result is written to @file{ofile}. The default output file format is postscript,
this can be changed with the device parameter.
The type of the plot depends on the choosen operator.
Here is a list of all common plot parameters:
......@@ -21,6 +22,15 @@ Here is a list of all common plot parameters:
style & STRING & Contour line style (solid, dash, dot, chain_dash, chain_dot)
min & FLOAT & Minimum value
max & FLOAT & Maximum value
count & INTEGER & Number of Contour levels / Colour bands
interval & FLOAT & Interval in data units between two bands lines
list & INTEGER & List of levels to be plotted
RGB & STRING & TRUE or FALSE, to indicate, if the input colour is in RGB format
step_freq & INTEGER & Frequency of time steps to be considered for making the animation
& & (device=gif_animation). Default value is "1" (all time steps).
& & Will be ignored if input file has multiple variables.
file_split & STRING & TRUE or FALSE, to split the output file for each variable, if input has
& & multiple variables. Default value is "FALSE". Valid only for "PS" format.
@EndTable
@EndDescription
@EndModule
......@@ -31,7 +41,17 @@ Here is a list of all common plot parameters:
@Parameter = params
@BeginDescription
Contour plot...
The operator @bold{contour} generates the discrete contour lines of the input field values.
The following additional parameters are valid for contour operator,
in addition to the common plot parameters:
@BeginTable
@bold{Keyname} & @bold{Type} & @bold{Description}
colour & STRING & Colour for drawing the contours
thickness & FLOAT & Thickness of the contour line
style & STRING & Line Style can be "SOLID", "DASH", "DOT", "CHAIN_DASH",
& & "CHAIN_DOT"
@EndTable
@EndDescription
@EndOperator
......@@ -41,21 +61,67 @@ Contour plot...
@Parameter = params
@BeginDescription
Shaded contour plot...
The operator @bold{shaded} generates the filled contours of the given input field values.
The following additional parameters are valid for shaded contour operator,
in addition to the common plot parameters.
@BeginTable
@bold{Keyname} & @bold{Type} & @bold{Description}
colour_min & STRING & Colour for the Minimum colour band
colour_max & STRING & Colour for the Minimum colour band
colour_triad & STRING & Direction of colour sequencing for shading "CW" or "ACW",
& & to denote "clockwise" and "anticlockwise" respectively.
& & To be used in conjunction with "colour_min", "colour_max"
& & options. Default is "ACW"
colour_table & STRING & File with user specified colours with the format as
@EndTable
Example file for 6 colours in RGB format:
@BeginListing
6
RGB(0.0;0.0;1.0)
RGB(0.0;0.0;0.5)
RGB(0.0;0.5;0.5)
RGB(0.0;1.0;0.0)
RGB(0.5;0.5;0.0)
RGB(1.0;0.0;0.0)
@EndListing
@EndDescription
@EndOperator
@BeginOperator_grfill
@Title = Shaded grid boxes
@Title = Shaded gridfill plot
@Parameter = params
@BeginDescription
Shaded grid boxes...
The operator @bold{grfill} is similar to satellite imaging and shades each cell (pixel) according
to the value of the field at that cell. The following additional parameters are valid for shaded gridfill
operator, in addition to the common plot parameters and shaded contour parameters:
@BeginTable
@bold{Keyname} & @bold{Type} & @bold{Description}
resolution & FLOAT & Number of cells per cm for CELL shading.
@EndTable
@EndDescription
@EndOperator
@BeginNote
All colour parameter can be either standard name or in RGB format.
The valid standard name strings for "colour" are:
"red", "green", "blue", "yellow", "cyan", "magenta", "black", "avocado", "beige",
"brick", "brown", "burgundy", "charcoal", "chestnut", "coral", "cream", "evergreen",
"gold", "grey", "khaki", "kellygreen", "lavender", "mustard", "navy", "ochre",
"olive", "peach", "pink", "rose", "rust", "sky", "tan", "tangerine", "turquoise",
"violet", "reddishpurple", "purplered", "purplishred", "orangishred", "redorange",
"reddishorange", "orange", "yellowishorange", "orangeyellow", "orangishyellow",
"greenishyellow", "yellowgreen", "yellowishgreen", "bluishgreen", "bluegreen",
"greenishblue", "purplishblue", "bluepurple", "bluishpurple", "purple", "white"
@EndNote
@BeginParameter
@Item = params
STRING Comma separated list of plot parameters
......
......@@ -221,13 +221,13 @@ void magplot( const char *plotfile, int operatorID, const char *varname, const c
*/
mag_setc("input_field_organization", "REGULAR");
// mag_setc("input_field_organization", "GAUSSIAN");
mag_setr("input_field_initial_latitude", grid_center_lat[0]);
mag_setr("input_field_latitude_step", dlat);
mag_setr("input_field_initial_longitude", grid_center_lon[0]);
mag_setr("input_field_longitude_step", dlon);
/* magics_template_parser( magics_node ); */
/* results_template_parser(results_node, varname ); */
......
......@@ -4829,9 +4829,10 @@ static const char *MagplotHelp[] = {
" <operator>,params ifile ofile",
"",
"DESCRIPTION",
" This operator generates 2D Lon/Lat plots.",
" The operators in this module generates 2D Lon/Lat plots.",
" The data for the plot is read from ifile.",
" The result is written to ofile. The default format is XXX, this can be changed with the device parameter.",
" The result is written to ofile. The default output file format is postscript,",
" this can be changed with the device parameter.",
" The type of the plot depends on the choosen operator.",
" ",
" Here is a list of all common plot parameters:",
......@@ -4842,17 +4843,72 @@ static const char *MagplotHelp[] = {
" style & STRING & Contour line style (solid, dash, dot, chain_dash, chain_dot)",
" min & FLOAT & Minimum value",
" max & FLOAT & Maximum value",
" count & INTEGER & Number of Contour levels / Colour bands ",
" interval & FLOAT & Interval in data units between two bands lines",
" list & INTEGER & List of levels to be plotted",
" RGB & STRING & TRUE or FALSE, to indicate, if the input colour is in RGB format",
" step_freq & INTEGER & Frequency of time steps to be considered for making the animation",
" & & (device=gif_animation). Default value is \"1\" (all time steps).",
" & & Will be ignored if input file has multiple variables.",
" file_split & STRING & TRUE or FALSE, to split the output file for each variable, if input has",
" & & multiple variables. Default value is \"FALSE\". Valid only for \"PS\" format.",
"",
"OPERATORS",
" contour Contour plot",
" Contour plot...",
" The operator contour generates the discrete contour lines of the input field values.",
" The following additional parameters are valid for contour operator,",
" in addition to the common plot parameters:",
" ",
" Keyname & Type & Description ",
" colour & STRING & Colour for drawing the contours",
" thickness & FLOAT & Thickness of the contour line",
" style & STRING & Line Style can be \"SOLID\", \"DASH\", \"DOT\", \"CHAIN_DASH\",",
" & & \"CHAIN_DOT\"",
" shaded Shaded contour plot",
" Shaded contour plot...",
" grfill Shaded grid boxes",
" Shaded grid boxes...",
" The operator shaded generates the filled contours of the given input field values.",
" The following additional parameters are valid for shaded contour operator,",
" in addition to the common plot parameters.",
" ",
" Keyname & Type & Description ",
" colour_min & STRING & Colour for the Minimum colour band",
" colour_max & STRING & Colour for the Minimum colour band",
" colour_triad & STRING & Direction of colour sequencing for shading \"CW\" or \"ACW\",",
" & & to denote \"clockwise\" and \"anticlockwise\" respectively.",
" & & To be used in conjunction with \"colour_min\", \"colour_max\"",
" & & options. Default is \"ACW\"",
" colour_table & STRING & File with user specified colours with the format as",
" ",
" Example file for 6 colours in RGB format:",
" 6",
" RGB(0.0;0.0;1.0)",
" RGB(0.0;0.0;0.5)",
" RGB(0.0;0.5;0.5)",
" RGB(0.0;1.0;0.0)",
" RGB(0.5;0.5;0.0)",
" RGB(1.0;0.0;0.0)",
" grfill Shaded gridfill plot",
" The operator grfill is similar to satellite imaging and shades each cell (pixel) according",
" to the value of the field at that cell. The following additional parameters are valid for shaded gridfill",
" operator, in addition to the common plot parameters and shaded contour parameters:",
" ",
" Keyname & Type & Description ",
" resolution & FLOAT & Number of cells per cm for CELL shading.",
"",
"PARAMETER",
" params STRING Comma separated list of plot parameters",
"",
"NOTE",
" All colour parameter can be either standard name or in RGB format.",
" The valid standard name strings for \"colour\" are:",
" ",
" \"red\", \"green\", \"blue\", \"yellow\", \"cyan\", \"magenta\", \"black\", \"avocado\", \"beige\",",
" \"brick\", \"brown\", \"burgundy\", \"charcoal\", \"chestnut\", \"coral\", \"cream\", \"evergreen\",",
" \"gold\", \"grey\", \"khaki\", \"kellygreen\", \"lavender\", \"mustard\", \"navy\", \"ochre\",",
" \"olive\", \"peach\", \"pink\", \"rose\", \"rust\", \"sky\", \"tan\", \"tangerine\", \"turquoise\",",
" \"violet\", \"reddishpurple\", \"purplered\", \"purplishred\", \"orangishred\", \"redorange\",",
" \"reddishorange\", \"orange\", \"yellowishorange\", \"orangeyellow\", \"orangishyellow\",",
" \"greenishyellow\", \"yellowgreen\", \"yellowishgreen\", \"bluishgreen\", \"bluegreen\",",
" \"greenishblue\", \"purplishblue\", \"bluepurple\", \"bluishpurple\", \"purple\", \"white\"",
NULL
};
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment