source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/ncdf_lec.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.5 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>ncdf_lec.pro (IDLdoc API 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="ncdf_lec.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="litchamp.html">&lt;&lt;prev file</a> | <a href="read_ftp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_lec.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/LECTURE/</a></h1>
82      <h2 class="pro_file">ncdf_lec.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_ncdf_lec">
103
104          <h2><a class="top" href="#container">top</a>ncdf_lec </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>ncdf_lec(<span class="result"><a href="#_ncdf_lec_param_nom">nom</a></span>, <a href="#_ncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_ncdf_lec_keyword_DIM">DIM</a>=<span class="result">DIM</span>, <a href="#_ncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>, <a href="#_ncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_ncdf_lec_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
108       
109          <div class="comments">
110 NAME:ncdflec
111
112 PURPOSE:donne des infos sur un fichier netcdf et permet de recupere
113 les variables qui y sont ecrites
114
115 CATEGORY:lecture de fichiers netcdf
116
117 CALLING SEQUENCE: res=ncdflec('nom_de _fichier')
118
119 INPUTS:nom_de _fichier:nom d'un fichier net cdf situe ds e repertoire
120 stipule par iodir
121
122 KEYWORD PARAMETERS:
123
124        ATT: 'global' ou au nom d'une variable. permet de voir tous les
125 attributs rattaches a une variable.
126
127        /DIM:donne la liste des dimensions
128
129        VAR:
130       1) /var: donne la liste des variables
131       2) var='nom de variable': ds ce cas la fonction retourne la variable
132
133       IODIR: string contenant le repertoire ou aller chercher le
134       fichier a lire.
135
136       _EXTRA: permet de passer les mots cles definits par IDL pour
137       les fonction NETCDF (en particulier OFFSET et COUNT ds ncdf_varget)
138
139 OUTPUTS:-1 sauf si var='nom de variable' auquel cas la fonction retourne la variable
140
141 REMARQUE:les noms des variables du programme sont similaires a ceux employes
142 ds le manuel IDL 'scientific data formats'
143</div>
144
145         
146
147         
148            <h3>Parameters</h3>
149       
150           
151            <h4 id="_ncdf_lec_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments"></div>
163           
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
171            <h4 id="_ncdf_lec_keyword_ATT">ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182            <div class="comments"></div>
183           
184            <h4 id="_ncdf_lec_keyword_DIM">DIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments"></div>
196           
197            <h4 id="_ncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
208            <div class="comments"></div>
209           
210            <h4 id="_ncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments"></div>
222           
223            <h4 id="_ncdf_lec_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229             
230             
231             
232            </h4>
233       
234            <div class="comments"></div>
235           
236         
237
238         
239         
240         
241         
242         
243         
244         
245         
246         
247         
248         
249         
250       
251         
252         
253         
254         
255         
256         
257         
258       
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.