source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/vecteur.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output

File size: 13.5 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>vecteur.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="vecteur.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/PLOTS/VECTEUR//vecteur.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="ajoutvect.html">&lt;&lt;prev file</a> | <a href="velovect.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="vecteur.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/VECTEUR/</a></h1>
82      <h2 class="pro_file">vecteur.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 
91 
92 
93 
94 
95
96 Trace vectors (even if they are on a deformed grid) on any projection.
97 In this way, all vectors have a comparable norme on the drawing (to be
98 clear, a vector which measure 1 cm measure it, no matter the projection
99 and is position on the sphere).
100</div>
101
102     
103
104     
105
106     
107
108     
109      <div id="routine_summary">               
110        <h2>Routine summary</h2>
111       
112        <dl>
113         
114          <dt><p><a href="#_cv_cm2normal"><span class="result">result = </span>cv_cm2normal(<span class="result">angle</span>)</a></p><dt>
115          <dd></dd>     
116         
117          <dt><p><a href="#_normalise">normalise<span class="result">, u, v, w</span></a></p><dt>
118          <dd></dd>     
119         
120          <dt><p><a href="#_vecteur">vecteur<span class="result">, composanteu, composantev, normevecteur, indice2d, reduitindice2d</span>, CMREF=<span class="result">CMREF</span>, MISSING=<span class="result">MISSING</span>, NORMEREF=<span class="result">NORMEREF</span>, VECTCOLOR=<span class="result">VECTCOLOR</span>, VECTTHICK=<span class="result">VECTTHICK</span>, VECTREFPOS=<span class="result">VECTREFPOS</span>, VECTREFFORMAT=<span class="result">VECTREFFORMAT</span>, NOVECTREF=<span class="result">NOVECTREF</span>, _extra=<span class="result">_extra</span></a></p><dt>
121          <dd> </dd>   
122               
123        </dl>
124      </div>
125     
126
127      <div id="routine_details">
128       
129
130        <div class="routine_details" id="_cv_cm2normal">
131
132          <h2><a class="top" href="#container">top</a>cv_cm2normal <span class="categories">
133 
134 </span></h2>
135       
136          <p class="header">
137            <span class="result">result = </span>cv_cm2normal(<span class="result"><a href="#_cv_cm2normal_param_angle">angle</a></span>)</p>
138       
139          <div class="comments"></div>
140
141          <h3>Return value</h3><div class="preformat">
142 
143 </div>
144
145         
146            <h3>Parameters</h3>
147       
148           
149            <h4 id="_cv_cm2normal_param_angle">angle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160          <div class="comments"> 
161
162</div>
163           
164
165         
166
167         
168
169          <h3>Examples</h3><div class="preformat">
170
171</div>
172          <h3>Version history</h3>
173         
174          <h4>Version</h4><div class="preformat">
175 $Id: vecteur.pro 163 2006-08-29 12:59:46Z navarro $</div>
176          <h4>History</h4><div class="preformat">
177 
178</div>
179         
180         
181          <h3>Known issues</h3>
182         
183         
184         
185          <h4>Restrictions</h4><div class="preformat">
186 
187 </div>
188       
189         
190         
191         
192         
193         
194         
195         
196       
197          <h3>Statistics</h3>
198          <table class="statistics">
199            <tr><td>McCabe cyclic</td><td>           1</td></tr>
200            <tr><td>McCabe essential</td><td>           1</td></tr>
201            <tr><td>McCabe modular design</td><td>           1</td></tr>
202          </table>
203         
204       
205        </div>
206       
207
208        <div class="routine_details" id="_normalise">
209
210          <h2><a class="top" href="#container">top</a>normalise <span class="categories">
211 
212 </span></h2>
213       
214          <p class="header">
215            normalise<span class="result">, <a href="#_normalise_param_u">u</a>, <a href="#_normalise_param_v">v</a>, <a href="#_normalise_param_w">w</a></span></p>
216       
217          <div class="comments"></div>
218
219         
220
221         
222            <h3>Parameters</h3>
223       
224           
225            <h4 id="_normalise_param_u">u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231             
232             
233             
234            </h4>
235       
236          <div class="comments">
237
238</div>
239           
240            <h4 id="_normalise_param_v">v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251          <div class="comments">
252
253</div>
254           
255            <h4 id="_normalise_param_w">w&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256             
257             
258             
259             
260             
261             
262             
263             
264            </h4>
265       
266          <div class="comments"> 
267
268</div>
269           
270
271         
272
273         
274
275          <h3>Examples</h3><div class="preformat">
276
277</div>
278          <h3>Version history</h3>
279         
280          <h4>Version</h4><div class="preformat">
281 $Id: vecteur.pro 163 2006-08-29 12:59:46Z navarro $</div>
282          <h4>History</h4><div class="preformat">
283 
284</div>
285         
286         
287          <h3>Known issues</h3>
288         
289         
290         
291          <h4>Restrictions</h4><div class="preformat">
292 
293 </div>
294       
295         
296         
297         
298         
299         
300         
301         
302       
303          <h3>Statistics</h3>
304          <table class="statistics">
305            <tr><td>McCabe cyclic</td><td>           2</td></tr>
306            <tr><td>McCabe essential</td><td>           1</td></tr>
307            <tr><td>McCabe modular design</td><td>           1</td></tr>
308          </table>
309         
310       
311        </div>
312       
313
314        <div class="routine_details" id="_vecteur">
315
316          <h2><a class="top" href="#container">top</a>vecteur <span class="categories"> 
317 Graphics
318 </span></h2>
319       
320          <p class="header">
321            vecteur<span class="result">, <a href="#_vecteur_param_composanteu">composanteu</a>, <a href="#_vecteur_param_composantev">composantev</a>, <a href="#_vecteur_param_normevecteur">normevecteur</a>, <a href="#_vecteur_param_indice2d">indice2d</a>, <a href="#_vecteur_param_reduitindice2d">reduitindice2d</a></span>, <a href="#_vecteur_keyword_CMREF">CMREF</a>=<span class="result">CMREF</span>, <a href="#_vecteur_keyword_MISSING">MISSING</a>=<span class="result">MISSING</span>, <a href="#_vecteur_keyword_NORMEREF">NORMEREF</a>=<span class="result">NORMEREF</span>, <a href="#_vecteur_keyword_VECTCOLOR">VECTCOLOR</a>=<span class="result">VECTCOLOR</span>, <a href="#_vecteur_keyword_VECTTHICK">VECTTHICK</a>=<span class="result">VECTTHICK</span>, <a href="#_vecteur_keyword_VECTREFPOS">VECTREFPOS</a>=<span class="result">VECTREFPOS</span>, <a href="#_vecteur_keyword_VECTREFFORMAT">VECTREFFORMAT</a>=<span class="result">VECTREFFORMAT</span>, <a href="#_vecteur_keyword_NOVECTREF">NOVECTREF</a>=<span class="result">NOVECTREF</span>, <a href="#_vecteur_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
322       
323          <div class="comments">
324</div>
325
326         
327
328         
329            <h3>Parameters</h3>
330       
331           
332            <h4 id="_vecteur_param_composanteu">composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333              <span class="attr">in</span>
334             
335             
336              <span class="attr">required</span>
337             
338             
339             
340             
341            </h4>
342       
343          <div class="comments">
344 It is the u component of the vector to be traced. This 2d array has the
345 same dimension that reduitindice2d (see further)
346 </div>
347           
348            <h4 id="_vecteur_param_composantev">composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
349              <span class="attr">in</span>
350             
351             
352              <span class="attr">required</span>
353             
354             
355             
356             
357            </h4>
358       
359          <div class="comments">
360 It is the v component of the vector to be traced. This 2d array has the
361 same dimension that reduitindice2d (see further)
362 </div>
363           
364            <h4 id="_vecteur_param_normevecteur">normevecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
365             
366             
367             
368             
369             
370             
371             
372             
373            </h4>
374       
375          <div class="comments">
376
377</div>
378           
379            <h4 id="_vecteur_param_indice2d">indice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
380              <span class="attr">in</span>
381             
382             
383              <span class="attr">required</span>
384             
385             
386             
387             
388            </h4>
389       
390          <div class="comments">
391 It in an index allowing to to pass from an jpi or jpj array to the zoom
392 on which we do the drawing
393 </div>
394           
395            <h4 id="_vecteur_param_reduitindice2d">reduitindice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
396              <span class="attr">in</span>
397             
398             
399              <span class="attr">required</span>
400             
401             
402             
403             
404            </h4>
405       
406          <div class="comments">
407 It is an index allowing to pass from an array defined by indice2d to the
408 array for which we really have vectors to be traced (to be clear, it is
409 for example when we trace only one vector on two).
410</div>
411           
412
413         
414
415         
416
417            <h3>Keywords</h3>
418           
419            <h4 id="_vecteur_keyword_CMREF">CMREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
420             
421             
422             
423             
424             
425             
426              <span class="attr">default:</span> <span class="value">between .5 and 1.5 cm</span>
427             
428            </h4>
429       
430            <div class="comments">
431 The length in cm that must measure the arrow normed normeref. By default,
432 it is adjusted to other drawing and included between .5 and 1.5 cm.
433</div>
434           
435            <h4 id="_vecteur_keyword_MISSING">MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436             
437             
438             
439             
440             
441             
442             
443             
444            </h4>
445       
446            <div class="comments">
447 The value of a missing value. Do not use this keyword. Fixed at 1e5 by
448 ajoutvect.pro
449      </div>
450           
451            <h4 id="_vecteur_keyword_NORMEREF">NORMEREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
452             
453             
454             
455             
456             
457             
458             
459             
460            </h4>
461       
462            <div class="comments"> 
463 The norme of the reference arrow.
464</div>
465           
466            <h4 id="_vecteur_keyword_VECTCOLOR">VECTCOLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
467             
468             
469             
470             
471             
472             
473              <span class="attr">default:</span> <span class="value">0</span>
474             
475            </h4>
476       
477            <div class="comments">
478 The color of the arrow. Black by default (color 0)
479 </div>
480           
481            <h4 id="_vecteur_keyword_VECTTHICK">VECTTHICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
482             
483             
484             
485             
486             
487             
488              <span class="attr">default:</span> <span class="value">1</span>
489             
490            </h4>
491       
492            <div class="comments">
493 The thick of the arrow.
494</div>
495           
496            <h4 id="_vecteur_keyword_VECTREFPOS">VECTREFPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
497             
498             
499             
500             
501             
502             
503             
504             
505            </h4>
506       
507            <div class="comments">
508 Vector composed of 2 elements specifying the position on DATA coordinates
509 from the beginning of the reference vector. By default at the right bottom
510 of the drawing.
511</div>
512           
513            <h4 id="_vecteur_keyword_VECTREFFORMAT">VECTREFFORMAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
514             
515             
516             
517             
518             
519             
520             
521             
522            </h4>
523       
524            <div class="comments">
525 The format to be used to specify the norme of the reference vector.
526</div>
527           
528            <h4 id="_vecteur_keyword_NOVECTREF">NOVECTREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
529             
530             
531             
532             
533             
534             
535             
536             
537            </h4>
538       
539            <div class="comments">
540 To delete the display of the reference vector.
541 </div>
542           
543            <h4 id="_vecteur_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
544             
545             
546             
547             
548             
549             
550             
551             
552            </h4>
553       
554            <div class="comments">
555 Used to pass your keywords
556</div>
557           
558         
559
560         
561          <h3>Version history</h3>
562         
563          <h4>Version</h4><div class="preformat">
564 $Id: vecteur.pro 163 2006-08-29 12:59:46Z navarro $
565</div>
566          <h4>History</h4><div class="preformat">
567  Creation : 13/02/98 G. Roullet (grlod@lodyc.jussieu.fr)
568  Modification : 14/01/99 realise la transformation
569  spherique<->cartesien G. Roullet
570                 12/03/99 verification de la routine G. Roullet
571  8/11/1999:
572  G. Roullet et Sebastien Masson (smasson@lodyc.jussieu.fr)
573  adaptation pour les zoom. reverification...traitement separe de la
574  direction et de la norme des vecteurs. mots cles NORMEREF et CMREF.
575</div>
576         
577         
578         
579         
580         
581         
582         
583       
584          <h3>Other attributes</h3>
585         
586         
587          <h4>Uses routines</h4><div class="preformat"> 
588 common.pro
589</div>
590         
591         
592         
593       
594          <h3>Statistics</h3>
595          <table class="statistics">
596            <tr><td>McCabe cyclic</td><td>          20</td></tr>
597            <tr><td>McCabe essential</td><td>           1</td></tr>
598            <tr><td>McCabe modular design</td><td>           1</td></tr>
599          </table>
600         
601       
602        </div>
603       
604      </div>
605
606     
607
608      <div id="tagline">Produced by IDLdoc 2.0.</div>
609
610    </div>
611
612  </body>
613</html>
Note: See TracBrowser for help on using the repository browser.