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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

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