source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/INIT/initncdf.html @ 402

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

update documentation
File size: 7.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>initncdf.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="initncdf.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/INIT//initncdf.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="initncdfxxx.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="initncdf.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/INIT/</a></h1>
82      <h2 class="pro_file">initncdf.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Initfile for Netcdf file. define all the grid parameters through
91 an appropriate call to <a href="../..//Grid/computegrid.html">computegrid</a>
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_initncdf">
106
107          <h2><a class="top" href="#container">top</a>initncdf <span class="categories">
108 Grid
109</span></h2>
110       
111          <p class="header">
112            initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
113       
114          <div class="comments">
115</div>
116
117         
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_initncdf_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129              <span class="attr">type:</span> <span class="value">scalar string</span>
130             
131             
132            </h4>
133       
134          <div class="comments">
135 A string giving the name of the NetCdf file
136</div>
137           
138
139         
140
141         
142
143            <h3>Keywords</h3>
144           
145            <h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146             
147             
148             
149             
150             
151              <span class="attr">type:</span> <span class="value">scalar string</span>
152              <span class="attr">default:</span> <span class="value">'z', 'level', 'lev', 'depth...'</span>
153             
154            </h4>
155       
156            <div class="comments">
157 A string giving the name of the variable in the file
158 that contains the [xyz]axis.
159</div>
160           
161            <h4 id="_initncdf_keyword_START1">START1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
168              <span class="attr">default:</span> <span class="value">0</span>
169             
170            </h4>
171       
172            <div class="comments">
173 Index the axis from 1 instead of 0 when using
174 /xyindex and/or /zindex
175</div>
176           
177            <h4 id="_initncdf_keyword_XYINDEX">XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
184              <span class="attr">default:</span> <span class="value">0</span>
185             
186            </h4>
187       
188            <div class="comments">
189 To define the x/y axis with index instead of using
190 the values contained in X/YAXISNAME.
191 x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
192 this forces key_onearth = 0
193</div>
194           
195            <h4 id="_initncdf_keyword_ZINDEX">ZINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
202              <span class="attr">default:</span> <span class="value">0</span>
203             
204            </h4>
205       
206            <div class="comments">
207 To define the z axis with index instead of using
208 the values contained in ZAXISNAME.
209 zaxis = keyword_set(start1) + findgen(jpk)
210</div>
211           
212            <h4 id="_initncdf_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213             
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
223            <div class="comments">
224 Used to pass keywords to <a href="../..//Grid/computegrid.html">computegrid</a>,
225 <a href="../..//ReadWrite/ncdf_getaxis.html">ncdf_getaxis</a>, <a href="../..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> and <a href="../..//Utilities/isafile.html">isafile</a>
226</div>
227           
228         
229
230          <h3>Examples</h3><div class="preformat">
231
232   IDL> initncdf,'toto.nc',glam=[-180,180]
233</div>
234          <h3>Version history</h3>
235         
236          <h4>Version</h4><div class="preformat">
237 $Id: initncdf.pro 371 2008-08-07 09:32:02Z pinsard $
238</div>
239          <h4>History</h4><div class="preformat">
240 Sebastien Masson (smasson@lodyc.jussieu.fr)
241                      8 May 2002
242</div>
243         
244         
245          <h3>Known issues</h3>
246         
247         
248         
249          <h4>Restrictions</h4><div class="preformat">
250 Change the grid parameters (see <a href="../..//Grid/computegrid.html">computegrid</a>)
251
252 the file must contain an x and an y axis. (1 ou 2 dimensional array)
253</div>
254       
255          <h3>Other attributes</h3>
256         
257         
258          <h4>Uses routines</h4><div class="preformat">
259 <a href="../..//Obsolete/common.html">common</a>
260</div>
261         
262         
263         
264       
265          <h3>Statistics</h3>
266          <table class="statistics">
267            <tr><td>McCabe cyclic</td><td>          19</td></tr>
268            <tr><td>McCabe essential</td><td>           1</td></tr>
269            <tr><td>McCabe modular design</td><td>           1</td></tr>
270          </table>
271         
272       
273        </div>
274       
275      </div>
276
277     
278
279      <div id="tagline">Produced by IDLdoc 2.0.</div>
280
281    </div>
282
283  </body>
284</html>
Note: See TracBrowser for help on using the repository browser.