Changeset 338 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_grads.html

Timestamp:

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

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_grads.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_grads.html

@@ -110 +110 @@
         
           <p class="header">
-            <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>[, <a href="#_read_grads_param_date2">date2</a>]</span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">BOX</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
+            <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>[, <a href="#_read_grads_param_date2">date2</a>]</span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments">
 </div>
 
-          
+          <h3>Return value</h3><div class="preformat">
+ an array
+</div>
 
           
@@ -194 +196 @@
               
               
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
+              <span class="attr">type:</span> <span class="value">A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</span>
+              
+              
+            </h4>
+        
+            <div class="comments">
+ It specifies the area where data must be read
+</div>
             
             <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -214 +218 @@
             <div class="comments">
  to specify that the dates are time steps instead of true calendar.
+
+ NOT yet available
 </div>
             
@@ -227 +233 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+</div>
             
             <h4 id="_read_grads_keyword_NOSTRUCT">NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -240 +247 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+</div>
             
             <h4 id="_read_grads_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -253 +261 @@
             </h4>
         
-            <div class="comments"></div>
-            
-          
-
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+            <div class="comments">
+ Used to pass keywords
+</div>
+            
+          
+
+          <h3>Examples</h3><div class="preformat">
+ IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
+ IDL> plt, a
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $
+</div>
+          <h4>History</h4><div class="preformat">
+ Sebastien Masson (smasson@lodyc.jussieu.fr)
+</div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat">
+ define all the grid parameters (defined in common.pro)
+ associated to the data.
+
+ this function call the procedure scanfile that use the
+ unix commands grep and sed
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common
+</div>