source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/ajoutvect.html @ 402

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

update documentation

File size: 6.1 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>ajoutvect.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="ajoutvect.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//ajoutvect.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&lt;&lt; prev file | <a href="vecteur.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ajoutvect.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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">ajoutvect.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Overprint vectors in a field traced by plt.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_ajoutvect">
105
106          <h2><a class="top" href="#container">top</a>ajoutvect <span class="categories">
107 Graphics
108</span></h2>
109       
110          <p class="header">
111            ajoutvect<span class="result">, <a href="#_ajoutvect_param_vecteur">vecteur</a>, <a href="#_ajoutvect_param_vectlegende">vectlegende</a></span>, <a href="#_ajoutvect_keyword_UNVECTSUR">UNVECTSUR</a>=<span class="result">scalar or array</span>, <a href="#_ajoutvect_keyword_VECTMIN">VECTMIN</a>=<span class="result">VECTMIN</span>, <a href="#_ajoutvect_keyword_VECTMAX">VECTMAX</a>=<span class="result">VECTMAX</span>, <a href="#_ajoutvect_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_ajoutvect_param_vecteur">vecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128              <span class="attr">type:</span> <span class="value">vector</span>
129             
130             
131            </h4>
132       
133          <div class="comments"> goes well too.
134</div>
135           
136            <h4 id="_ajoutvect_param_vectlegende">vectlegende&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137             
138             
139             
140             
141             
142             
143             
144             
145            </h4>
146       
147          <div class="comments"></div>
148           
149
150         
151
152         
153
154            <h3>Keywords</h3>
155           
156            <h4 id="_ajoutvect_keyword_UNVECTSUR">UNVECTSUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157             
158             
159             
160             
161             
162              <span class="attr">type:</span> <span class="value">scalar or array</span>
163             
164             
165            </h4>
166       
167            <div class="comments">
168 It is a scalar n or an array with 2 elements [n1,n2].
169 In the first case, we will trace a vector on n following x and y.
170 In the second case, we will trace a vector on n1 following x and a
171 vector n2 following n2
172   Comments: To trace all vectors following y and one vector on two
173 following x, put unvectsur=[2,1]
174</div>
175           
176            <h4 id="_ajoutvect_keyword_VECTMIN">VECTMIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177              <span class="attr">in</span>
178             
179             
180              <span class="attr">required</span>
181             
182             
183             
184             
185            </h4>
186       
187            <div class="comments">
188 Minimum norme of vectors to be traced
189</div>
190           
191            <h4 id="_ajoutvect_keyword_VECTMAX">VECTMAX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192              <span class="attr">in</span>
193             
194             
195              <span class="attr">required</span>
196             
197             
198             
199             
200            </h4>
201       
202            <div class="comments">
203 Maximum norme of vectors to be traced
204</div>
205           
206            <h4 id="_ajoutvect_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207             
208             
209             
210             
211             
212             
213             
214             
215            </h4>
216       
217            <div class="comments">
218 Used to pass keywords
219</div>
220           
221         
222
223         
224          <h3>Version history</h3>
225         
226          <h4>Version</h4><div class="preformat">
227 $Id: ajoutvect.pro 370 2008-08-07 07:59:15Z pinsard $
228</div>
229          <h4>History</h4><div class="preformat">
230 Sebastien Masson (smasson@lodyc.jussieu.fr)
231                        10/3/1999
232                       11/6/1999 compatibilite avec NAN et la lecture
233                       des structures.
234</div>
235         
236         
237         
238         
239         
240         
241         
242       
243          <h3>Other attributes</h3>
244         
245         
246          <h4>Uses routines</h4><div class="preformat">
247 <a href="../../..//Obsolete/common.html">common</a>
248</div>
249         
250         
251         
252       
253          <h3>Statistics</h3>
254          <table class="statistics">
255            <tr><td>McCabe cyclic</td><td>          38</td></tr>
256            <tr><td>McCabe essential</td><td>           1</td></tr>
257            <tr><td>McCabe modular design</td><td>           1</td></tr>
258          </table>
259         
260       
261        </div>
262       
263      </div>
264
265     
266
267      <div id="tagline">Produced by IDLdoc 2.0.</div>
268
269    </div>
270
271  </body>
272</html>
Note: See TracBrowser for help on using the repository browser.