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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 10.9 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 370 2008-08-07 07:59:15Z pinsard $
136
137    <h4>History</h4>
138
139   
140
141    <h3>Known issues</h3>
142   
143   
144   
145    <h4>Restrictions</h4>
146
147
148   
149   
150   
151   
152   
153   
154   
155
156    <font size="-3"><p>&nbsp;</p></font>
157    <hr size="1" color="#CCCCCC"/>
158     
159      <a name="#_normalise"></a>
160
161      <h2>normalise  <font size="-1" color="#006633">
162</font></h2>
163
164      <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>
165
166   
167
168
169   
170
171   
172    <h3>Parameters</h3>
173   
174
175    <a name="#_normalise_keyword_u"></a>
176    <h4>u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182     
183     
184     
185    </h4>
186
187   
188
189   
190
191    <a name="#_normalise_keyword_v"></a>
192    <h4>v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193     
194     
195     
196     
197     
198     
199     
200     
201    </h4>
202
203   
204
205   
206
207    <a name="#_normalise_keyword_w"></a>
208    <h4>w&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209     
210     
211     
212     
213     
214     
215     
216     
217    </h4>
218
219   
220
221   
222   
223
224   
225
226    <h3>Examples</h3><pre>
227
228    </pre><h3>Version history</h3>
229   
230    <h4>Version</h4>
231 $Id: vecteur.pro 370 2008-08-07 07:59:15Z pinsard $
232
233    <h4>History</h4>
234
235   
236
237    <h3>Known issues</h3>
238   
239   
240   
241    <h4>Restrictions</h4>
242
243
244   
245   
246   
247   
248   
249   
250   
251
252    <font size="-3"><p>&nbsp;</p></font>
253    <hr size="1" color="#CCCCCC"/>
254     
255      <a name="#_vecteur"></a>
256
257      <h2>vecteur  <font size="-1" color="#006633">
258 Graphics
259</font></h2>
260
261      <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>
262
263   
264
265
266   
267
268   
269    <h3>Parameters</h3>
270   
271
272    <a name="#_vecteur_keyword_composanteu"></a>
273    <h4>composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274      <font size="-1" color="#006633">in</font>
275     
276     
277      <font size="-1" color="#006633">required</font>
278     
279     
280     
281     
282    </h4>
283
284   
285 It is the u component of the vector to be traced. This 2d array has the
286 same dimension that reduitindice2d (see further)
287
288   
289
290    <a name="#_vecteur_keyword_composantev"></a>
291    <h4>composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292      <font size="-1" color="#006633">in</font>
293     
294     
295      <font size="-1" color="#006633">required</font>
296     
297     
298     
299     
300    </h4>
301
302   
303 It is the v component of the vector to be traced. This 2d array has the
304 same dimension that reduitindice2d (see further)
305
306   
307
308    <a name="#_vecteur_keyword_normevecteur"></a>
309    <h4>normevecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
310     
311     
312     
313     
314     
315     
316     
317     
318    </h4>
319
320   
321
322   
323
324    <a name="#_vecteur_keyword_indice2d"></a>
325    <h4>indice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
326      <font size="-1" color="#006633">in</font>
327     
328     
329      <font size="-1" color="#006633">required</font>
330     
331     
332     
333     
334    </h4>
335
336   
337 It in an index allowing to to pass from an jpi or jpj array to the zoom
338 on which we do the drawing
339
340   
341
342    <a name="#_vecteur_keyword_reduitindice2d"></a>
343    <h4>reduitindice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
344      <font size="-1" color="#006633">in</font>
345     
346     
347      <font size="-1" color="#006633">required</font>
348     
349     
350     
351     
352    </h4>
353
354   
355 It is an index allowing to pass from an array defined by indice2d to the
356 array for which we really have vectors to be traced (to be clear, it is
357 for example when we trace only one vector on two).
358
359   
360   
361
362   
363    <h3>Keywords</h3>
364
365   
366    <a name="#_vecteur_keyword_CMREF"></a>
367    <h4>CMREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
368     
369     
370     
371     
372     
373     
374      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>between .5 and 1.5 cm</i></font>
375     
376    </h4>
377
378   
379 The length in cm that must measure the arrow normed normeref. By default,
380 it is adjusted to other drawing and included between .5 and 1.5 cm.
381
382   
383    <a name="#_vecteur_keyword_MISSING"></a>
384    <h4>MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385     
386     
387     
388     
389     
390     
391     
392     
393    </h4>
394
395   
396 The value of a missing value. Do not use this keyword. Fixed at 1e5 by
397 ajoutvect.pro
398
399   
400    <a name="#_vecteur_keyword_NORMEREF"></a>
401    <h4>NORMEREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402     
403     
404     
405     
406     
407     
408     
409     
410    </h4>
411
412   
413 The norme of the reference arrow.
414
415   
416    <a name="#_vecteur_keyword_VECTCOLOR"></a>
417    <h4>VECTCOLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
418     
419     
420     
421     
422     
423     
424      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
425     
426    </h4>
427
428   
429 The color of the arrow. Black by default (color 0)
430
431   
432    <a name="#_vecteur_keyword_VECTTHICK"></a>
433    <h4>VECTTHICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
434     
435     
436     
437     
438     
439     
440      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
441     
442    </h4>
443
444   
445 The thick of the arrow.
446
447   
448    <a name="#_vecteur_keyword_VECTREFPOS"></a>
449    <h4>VECTREFPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
450     
451     
452     
453     
454     
455     
456     
457     
458    </h4>
459
460   
461 Vector composed of 2 elements specifying the position on DATA coordinates
462 from the beginning of the reference vector. By default at the right bottom
463 of the drawing.
464
465   
466    <a name="#_vecteur_keyword_VECTREFFORMAT"></a>
467    <h4>VECTREFFORMAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
468     
469     
470     
471     
472     
473     
474     
475     
476    </h4>
477
478   
479 The format to be used to specify the norme of the reference vector.
480
481   
482    <a name="#_vecteur_keyword_NOVECTREF"></a>
483    <h4>NOVECTREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
484     
485     
486     
487     
488     
489     
490     
491     
492    </h4>
493
494   
495 To delete the display of the reference vector.
496
497   
498    <a name="#_vecteur_keyword__EXTRA"></a>
499    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
500     
501     
502     
503     
504     
505     
506     
507     
508    </h4>
509
510   
511 Used to pass keywords
512
513   
514   
515
516   
517    </pre><h3>Version history</h3>
518   
519    <h4>Version</h4>
520 $Id: vecteur.pro 370 2008-08-07 07:59:15Z pinsard $
521
522    <h4>History</h4>
523  Creation : 13/02/98 G. Roullet (grlod@lodyc.jussieu.fr)
524  Modification : 14/01/99 realise la transformation
525  spherique<->cartesien G. Roullet
526                 12/03/99 verification de la routine G. Roullet
527  8/11/1999:
528  G. Roullet et Sebastien Masson (smasson@lodyc.jussieu.fr)
529  adaptation pour les zoom. reverification...traitement separe de la
530  direction et de la norme des vecteurs. mots cles NORMEREF et CMREF.
531
532   
533
534   
535   
536   
537   
538   
539
540    <h3>Other attributes</h3>
541   
542   
543    <h4>Uses routines</h4>
544 <a href="../../..//Obsolete/common.html">common</a>
545
546   
547   
548   
549
550    <font size="-3"><p>&nbsp;</p></font>
551    <hr size="1" color="#CCCCCC"/>
552     
553
554   
555
556    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
557
558  </body>
559</html>
Note: See TracBrowser for help on using the repository browser.