Changeset 338 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html

Timestamp:

03/20/08 23:06:02 (16 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html (modified) (4 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html

@@ -115 +115 @@
         
           <p class="header">
-            <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
+            <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ZINVAR">ZINVAR</a>=<span class="result">named variable</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments">
@@ -416 +416 @@
 </div>
             
+            <h4 id="_read_ncdf_keyword_ZINVAR">ZINVAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">named variable</span>
+              
+              
+            </h4>
+        
+            <div class="comments">
+ Set this keyword to a named variable in which 1 is returned if a
+ vertical dimension is found in the variable. Returns 0 otherwise
+</div>
+            
             <h4 id="_read_ncdf_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
               
@@ -429 +445 @@
             <div class="comments">
  Used to pass keywords to <a href="../..//Utilities/isafile.html">isafile</a>, <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a>,
- <a href="../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a> and <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
+ <a href="../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a>, <a href="../..//ReadWrite/ncdf_getatt.html">ncdf_getatt</a> and <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
 </div>
             
@@ -438 +454 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: read_ncdf.pro 310 2007-11-15 17:15:30Z smasson $</div>
+ $Id: read_ncdf.pro 336 2008-03-20 21:36:46Z smasson $
+</div>
           <h4>History</h4><div class="preformat">
  Sebastien Masson (smasson@lodyc.jussieu.fr)