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

added Magvector docu

parent 6e027146
......@@ -197,6 +197,7 @@ doc/tex/mod/Intyear -text
doc/tex/mod/Invert -text
doc/tex/mod/Invertlev -text
doc/tex/mod/Magplot -text
doc/tex/mod/Magvector -text
doc/tex/mod/Maskbox -text
doc/tex/mod/Maskregion -text
doc/tex/mod/Mastrfu -text
......
......@@ -544,6 +544,8 @@ Operator catalog:
Magplot contour Contour plot
Magplot shaded Shaded contour plot
Magplot grfill Shaded grid boxes
Magvector vector Vector arrows plot
Magvector stream Streamlines plot
-------------------------------------------------------------
Climate indices
-------------------------------------------------------------
......
......@@ -138,6 +138,7 @@ Strbre Miscellaneous
Strgal Miscellaneous
Hurr Miscellaneous
Magplot Magics
Magvector Magics
EcaCdd Climate indices
EcaCfd Climate indices
EcaCsu Climate indices
......
......@@ -31,7 +31,7 @@ Here is a list of all common plot parameters:
@Parameter = params
@BeginDescription
Contour plot
Contour plot...
@EndDescription
@EndOperator
......@@ -41,7 +41,7 @@ Contour plot
@Parameter = params
@BeginDescription
Shaded contour plot
Shaded contour plot...
@EndDescription
@EndOperator
......@@ -51,7 +51,7 @@ Shaded contour plot
@Parameter = params
@BeginDescription
Shaded grid boxes
Shaded grid boxes...
@EndDescription
@EndOperator
......
@BeginModule
@NewPage
@Name = Magvector
@Title = Lat/Lon vector plot
@Section = Magics
@Arguments = ifile ofile
@Operators = vector stream
@BeginDescription
This operator generates 2D Lon/Lat vector 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 type of the plot depends on the choosen operator.
Here is a list of all common plot parameters:
@BeginTable
@bold{Keyname} & @bold{Type} & @bold{Description}
device & STRING & Output device (ps, eps, pdf, png, gif, gif_animation, jpeg, svg, kml)
projection & STRING & Projection (cylindrical, polar_stereographic, robinson, mercator)
style & STRING & Contour line style (solid, dash, dot, chain_dash, chain_dot)
min & FLOAT & Minimum value
max & FLOAT & Maximum value
@EndTable
@EndDescription
@EndModule
@BeginOperator_vector
@Title = Vector arrows plot
@Parameter = params
@BeginDescription
Vector arrows plot...
@EndDescription
@EndOperator
@BeginOperator_stream
@Title = Streamlines plot
@Parameter = params
@BeginDescription
Streamlines plot...
@EndDescription
@EndOperator
@BeginParameter
@Item = params
STRING Comma separated list of plot parameters
@EndParameter
......@@ -4822,7 +4822,7 @@ static const char *MagplotHelp[] = {
" <operator>,params ifile ofile",
"",
"DESCRIPTION",
" This operator generates a 2D Lon/Lat plot.",
" This operator 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 type of the plot depends on the choosen operator.",
......@@ -4838,11 +4838,44 @@ static const char *MagplotHelp[] = {
"",
"OPERATORS",
" contour Contour plot",
" Contour plot",
" Contour plot...",
" shaded Shaded contour plot",
" Shaded contour plot",
" Shaded contour plot...",
" grfill Shaded grid boxes",
" Shaded grid boxes",
" Shaded grid boxes...",
"",
"PARAMETER",
" params STRING Comma separated list of plot parameters",
NULL
};
static const char *MagvectorHelp[] = {
"NAME",
" vector, stream - Lat/Lon vector plot",
"",
"SYNOPSIS",
" <operator>,params ifile ofile",
"",
"DESCRIPTION",
" This operator generates 2D Lon/Lat vector 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 type of the plot depends on the choosen operator.",
" ",
" Here is a list of all common plot parameters:",
" ",
" Keyname & Type & Description ",
" device & STRING & Output device (ps, eps, pdf, png, gif, gif_animation, jpeg, svg, kml)",
" projection & STRING & Projection (cylindrical, polar_stereographic, robinson, mercator)",
" style & STRING & Contour line style (solid, dash, dot, chain_dash, chain_dot)",
" min & FLOAT & Minimum value",
" max & FLOAT & Maximum value",
"",
"OPERATORS",
" vector Vector arrows plot",
" Vector arrows plot...",
" stream Streamlines plot",
" Streamlines plot...",
"",
"PARAMETER",
" params STRING Comma separated list of plot parameters",
......
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