source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/axis4pltz.html

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

update documentation

File size: 7.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>axis4pltz.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="axis4pltz.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/DIVERS//axis4pltz.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="autoscale.html">&lt;&lt;prev file</a> | <a href="barrecouleur.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="axis4pltz.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/DIVERS/</a></h1>
82      <h2 class="pro_file">axis4pltz.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 compute the mask and the axis for a vertical section
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_axis4pltz">
105
106          <h2><a class="top" href="#container">top</a>axis4pltz </h2>
107       
108          <p class="header">
109            axis4pltz<span class="result">, <a href="#_axis4pltz_param_type">type</a>, <a href="#_axis4pltz_param_mask">mask</a>, <a href="#_axis4pltz_param_glam">glam</a>, <a href="#_axis4pltz_param_gphi">gphi</a>, <a href="#_axis4pltz_param_z">z</a></span>, <a href="#_axis4pltz_keyword_XXAXIS">XXAXIS</a>=<span class="result">XXAXIS</span>, <a href="#_axis4pltz_keyword_ZZAXIS">ZZAXIS</a>=<span class="result">ZZAXIS</span>, <a href="#_axis4pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_axis4pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_axis4pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_axis4pltz_keyword_PROFMAX">PROFMAX</a>=<span class="result">PROFMAX</span>, <a href="#_axis4pltz_keyword_PROFMIN">PROFMIN</a>=<span class="result">PROFMIN</span>, <a href="#_axis4pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
110       
111          <div class="comments">
112</div>
113
114         
115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_axis4pltz_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121             
122             
123             
124             
125             
126             
127             
128             
129            </h4>
130       
131          <div class="comments"></div>
132           
133            <h4 id="_axis4pltz_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134              <span class="attr">in</span>
135             
136             
137              <span class="attr">required</span>
138             
139             
140             
141             
142            </h4>
143       
144          <div class="comments">
145 3d mask
146</div>
147           
148            <h4 id="_axis4pltz_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149              <span class="attr">in</span>
150             
151             
152              <span class="attr">required</span>
153             
154             
155             
156             
157            </h4>
158       
159          <div class="comments">
160 2d longitude
161</div>
162           
163            <h4 id="_axis4pltz_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164              <span class="attr">in</span>
165             
166             
167              <span class="attr">required</span>
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments">
175 2d latitude
176</div>
177           
178            <h4 id="_axis4pltz_param_z">z&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179              <span class="attr">in</span>
180             
181             
182              <span class="attr">required</span>
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments">
190 1d depth
191</div>
192           
193
194         
195
196         
197
198            <h3>Keywords</h3>
199           
200            <h4 id="_axis4pltz_keyword_XXAXIS">XXAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments">
212 to get the xaxis we need to use in <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltbase.html">pltbase</a>
213</div>
214           
215            <h4 id="_axis4pltz_keyword_ZZAXIS">ZZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226            <div class="comments">
227 to get the yaxis we need to use in <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltbase.html">pltbase</a>
228</div>
229           
230            <h4 id="_axis4pltz_keyword_SIN">SIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231             
232             
233             
234             
235             
236             
237             
238             
239            </h4>
240       
241            <div class="comments">
242 Activate this keyword if we want the x axis to be traced in sinus of the
243 latitude when we make a drawing f(y)
244</div>
245           
246            <h4 id="_axis4pltz_keyword_ZRATIO">ZRATIO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248             
249             
250             
251             
252             
253              <span class="attr">default:</span> <span class="value">2./3</span>
254             
255            </h4>
256       
257            <div class="comments">
258 When the drawing has a zoomed part, it is the size ratio between the zoomed
259 part, hz (zoom height), and the whole drawing, ht (total height).
260</div>
261           
262            <h4 id="_axis4pltz_keyword_ZOOM">ZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263             
264             
265             
266             
267             
268             
269             
270             
271            </h4>
272       
273            <div class="comments"></div>
274           
275            <h4 id="_axis4pltz_keyword_PROFMAX">PROFMAX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
276             
277             
278             
279             
280             
281             
282             
283             
284            </h4>
285       
286            <div class="comments"></div>
287           
288            <h4 id="_axis4pltz_keyword_PROFMIN">PROFMIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
289             
290             
291             
292             
293             
294             
295             
296             
297            </h4>
298       
299            <div class="comments"></div>
300           
301            <h4 id="_axis4pltz_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
302             
303             
304             
305             
306             
307             
308             
309             
310            </h4>
311       
312            <div class="comments">
313 Used to pass keywords
314
315 Others: see <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltz.html">pltz</a>
316</div>
317           
318         
319
320         
321          <h3>Version history</h3>
322         
323          <h4>Version</h4><div class="preformat">
324 $Id: axis4pltz.pro 378 2008-08-12 12:35:46Z pinsard $
325</div>
326          <h4>History</h4><div class="preformat">
327 Sebastien Masson (smasson@lodyc.jussieu.fr)
328                      June 24, 2002
329</div>
330         
331         
332         
333         
334         
335         
336         
337       
338         
339         
340         
341         
342         
343         
344         
345       
346          <h3>Statistics</h3>
347          <table class="statistics">
348            <tr><td>McCabe cyclic</td><td>          20</td></tr>
349            <tr><td>McCabe essential</td><td>           1</td></tr>
350            <tr><td>McCabe modular design</td><td>           1</td></tr>
351          </table>
352         
353       
354        </div>
355       
356      </div>
357
358     
359
360      <div id="tagline">Produced by IDLdoc 2.0.</div>
361
362    </div>
363
364  </body>
365</html>
Note: See TracBrowser for help on using the repository browser.