source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/VECTEUR/vecteur.html @ 321

Last change on this file since 321 was 321, checked in by smasson, 17 years ago

update documentation

File size: 10.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>vecteur.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="ajoutvect.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="velovect.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/VECTEUR/</font></h1>
58    <h2>vecteur.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68 Trace vectors (even if they are on a deformed grid) on any projection.
69 In this way, all vectors have a comparable norme on the drawing (to be
70 clear, a vector which measure 1 cm measure it, no matter the projection
71 and is position on the sphere).
72
73
74   
75    <h2>Routine summary</h2>
76
77    <dl>
78     
79      <dt><a href="#_cv_cm2normal"><i>result = </i>cv_cm2normal(<i>angle</i>)</a><dt>
80      <dd><font size="-1"> </font></dd>
81     
82      <dt><a href="#_normalise">normalise<i>, u, v, w</i></a><dt>
83      <dd><font size="-1"> </font></dd>
84     
85      <dt><a href="#_vecteur">vecteur<i>, composanteu, composantev, normevecteur, indice2d, reduitindice2d</i>, CMREF=<i>CMREF</i>, MISSING=<i>MISSING</i>, NORMEREF=<i>NORMEREF</i>, VECTCOLOR=<i>VECTCOLOR</i>, VECTTHICK=<i>VECTTHICK</i>, VECTREFPOS=<i>VECTREFPOS</i>, VECTREFFORMAT=<i>VECTREFFORMAT</i>, NOVECTREF=<i>NOVECTREF</i>, _EXTRA=<i>_EXTRA</i></a><dt>
86      <dd><font size="-1"> </font></dd>
87     
88    </dl>
89
90    <p>&nbsp;</p>
91   
92
93     
94      <a name="#_cv_cm2normal"></a>
95
96      <h2>cv_cm2normal  <font size="-1" color="#006633">
97</font></h2>
98
99      <p><font face="Courier"><i>result = </i>cv_cm2normal(<i><a href="#_cv_cm2normal_keyword_angle">angle</a></i>)</font></p>
100
101   
102
103
104    <h3>Return value</h3>
105
106
107   
108    <h3>Parameters</h3>
109   
110
111    <a name="#_cv_cm2normal_keyword_angle"></a>
112    <h4>angle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124
125   
126   
127
128   
129
130    <h3>Examples</h3><pre>
131
132    </pre><h3>Version history</h3>
133   
134    <h4>Version</h4>
135 $Id: vecteur.pro 297 2007-09-25 15:09:12Z pinsard $
136    <h4>History</h4>
137
138   
139
140    <h3>Known issues</h3>
141   
142   
143   
144    <h4>Restrictions</h4>
145
146
147   
148   
149   
150   
151   
152   
153   
154
155    <font size="-3"><p>&nbsp;</p></font>
156    <hr size="1" color="#CCCCCC"/>
157     
158      <a name="#_normalise"></a>
159
160      <h2>normalise  <font size="-1" color="#006633">
161</font></h2>
162
163      <p><font face="Courier">normalise<i>, <a href="#_normalise_keyword_u">u</a>, <a href="#_normalise_keyword_v">v</a>, <a href="#_normalise_keyword_w">w</a></i></font></p>
164
165   
166
167
168   
169
170   
171    <h3>Parameters</h3>
172   
173
174    <a name="#_normalise_keyword_u"></a>
175    <h4>u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176     
177     
178     
179     
180     
181     
182     
183     
184    </h4>
185
186   
187
188   
189
190    <a name="#_normalise_keyword_v"></a>
191    <h4>v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192     
193     
194     
195     
196     
197     
198     
199     
200    </h4>
201
202   
203
204   
205
206    <a name="#_normalise_keyword_w"></a>
207    <h4>w&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208     
209     
210     
211     
212     
213     
214     
215     
216    </h4>
217
218   
219
220   
221   
222
223   
224
225    <h3>Examples</h3><pre>
226
227    </pre><h3>Version history</h3>
228   
229    <h4>Version</h4>
230 $Id: vecteur.pro 297 2007-09-25 15:09:12Z pinsard $
231    <h4>History</h4>
232
233   
234
235    <h3>Known issues</h3>
236   
237   
238   
239    <h4>Restrictions</h4>
240
241
242   
243   
244   
245   
246   
247   
248   
249
250    <font size="-3"><p>&nbsp;</p></font>
251    <hr size="1" color="#CCCCCC"/>
252     
253      <a name="#_vecteur"></a>
254
255      <h2>vecteur  <font size="-1" color="#006633">
256 Graphics
257</font></h2>
258
259      <p><font face="Courier">vecteur<i>, <a href="#_vecteur_keyword_composanteu">composanteu</a>, <a href="#_vecteur_keyword_composantev">composantev</a>, <a href="#_vecteur_keyword_normevecteur">normevecteur</a>, <a href="#_vecteur_keyword_indice2d">indice2d</a>, <a href="#_vecteur_keyword_reduitindice2d">reduitindice2d</a></i>, <a href="#_vecteur_keyword_CMREF">CMREF</a>=<i>CMREF</i>, <a href="#_vecteur_keyword_MISSING">MISSING</a>=<i>MISSING</i>, <a href="#_vecteur_keyword_NORMEREF">NORMEREF</a>=<i>NORMEREF</i>, <a href="#_vecteur_keyword_VECTCOLOR">VECTCOLOR</a>=<i>VECTCOLOR</i>, <a href="#_vecteur_keyword_VECTTHICK">VECTTHICK</a>=<i>VECTTHICK</i>, <a href="#_vecteur_keyword_VECTREFPOS">VECTREFPOS</a>=<i>VECTREFPOS</i>, <a href="#_vecteur_keyword_VECTREFFORMAT">VECTREFFORMAT</a>=<i>VECTREFFORMAT</i>, <a href="#_vecteur_keyword_NOVECTREF">NOVECTREF</a>=<i>NOVECTREF</i>, <a href="#_vecteur_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
260
261   
262
263
264   
265
266   
267    <h3>Parameters</h3>
268   
269
270    <a name="#_vecteur_keyword_composanteu"></a>
271    <h4>composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
272      <font size="-1" color="#006633">in</font>
273     
274     
275      <font size="-1" color="#006633">required</font>
276     
277     
278     
279     
280    </h4>
281
282   
283 It is the u component of the vector to be traced. This 2d array has the
284 same dimension that reduitindice2d (see further)
285
286   
287
288    <a name="#_vecteur_keyword_composantev"></a>
289    <h4>composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
290      <font size="-1" color="#006633">in</font>
291     
292     
293      <font size="-1" color="#006633">required</font>
294     
295     
296     
297     
298    </h4>
299
300   
301 It is the v component of the vector to be traced. This 2d array has the
302 same dimension that reduitindice2d (see further)
303
304   
305
306    <a name="#_vecteur_keyword_normevecteur"></a>
307    <h4>normevecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
308     
309     
310     
311     
312     
313     
314     
315     
316    </h4>
317
318   
319
320
321   
322
323    <a name="#_vecteur_keyword_indice2d"></a>
324    <h4>indice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
325      <font size="-1" color="#006633">in</font>
326     
327     
328      <font size="-1" color="#006633">required</font>
329     
330     
331     
332     
333    </h4>
334
335   
336 It in an index allowing to to pass from an jpi or jpj array to the zoom
337 on which we do the drawing
338
339   
340
341    <a name="#_vecteur_keyword_reduitindice2d"></a>
342    <h4>reduitindice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
343      <font size="-1" color="#006633">in</font>
344     
345     
346      <font size="-1" color="#006633">required</font>
347     
348     
349     
350     
351    </h4>
352
353   
354 It is an index allowing to pass from an array defined by indice2d to the
355 array for which we really have vectors to be traced (to be clear, it is
356 for example when we trace only one vector on two).
357
358   
359   
360
361   
362    <h3>Keywords</h3>
363
364   
365    <a name="#_vecteur_keyword_CMREF"></a>
366    <h4>CMREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
367     
368     
369     
370     
371     
372     
373      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>between .5 and 1.5 cm</i></font>
374     
375    </h4>
376
377   
378 The length in cm that must measure the arrow normed normeref. By default,
379 it is adjusted to other drawing and included between .5 and 1.5 cm.
380
381   
382    <a name="#_vecteur_keyword_MISSING"></a>
383    <h4>MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
384     
385     
386     
387     
388     
389     
390     
391     
392    </h4>
393
394   
395 The value of a missing value. Do not use this keyword. Fixed at 1e5 by
396 ajoutvect.pro
397
398   
399    <a name="#_vecteur_keyword_NORMEREF"></a>
400    <h4>NORMEREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
401     
402     
403     
404     
405     
406     
407     
408     
409    </h4>
410
411   
412 The norme of the reference arrow.
413
414   
415    <a name="#_vecteur_keyword_VECTCOLOR"></a>
416    <h4>VECTCOLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
417     
418     
419     
420     
421     
422     
423      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
424     
425    </h4>
426
427   
428 The color of the arrow. Black by default (color 0)
429
430   
431    <a name="#_vecteur_keyword_VECTTHICK"></a>
432    <h4>VECTTHICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
433     
434     
435     
436     
437     
438     
439      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
440     
441    </h4>
442
443   
444 The thick of the arrow.
445
446   
447    <a name="#_vecteur_keyword_VECTREFPOS"></a>
448    <h4>VECTREFPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
449     
450     
451     
452     
453     
454     
455     
456     
457    </h4>
458
459   
460 Vector composed of 2 elements specifying the position on DATA coordinates
461 from the beginning of the reference vector. By default at the right bottom
462 of the drawing.
463
464   
465    <a name="#_vecteur_keyword_VECTREFFORMAT"></a>
466    <h4>VECTREFFORMAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
467     
468     
469     
470     
471     
472     
473     
474     
475    </h4>
476
477   
478 The format to be used to specify the norme of the reference vector.
479
480   
481    <a name="#_vecteur_keyword_NOVECTREF"></a>
482    <h4>NOVECTREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
483     
484     
485     
486     
487     
488     
489     
490     
491    </h4>
492
493   
494 To delete the display of the reference vector.
495
496   
497    <a name="#_vecteur_keyword__EXTRA"></a>
498    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
499     
500     
501     
502     
503     
504     
505     
506     
507    </h4>
508
509   
510 Used to pass keywords
511
512   
513   
514
515   
516    </pre><h3>Version history</h3>
517   
518    <h4>Version</h4>
519 $Id: vecteur.pro 297 2007-09-25 15:09:12Z pinsard $
520
521    <h4>History</h4>
522  Creation : 13/02/98 G. Roullet (grlod@lodyc.jussieu.fr)
523  Modification : 14/01/99 realise la transformation
524  spherique<->cartesien G. Roullet
525                 12/03/99 verification de la routine G. Roullet
526  8/11/1999:
527  G. Roullet et Sebastien Masson (smasson@lodyc.jussieu.fr)
528  adaptation pour les zoom. reverification...traitement separe de la
529  direction et de la norme des vecteurs. mots cles NORMEREF et CMREF.
530
531   
532
533   
534   
535   
536   
537   
538
539    <h3>Other attributes</h3>
540   
541   
542    <h4>Uses routines</h4>
543 common.pro
544
545   
546   
547   
548
549    <font size="-3"><p>&nbsp;</p></font>
550    <hr size="1" color="#CCCCCC"/>
551     
552
553   
554
555    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
556
557  </body>
558</html>
Note: See TracBrowser for help on using the repository browser.