Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
mpim-sw
cdo
Commits
0e0b5673
Commit
0e0b5673
authored
Dec 21, 2015
by
Uwe Schulzweida
Browse files
Magvector docu update
parent
bea98338
Changes
4
Hide whitespace changes
Inline
Side-by-side
OPERATORS
View file @
0e0b5673
...
...
@@ -545,7 +545,6 @@ Operator catalog:
Magplot shaded Shaded contour plot
Magplot grfill Shaded gridfill plot
Magvector vector Vector arrows plot
Magvector stream Streamlines plot
Maggraph graph Line graph plot
-------------------------------------------------------------
Climate indices
...
...
doc/tex/mod/Maggraph
View file @
0e0b5673
...
...
@@ -9,13 +9,20 @@
@BeginDescription
This operator generates line graph plots.
The data for the plot is read from @file{ifiles}.
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.
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)
ymin & FLOAT & Minimum value of the y-axis data
ymax & FLOAT & Maximum value of the y-axis data
stat & STRING & "TRUE" or "FALSE" , to switch on the mean computation. Default is "FALSE". Will be overridden to "FALSE",
if input files have unequal number of time steps or different start/end times.
sigma & FLOAT & Standard deviation value for generating shaded back ground around the mean value.To be used in conjunction with 'stat="TRUE"'
obsv &STRING & To indicate if the input files have an observation data, by setting to "TRUE".Default value is "FALSE".
The observation data should be the first file in the input file list.The observation data is always plotted in black colour.
@EndTable
@EndDescription
@EndModule
...
...
doc/tex/mod/Magvector
View file @
0e0b5673
...
...
@@ -4,23 +4,25 @@
@Title = Lat/Lon vector plot
@Section = Magics
@Arguments = ifile ofile
@Operators = vector
stream
@Operators = vector
@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 operato
r.
The data for the plot is read from @file{ifile}.
The input is expected to contain two velocity
components.
The result is written to @file{ofile}. The default
output file format is postscript,
this can be changed with the device paramete
r.
Here is a list of all
common
plot parameters:
Here is a list of all
vector
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
thin_fac & FLOAT & Controls the actual number of wind arrows or flags plotted.
unit_vec & FLOAT & Wind speed in m/s represented by a unit vector (1.0 cm)
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.
@EndTable
@EndDescription
@EndModule
...
...
@@ -29,20 +31,6 @@ Here is a list of all common plot parameters:
@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
...
...
src/operator_help.h
View file @
0e0b5673
...
...
@@ -4914,31 +4914,27 @@ static const char *MagplotHelp[] = {
static
const
char
*
MagvectorHelp
[]
=
{
"NAME"
,
" vector
, stream
- Lat/Lon vector plot"
,
" vector - Lat/Lon vector plot"
,
""
,
"SYNOPSIS"
,
"
<opera
tor
>
,params ifile ofile"
,
"
vec
tor,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 operato
r."
,
" The data for the plot is read from ifile.
The input is expected to contain two velocity
"
,
"
components.
The result is written to ofile. The default
output file format is postscript,
"
,
"
this can be changed with the device paramete
r."
,
" "
,
" Here is a list of all
common
plot parameters:"
,
" Here is a list of all
vector
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..."
,
" thin_fac & FLOAT & Controls the actual number of wind arrows or flags plotted."
,
" unit_vec & FLOAT & Wind speed in m/s represented by a unit vector (1.0 cm)"
,
" 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."
,
""
,
"PARAMETER"
,
" params STRING Comma separated list of plot parameters"
,
...
...
@@ -4955,12 +4951,19 @@ static const char *MaggraphHelp[] = {
"DESCRIPTION"
,
" This operator generates line graph plots."
,
" The data for the plot is read from ifiles."
,
" 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."
,
" "
,
" 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)"
,
" ymin & FLOAT & Minimum value of the y-axis data "
,
" ymax & FLOAT & Maximum value of the y-axis data "
,
" stat & STRING &
\"
TRUE
\"
or
\"
FALSE
\"
, to switch on the mean computation. Default is
\"
FALSE
\"
. Will be overridden to
\"
FALSE
\"
,"
,
" if input files have unequal number of time steps or different start/end times. "
,
" sigma & FLOAT & Standard deviation value for generating shaded back ground around the mean value.To be used in conjunction with 'stat=
\"
TRUE
\"
' "
,
" obsv &STRING & To indicate if the input files have an observation data, by setting to
\"
TRUE
\"
.Default value is
\"
FALSE
\"
."
,
" The observation data should be the first file in the input file list.The observation data is always plotted in black colour. "
,
""
,
"PARAMETER"
,
" params STRING Comma separated list of plot parameters"
,
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment