source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/LABEL/label.html

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

update documentation
File size: 6.8 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>label.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="label.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/LABEL//label.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="label_date.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="label.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/LABEL/</a></h1>
82      <h2 class="pro_file">label.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Allows to choose the type of the label we want to use at the time of a
91 contour.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_label">
106
107          <h2><a class="top" href="#container">top</a>label <span class="categories">
108 Graphics
109</span></h2>
110       
111          <p class="header">
112            label<span class="result">, <a href="#_label_param_cas">cas</a>, <a href="#_label_param_min">min</a>, <a href="#_label_param_max">max</a>, <a href="#_label_param_ncontour">ncontour</a>, <a href="#_label_param_level_z2d">level_z2d</a>, <a href="#_label_param_colnumb">colnumb</a></span>, <a href="#_label_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_label_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_label_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span></p>
113       
114          <div class="comments">
115</div>
116
117         
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_label_param_cas">cas&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129             
130             
131             
132            </h4>
133       
134          <div class="comments">
135 Number of the type of the label we want to trace
136</div>
137           
138            <h4 id="_label_param_min">min&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments">
150 Smallest value for the drawing of the contour.
151</div>
152           
153            <h4 id="_label_param_max">max&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154              <span class="attr">in</span>
155             
156             
157              <span class="attr">required</span>
158             
159             
160             
161             
162            </h4>
163       
164          <div class="comments">
165 Biggest value for the drawing of the contour.
166</div>
167           
168            <h4 id="_label_param_ncontour">ncontour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170              <span class="attr">out</span>
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments">
180 Number of contour to be drawn.
181</div>
182           
183            <h4 id="_label_param_level_z2d">level_z2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185              <span class="attr">out</span>
186             
187             
188             
189             
190             
191             
192            </h4>
193       
194          <div class="comments">
195 Vector containing values of contours we draw.
196</div>
197           
198            <h4 id="_label_param_colnumb">colnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200              <span class="attr">out</span>
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209          <div class="comments">
210 Vector containing the number of colors which will serve to fill contours.
211</div>
212           
213
214         
215
216         
217
218            <h3>Keywords</h3>
219           
220            <h4 id="_label_keyword_NLEVEL">NLEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227              <span class="attr">default:</span> <span class="value">20</span>
228             
229            </h4>
230       
231            <div class="comments">
232 Number of contour to be drawn. Active if LABEL=0 or is not specified.
233</div>
234           
235            <h4 id="_label_keyword_INTERVALLE">INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242              <span class="attr">default:</span> <span class="value">20</span>
243             
244            </h4>
245       
246            <div class="comments">
247 Value of an interval between two isolines. By default, it is calculated to
248 draw 20 isolines. In all cases, this keyword must be returned have a nice
249 caption. If levels do not contain regular intervals, put it at -1.
250</div>
251           
252            <h4 id="_label_keyword_STRICTFILL">STRICTFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253             
254             
255             
256             
257             
258             
259             
260             
261            </h4>
262       
263            <div class="comments"></div>
264           
265         
266
267         
268          <h3>Version history</h3>
269         
270          <h4>Version</h4><div class="preformat">
271 $Id: label.pro 369 2008-08-06 15:52:18Z pinsard $
272</div>
273          <h4>History</h4><div class="preformat">
274 Sebastien Masson (smasson@lodyc.jussieu.fr)
275                  7/5/98
276</div>
277         
278         
279         
280         
281         
282         
283         
284       
285          <h3>Other attributes</h3>
286         
287         
288          <h4>Uses routines</h4><div class="preformat">
289 <a href="../../..//Obsolete/common.html">common</a>
290</div>
291         
292         
293         
294       
295          <h3>Statistics</h3>
296          <table class="statistics">
297            <tr><td>McCabe cyclic</td><td>          13</td></tr>
298            <tr><td>McCabe essential</td><td>           1</td></tr>
299            <tr><td>McCabe modular design</td><td>           1</td></tr>
300          </table>
301         
302       
303        </div>
304       
305      </div>
306
307     
308
309      <div id="tagline">Produced by IDLdoc 2.0.</div>
310
311    </div>
312
313  </body>
314</html>
Note: See TracBrowser for help on using the repository browser.