Debian Codegraph @

docs/manual/chapters/wind.xml

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 (C) Copyright 1996-2016 ECMWF.
4
5 This software is licensed under the terms of the Apache Licence Version 2.0
6 which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
7 In applying this licence, ECMWF does not waive the privileges and immunities
8 granted to it by virtue of its status as an intergovernmental organisation nor
9 does it submit to any jurisdiction.
10 -->
11
12 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
13 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
14 <chapter id="Wind_Plotting" label="7">
15 <title>Wind Plotting</title>
16
17 <xi:include href="../phrases/chapterinfo_mod.xml"
18 xmlns:xi="http://www.w3.org/2001/XInclude" />
19
20 <section id="Wind_Introduction">
21 <title>Introduction</title>
22
23 <para>Wind plotting facilities allow users to plot wind and wind related
24 parameters as follows:</para>
25
26 <para>Wind fields may be presented to Magics in matrix form, as U/V
27 velocity components or as speed/direction components. Wind fields may also
28 be passed in GRIB code data as U/V or speed/direction<remark> or
29 vorticity/divergence</remark>. These wind fields may be plotted in one of two
30 ways:</para>
31
32 <itemizedlist>
33 <listitem>
34 <para>Wind arrows; represented by a vector whose length is
35 proportional to the speed of the wind.</para>
36 </listitem>
37
38 <listitem>
39 <para>WMO standard wind flags; represented by barbs and solid
40 pennants.</para>
41 </listitem>
42
43 <remark><listitem>
44 <para>Streamlines; a line that is everywhere tangential to the
45 instantaneous wind vectors.</para>
46 </listitem>
47
48 <listitem>
49 <para>Isotachs; a contour line of wind speed.</para>
50 </listitem></remark>
51 </itemizedlist>
52
53 <remark><para>Wind arrow and wind flag plotting are described in this chapter.
54 Streamline and isotach plotting are described in Chapter VIII- Streamline
55 / Isotach Plotting .</para></remark>
56
57 <remark>
58 <para>Magics also permits wind related parameters, which are generated
59 from differential properties of the wind field, to be plotted using normal
60 contouring facilities. These related parameters are Divergence, Vorticity,
61 Stream Functions and Velocity Potential.</para>
62 </remark>
63
64 <para>Fields other than recognised wind fields (u/v<remark>, vorticity/divergence</remark>
65 and speed/direction) may be plotted as wind vectors;
66 <olink targetdoc="Magics_wind" targetptr="Wind_Data_Input" />
67 describes how to achieve this.</para>
68
69 <!--
70 <important id="Vorticity_Devergence_on_Gridpoints"> <title>Magics++</title>
71 <productname>Magics++</productname> now permits the plotting of
72 vorticity/divergence wind fields stored in grid points; this was not
73 possible under <productname>MAGICS 6</productname>.</important>
74 -->
75
76 </section>
77
78 <section id="Wind_Data_Input">
79 <title>Data Input</title>
80
81 <para>To plot a wind field, users may pass the wind component fields
82 either in GRIB code format or in matrix form, each component field being
83 in a separate matrix.</para>
84
85 <section id="Wind_GRIB_Code">
86 <title>GRIB Code</title>
87
88 <para>To pass the wind components in GRIB format, the name (including
89 the path) of the file containing the components should be passed as
90 follows:</para>
91 <programlisting>
92 CALL <function>PSETC</function>('<parameter>GRIB_INPUT_FILE_NAME</parameter>', 'wind_data').
93 </programlisting>
94 <para>The position of
95 the wind components on the file should be indicated as follows:</para>
96
97 <remark>
98 <para>Diagram 1 here</para>
99 </remark>
100
101 <programlisting>
102 CALL <function>PSETI</function> ('<parameter>GRIB_WIND_POSITION_1</parameter>',N)
103 CALL <function>PSETI</function> ('<parameter>GRIB_WIND_POSITION_2</parameter>',M)
104 </programlisting>
105
106 <para>where N and M are the positions (record numbers on the file).</para>
107
108 <para>When passing GRIB code data, it is possible to pass fields other
109 than recognised wind fields (u/v<remark>, vorticity/divergence</remark> and
110 speed/direction) to Magics and request that they are plotted as wind
111 fields. To achieve this, the parameter
112 <parameter>GRIB_WIND_MODE</parameter> should be set by the user to
113 specify which way the input fields are to be interpolated, i.e. as u/v<remark>,
114 vorticity/divergence</remark> or strength/direction. The valid values are
115 '<code>UV</code>' (default) , '<code>VD</code>' and '<code>SD</code>'.
116 Following is an example of setting
117 <parameter>GRIB_WIND_MODE</parameter> :</para>
118
119 <programlisting>
120 CALL <function>PSETC</function> ('<parameter>GRIB_WIND_MODE</parameter>','UV')
121 </programlisting>
122
123 <para>The fields should be passed to Magics in the usual way, as if they
124 were recognised wind fields, e.g.</para>
125
126 <programlisting>
127 CALL <function>PSETC</function> ('<parameter>GRIB_INPUT_FILE_NAME</parameter>','wind_data')
128 CALL <function>PSETI</function> ('<parameter>GRIB_WIND_POSITION_1</parameter>', 1)
129 CALL <function>PSETI</function> ('<parameter>GRIB_WIND_POSITION_2</parameter>', 2).
130 </programlisting>
131
132 <remark>
133 <para>It is possible to have the two fields necessary for wind
134 plotting, in two different input files. If this is the case, the
135 parameter <parameter>GRIB_INPUT_FILE_NAME</parameter>
136 should be used to pass one of the file names and
137 <parameter>GRIB_INPUT_FILE_NAME</parameter> should be used to pass the
138 second file name. The parameter
139 <parameter>GRIB_INPUT_FILE_NUMBER</parameter> must be set to
140 '<code>TWO</code>' , the default being '<code>ONE</code>' .</para>
141 </remark>
142
143 <para>For further information concerning GRIB code data, see
144 <olink targetdoc="Magics_data" targetptr="Data_Input" />.</para>
145
146 </section>
147
148
149 <section id="Wind_Matrix_Data">
150 <title>Matrix Data</title>
151
152 <para>Input field parameters, as described in
153 <olink targetdoc="Magics_data" targetptr="Data_Input" />, must be used to
154 describe the organisation of the data in the matrices. After the
155 relevant parameters are properly set, the wind data may be passed in the
156 following way:</para>
157
158 <para>For u and v components:</para>
159
160 <programlisting>
161 CALL <function>PSET2R</function> ('<parameter>INPUT_WIND_U_COMPONENT</parameter>',ARRAY1,M,N)
162 CALL <function>PSET2R</function> ('<parameter>INPUT_WIND_V_COMPONENT</parameter>',ARRAY2,M,N)
163 </programlisting>
164 <para>For wind speed and direction:</para>
165
166 <programlisting>
167 CALL <function>PSET2R</function> ('<parameter>INPUT_WIND_SPEED</parameter>',ARRAY1,M,N)
168 CALL <function>PSET2R</function> ('<parameter>INPUT_WIND_DIRECTION</parameter>',ARRAY2,M,N)
169 </programlisting>
170
171 <remark>
172 <para>For wind speed when plotting isotachs only:</para>
173
174 <programlisting>
175 CALL <function>PSET2R</function> ('<parameter>INPUT_WIND_SPEED</parameter>',ARRAY1,M,N)
176 </programlisting>
177 </remark>
178
179 <para>where all arrays must be dimensioned as <code>ARRAY(M,N)</code> in
180 the calling program.</para>
181
182 <para>The units of <parameter>INPUT_WIND_U_COMPONENT</parameter> ,
183 <parameter>INPUT_WIND_V_COMPONENT</parameter> and
184 <parameter>INPUT_WIND_SPEED</parameter> are metres per second. Those of
185 <parameter>INPUT_WIND_DIRECTION</parameter> are degrees measured in an
186 anticlockwise direction from the eastern point of the compass.</para>
187 </section>
188 </section>
189
190
191 <section id="Wind_Plotting_Methods">
192 <title>Plotting Methods</title>
193
194 <para>To plot a wind field, the action routine <function>PWIND</function>
195 must be called. The type of wind plot required is indicated by setting the
196 parameter <parameter>WIND_FIELD_TYPE</parameter> to one of the following
197 values, the default value being '<code>ARROWS</code>'.</para>
198
199 <para>'<code>ARROWS</code>' : The speed and direction of the wind is
200 plotted using an arrow whose length is proportional to the speed of the
201 wind and whose orientation is in the direction of the wind at the grid
202 position.</para>
203
204 <para>'<code>FLAGS</code>' : Will plot the speed and direction of the wind
205 using the WMO standard wind flags representation (barbs and solid
206 pennants).</para>
207
208 <remark><para>'<code>STREAMLINES</code>' : Will plot streamlines tangential to the
209 instantaneous wind vectors.</para></remark>
210 </section>
211
212 <section id="Wind_Field_Projection">
213 <title>Wind Field Projection</title>
214
215 <para><productname>Magics</productname> will automatically project the wind field from the regular
216 input field onto the requested projection. In the cases of wind flags and
217 wind arrows, each flag or arrow will be directly projected, taking the
218 necessary rotation into consideration. This means that wind arrows and
219 wind flags will be plotted along lines of latitude and longitude on polar
220 stereographic maps and not in columns and rows. No interpolation is
221 performed during the projection. A thinning procedure may be applied to
222 wind flags and arrows close to the poles.</para>
223
224 <para>It should be noted that cylindrical projection is not
225 angle-conformal, which means that the angle of the wind arrows or flags is
226 not conserved in this projection. It is advisable not to use cylindrical
227 projection for wind plotting outside the tropics.</para>
228 </section>
229
230 <section id="Wind_Field_Thinning">
231 <title>Wind Field Thinning</title>
232
233 <para>In some cases, wind arrows (and wind flags) may overlap. This
234 depends on the length of the arrows or flags, the grid size of the input
235 matrix and on the size of the subpage. With a polar stereographic
236 projection, the distance between projected grid points will be smaller at
237 higher latitudes. Therefore on polar stereographic projections for grid
238 points close to the pole, a thinning procedure will be automatically
239 applied to latitudes above 60 degrees.</para>
240
241 <para>The parameter <parameter>WIND_THINNING_FACTOR</parameter> controls
242 the thinning of wind fields plotted in different projections. For
243 Cylindrical, Mercator and Satellite projections, for which there is no
244 automatic thinning, the thinning factor corresponds to the rounded up
245 value of the parameter <parameter>WIND_THINNING_FACTOR</parameter>. For a
246 factor rounded to N, every Nth grid point in both X and Y directions, is
247 plotted, e.g. the statement :</para>
248
249 <programlisting>
250 CALL <function>PSETR</function>('<parameter>WIND_THINNING_FACTOR</parameter>', 2.6)</programlisting>
251
252 <para>will cause Magics to plot wind flags or wind arrows for every third
253 grid point value in the input matrix, in both the X and Y directions.</para>
254
255 <para>For Polar Stereographic projections, the thinning factor is the
256 distance, in both X and Y directions, corresponding to the projected
257 <parameter>INPUT_FIELD_LONGITUDE_STEP</parameter>, along 60 degrees
258 latitude, multiplied by the value of
259 <parameter>WIND_THINNING_FACTOR</parameter> . After plotting at a grid
260 point, all subsequent grid points, whose distance from the current grid
261 point is less than the thinning factor, will be ignored. The default value
262 is <code>2.0</code>, e.g. the statement :</para>
263
264 <programlisting>
265 CALL <function>PSETR</function>('<parameter>WIND_THINNING_FACTOR</parameter>', 1.0)</programlisting>
266
267 <para>will cause Magics to plot wind flags or wind arrows with no thinning
268 until 60 degree latitude. Above the 60 degree latitude, thinning will be
269 applied automatically.</para>
270
271 <para>For all projections, if <parameter>WIND_THINNING_FACTOR</parameter>
272 has the value <code>0.0</code>, no thinning will be applied. This also
273 means that the automatic thinning is not applied in polar stereographic.
274 <remark>In the case of streamlines, this thinning procedure is not applied.
275 Chapter VIII- Streamline / Isotach Plotting for details concerning
276 streamline thinning.</remark></para>
277 </section>
278
279
280 <section id="Plotting_Wind_Flags">
281 <title>Plotting Wind Flags</title>
282
283 <para>Wind fields comprising U and V components or speed and direction,
284 may be plotted with WMO standard wind flags.</para>
285
286 <para>A wind flag is represented by barbs and solid pennants, a full barb
287 representing a wind speed of 5 m/s, a half barb representing a wind speed
288 of 2.5 m/s, and a pennant representing a wind speed of 25 m/s. All barbs
289 and pennants lie to the left of the wind shaft in the Northern hemisphere
290 and to the right of the wind shaft in the Southern hemisphere. The wind
291 flag points towards the direction the wind is coming from.</para>
292
293 <section id="Wind_Flags_Unit_Length">
294 <title>Unit Length</title>
295
296 <para>The default length of the wind flag shaft is 1.0 centimetre. The
297 parameter <parameter>WIND_FLAG_LENGTH</parameter> may be used to set
298 another length (in centimetres).</para>
299 </section>
300
301 <!-- NOT IMPLEMENTED yet as of 18/01/2007
302 <section id="Wind_Flag_Mode">
303 <title>Wind Flag Mode</title>
304
305 <para>The parameter <parameter>WIND_FLAG_MODE</parameter> controls how
306 the wind flag shaft will be drawn. If
307 <parameter>WIND_FLAG_MODE</parameter> is set to '<code>NORMAL</code>'
308 the shaft of the wind flag will be drawn with a solid line, which is the
309 default. If set to '<code>OFF_LEVEL</code>' or '<code>OFF_TIME</code>'
310 the wind flags will be drawn with dashed lines as described
311 below.</para>
312 </remark>
313
314 <remark>
315 <para>Diagram 2!</para>
316 </remark>
317
318 <remark>
319 <para>When winds are plotted on the same map at two different vertical
320 levels, it is possible to distinguish them from each other by drawing
321 the entire wind shaft as dashed lines (<code>OFF_LEVEL</code> ).</para>
322
323 <para>When winds are plotted at "different times", it is possible to
324 distinguish them from each other by drawing the wind shaft with dashed
325 lines as far as the barbs and pennants (<code>OFF_TIME</code>).</para>
326 </remark>
327 </section>
328 -->
329
330 <section id="Wind_Flags_Plot_Suppression">
331 <title>Plot Suppression</title>
332
333 <para>To suppress the plotting of wind flags above and below certain
334 wind speed values, the parameters
335 <parameter>WIND_FLAG_MAX_SPEED</parameter> and
336 <parameter>WIND_FLAG_MIN_SPEED</parameter> may be used. The default
337 values of these parameters are set to very high and very low,
338 respectively, so that all wind speeds will be plotted.</para>
339
340 <remark>
341 <para>The parameter <parameter>WIND_FLAG_CROSS_BOUNDARY</parameter>
342 controls the plotting of wind flags on and outside the subpage boundary.
343 It may be set to '<code>ON</code>' or '<code>OFF</code>' . When set to
344 '<code>ON</code>' (default) wind flags are not plotted on or outside the
345 boundary.</para>
346 </remark>
347 </section>
348
349 <section id="Wind_Flags_Origin_Markers">
350 <title>Origin Markers</title>
351
352 <para>The origin point may be plotted in various ways. The parameter
353 <parameter>WIND_FLAG_ORIGIN_MARKER</parameter> controls this feature. It
354 can take three values, '<code>CIRCLE</code>' , '<code>DOT</code>' or
355 '<code>OFF</code>' .</para>
356
357 <para>'<code>CIRCLE</code>' (default) : will plot a circle around the
358 origin point and the wind flag shaft will start at the perimeter of the
359 circle.</para>
360
361 <para>'<code>DOT</code>' : The origin will be plotted as a dot and the
362 wind shaft will start a short distance from the dot.</para>
363
364 <para>'<code>OFF</code>' : The origin is not plotted but the wind shaft
365 will start at the origin point.</para>
366 </section>
367
368 <section id="Wind_Flags_Calm_Indicator">
369 <title>Calm Indicator</title>
370
371 <para>According to the WMO standard, calm is indicated by a circle
372 around the origin marker. If the parameter
373 <parameter>WIND_FLAG_CALM_INDICATOR</parameter> is set to
374 '<code>ON</code>' (default), a calm indicator will be plotted when
375 plotting wind flags.</para>
376
377 <para>The calm indicator can have different forms depending upon the
378 <parameter>WIND_FLAG_ORIGIN_MARKER</parameter> parameter. If
379 <parameter>WIND_FLAG_ORIGIN_MARKER</parameter> is set to
380 '<code>CIRCLE</code>', then the calm indicator will be plotted as a
381 circle around the origin circle. If
382 <parameter>WIND_FLAG_ORIGIN_MARKER</parameter> is set to
383 '<code>DOT</code>' , then the calm indicator will be plotted as a circle
384 around a dot. If <parameter>WIND_FLAG_ORIGIN_MARKER</parameter> is set
385 to '<code>OFF</code>' , then the calm indicator will also be plotted as
386 a circle around a dot, as it is regarded as being necessary to show the
387 exact location of the calm.</para>
388
389 <para>The parameter <parameter>WIND_FLAG_CALM_INDICATOR_SIZE</parameter>
390 controls the size of diameter of the calm indicator circle, the default
391 being 0.3 centimetres. Control of the calm indicator size should be used
392 to avoid congestion of wind symbols caused by the size of the users
393 subpage and/or the map projection.</para>
394
395 <remark>
396 <para>Diagram 3</para>
397 </remark>
398 </section>
399
400 <section id="Wind_Flags_Colour_and_Thickness">
401 <title>Colour and Thickness</title>
402
403 <para>The parameters <parameter>WIND_FLAG_THICKNESS</parameter> and
404 <parameter>WIND_FLAG_COLOUR</parameter> are used to distinguish wind
405 flag plotting from other wind fields in the same subpage.</para>
406
407 <para>The parameter <parameter>WIND_FLAG_THICKNESS</parameter> will draw
408 lines n times thicker than the default value. It will affect only the
409 thickness of the wind flag shaft, not the barbs or pennants.</para>
410
411 <para>The parameter <parameter>WIND_FLAG_COLOUR</parameter> controls the
412 colour of the wind flags. Observe that only one colour at a time can be
413 used to plot flags each time <function>PWIND</function> is
414 called.</para>
415
416 <para>The default value for <parameter>WIND_FLAG_THICKNESS</parameter>
417 is <code>1</code> and the default colour for
418 <parameter>WIND_FLAG_COLOUR</parameter> is '<code>BLUE</code>'.</para>
419 </section>
420 </section>
421
422
423
424 <section id="Plotting_Wind_Arrows">
425 <title>Plotting Wind Arrows</title>
426
427 <para>A wind arrow is represented by a vector whose length and head size
428 is proportional to the speed of the wind, and whose thickness remains
429 constant (except for low wind speeds).</para>
430
431 <para>The vector either starts at the exact location of the current grid
432 point, or is centred on it. The orientation of the vector represents the
433 direction of the wind.</para>
434
435 <section id="Unit_Velocity">
436 <title>Unit Velocity</title>
437
438 <para><parameter>WIND_ARROW_UNIT_VELOCITY</parameter> is used to define
439 the wind speed. A unit vector (1.0 cm) on the unscaled output plot
440 represents the default value of 25 m/s.</para>
441
442 <para>When <parameter>WIND_ARROW_UNIT_VELOCITY</parameter> is set to
443 <code>0.0</code>, Magics will calculate the maximum wind speed for the
444 geographical area requested and will use this maximum for the unit
445 velocity. This means that the unit velocity will vary depending on the
446 area being plotted.</para>
447
448 <para>It should be noted that if a scaling factor is applied to the
449 output plot using postprocessor or hardware scaling facilities, the unit
450 length of the wind arrow will also be scaled by the same factor.</para>
451 </section>
452
453 <section id="Wind_Arrows_Plot_Suppression">
454 <title>Plot Suppression</title>
455
456 <para>To suppress the plotting of wind arrows above and below certain
457 wind speed values, the parameters
458 <parameter>WIND_ARROW_MAX_SPEED</parameter> and
459 <parameter>WIND_ARROW_MIN_SPEED</parameter> may be used. The default
460 values of these parameters are set to very high and very low values so
461 that all wind speeds will be plotted. The suppression of wind arrows may
462 be useful to isolate certain wind speeds or to plot them in a different
463 style to other winds.</para>
464
465 <!-- NOT IMPLEMENTED yet as of 19/01/2007
466 <remark>
467 <para>The parameter <parameter>WIND_ARROW_CROSS_BOUNDARY</parameter>
468 controls the plotting of wind arrows on and outside the subpage
469 boundary. It may be set to '<code>ON</code>' or '<code>OFF</code>' .
470 When set to '<code>ON</code>' , which is the default, wind arrows are
471 not plotted on or outside the boundary.</para>
472 </remark>
473
474 <remark>
475 <para>Diagram 4</para>
476 </remark>
477 -->
478 </section>
479
480 <section id="Calm_Winds">
481 <title>Calm Winds</title>
482
483 <para>Generally, winds below 0.5 m/s are regarded as calm. The parameter
484 <parameter>WIND_ARROW_CALM_BELOW</parameter> sets the upper limit for
485 calm winds. The default value is <code>0.5</code>.</para>
486 </section>
487
488 <section id="Calm_Indicator">
489 <title>Calm Indicator</title>
490
491 <para>Calm winds may be plotted by setting the parameter
492 <parameter>WIND_ARROW_CALM_INDICATOR</parameter> to '<code>ON</code>',
493 default being '<code>OFF</code>'. These will be plotted by a circle
494 round a dot, where the dot indicates the exact position of the current
495 grid point.</para>
496
497 <para>The parameter
498 <parameter>WIND_ARROW_CALM_INDICATOR_SIZE</parameter> controls the size
499 of the diameter of the calm indicator circle, default 0.3 centimetres.
500 Control of the calm indicator size should be used to avoid congestion of
501 wind symbols caused by the size of the users subpage and/or the map
502 projection.</para>
503 </section>
504
505 <section id="Origin_Position">
506 <title>Origin Position</title>
507
508 <para>The Parameter <parameter>WIND_ARROW_ORIGIN_POSITION</parameter>
509 places the wind arrows at different positions relative to the origin of
510 the wind. It can take two values, '<code>TAIL</code>' or
511 '<code>CENTRE</code>', the default being '<code>TAIL</code>'.</para>
512
513 <para>'<code>TAIL</code>' : The tails of the arrows will be plotted at
514 the origin points of the wind.</para>
515
516 <para>'<code>CENTRE</code>' : The centre points of the wind arrows will
517 be plotted at the origin points.</para>
518
519 <para>The position of the origin will be indicated in the wind arrow
520 legend by a cross.</para>
521 </section>
522
523 <section id="Wind_Arrow_Colour">
524 <title>Colour</title>
525
526 <para>Wind arrow colour is set by the parameter
527 <parameter>WIND_ARROW_COLOUR</parameter> (default
528 '<code>BLUE</code>').</para>
529 </section>
530
531 <section id="Arrow_Thickness">
532 <title>Arrow Thickness</title>
533
534 <para>The thickness of wind arrow shafts can be controlled by the
535 parameter <parameter>WIND_ARROW_THICKNESS</parameter>, the value of
536 which defaults to <code>1</code>.</para>
537
538 <para>As the size of the arrow head is proportional to the overall
539 length of the arrow, it is possible, in the case of low wind speeds,
540 that the height of the arrow head may grow smaller than the thickness of
541 the shaft. Magics prevents this from happening by examining the ratio of
542 the height of the arrow head to the thickness of the shaft for all
543 arrows whose length is less than that of the unit vector. Thus if the
544 arrow head height falls below three times the shaft thickness, the shaft
545 thickness is said to have violated the arrow head. When violation
546 occurs, Magics will reduce the shaft thickness so that it is exactly one
547 third of the arrow head height.</para>
548
549 <para>The shaft thickness will remain constant, at the user specified or
550 default value, for all arrows whose length is greater than that of the
551 unit vector.</para>
552
553 <remark>
554 <para>Diagram 5</para>
555 </remark>
556 </section>
557
558 <section id="Arrow_Head_Style">
559 <title>Arrow Head Style</title>
560
561 <important> <title>Magics++</title>
562 <productname>Magics++</productname> uses an easier
563 system of specifying arrow head styles than previous versions.
564 The old parameter,
565 <parameter>WIND_ARROW_HEAD_INDEX</parameter>, is still
566 supported but is now deprecated.</important>
567
568 <para></para>
569
570 <para>Wind arrow heads can be configured through two parameters:
571 <parameter>WIND_ARROW_HEAD_SHAPE</parameter> (integer from 0 to 3) and
572 <parameter>WIND_ARROW_HEAD_RATIO</parameter> (real from 0 to 1). The
573 first of these parameters specifies which type of head the wind arrow
574 will have, and the second specifies the ratio of the width
575 of the arrow head compared to its length. The following diagram
576 illustrates the effect of these parameters:</para>
577
578 <figure id="figure_wind_arrow_heads">
579 <title>Wind Arrow Heads</title>
580 <mediaobject id="wind_arrow_heads_diagram">
581 <imageobject role="fo">
582 <imagedata fileref="../diagrams/diagram_wind_arrow_heads_01.png"
583 format="PNG" width="8cm" depth="8cm" align="center" />
584 </imageobject>
585
586 <imageobject role="html">
587 <imagedata fileref="images/diagrams/diagram_wind_arrow_heads_01.png"
588 format="PNG" align="center" />
589 </imageobject>
590 </mediaobject>
591 </figure>
592 </section>
593
594
595 <section id="Wind_Arrow_Legend">
596 <title>Wind Arrow Legend</title>
597
598 <para>A wind arrow legend box containing a plot of a unit vector and its
599 unit value will be plotted, by default, in the upper right hand corner
600 of the page, just outside the subpage.</para>
601
602 <para>The attributes colour, line style, thickness and arrowhead style
603 of the unit vector will be the same as for wind arrows plotted in the
604 subpage. The frame of the wind arrow legend box will be plotted with the
605 same attributes as the subpage frame.</para>
606
607 <para>By default, the legend will be plotted just outside the top right
608 hand corner of the subpage. The wind arrow legend box may be placed in
609 any position within the user's page using the
610 <parameter>WIND_ARROW_LEGEND_X_POSITION</parameter> and
611 <parameter>WIND_ARROW_LEGEND_Y_POSITION</parameter> parameters to define
612 the position of the lower left hand corner of the wind arrow legend
613 box.</para>
614
615 <para>The size of the legend is controlled by the two parameters
616 <parameter>WIND_ARROW_LEGEND_X_LENGTH</parameter> and
617 <parameter>WIND_ARROW_LEGEND_Y_LENGTH</parameter> , whose values default
618 to 1.2cm and 0.6cm respectively.</para>
619
620 <para>To request blanking behind the legend box, the parameter
621 <parameter>WIND_ARROW_LEGEND_BLANKING</parameter> may be set to
622 '<code>ON</code>', the default
623 being '<code>OFF</code>'. Blanking is only effective when the legend is
624 partially or totally inside the subpage. To obtain full blanking, the
625 action routine <function>PWIND</function> should be called before any
626 other action routines.</para>
627
628 <para>To suppress the plotting of the wind arrow legend box, the
629 parameter <parameter>WIND_ARROW_LEGEND</parameter> should be set to
630 '<code>OFF</code>', the default being '<code>ON</code>' .</para>
631
632 <para>The wind arrow legend may also be plotted by the general legend
633 drawing facilities in Magics. This can be achieved by setting the
634 parameter <parameter>LEGEND</parameter> to '<code>ON</code>' before
635 calling <function>PWIND</function>. When this is required,
636 <parameter>WIND_ARROW_LEGEND</parameter> should be set to
637 '<code>OFF</code>' to avoid having the arrow legend drawn twice.</para>
638 </section>
639 </section>
640
641 <xi:include href="../paramtables/pwind_tables.xml"
642 xmlns:xi="http://www.w3.org/2001/XInclude" />
643
644 <xi:include href="../paramtables/Wind_wind_magml_tables.xml"
645 xmlns:xi="http://www.w3.org/2001/XInclude" />
646
647 <xi:include href="../paramtables/Wind_wind_magml_flat_tables.xml"
648 xmlns:xi="http://www.w3.org/2001/XInclude" />
649
650
651 <section id="Wind_Program_Examples">
652 <title>Program Examples</title>
653
654 <para>The following examples illustrate the plotting of wind.</para>
655
656 </section>
657
658 <xi:include href="../examples/manual/xml/wind_examples.xml"
659 xmlns:xi="http://www.w3.org/2001/XInclude" />
660
661 </chapter>