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