Changeset 363 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_getmask.html

Timestamp:

07/29/08 15:31:00 (16 years ago)

Author:

smasson

Message:

update documentation

File:

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

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

@@ -109 +109 @@
         
           <p class="header">
-            <span class="result">result = </span>ncdf_getmask(<span class="result"><a href="#_ncdf_getmask_param_fileid">fileid</a></span>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<span class="result">scalar string</span>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
+            <span class="result">result = </span>ncdf_getmask(<span class="result"><a href="#_ncdf_getmask_param_fileid">fileid</a></span>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<span class="result">scalar string</span>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments">
@@ -196 +196 @@
  that will be used to build the land/sea mask. In this case the
  mask is based on the first record (if record dimension
- exists). The mask is build according to :
-    1 the keyword missing_value if existing
-    2 the attribute 'missing_value' if existing
-    3 NaN values if existing
+ exists). The mask is build according to operator defined by TESTOP
+ keyword (default NE) and the testing values defined as 
+   1) the second word of TESTOP if existing
+   2) MISSING_VALUE keyword
+   3) attribute missing_value or _fillvalue of the variable USEASMASK
+   4) !Values.f_nan (can be used only with NE and EQ operators)
 </div>
             
@@ -214 +216 @@
         
             <div class="comments">
- To define (or redefine if the attribute is
- already existing) the missing values used with USEASMASK
- keyword
+ To define (or redefine if the attribute is already existing) the
+ missing values used with USEASMASK keyword. Note that this value is
+ not used if TESTOP keyword is given and contains 2 words.  
 </div>
             
@@ -234 +236 @@
 </div>
             
+            <h4 id="_ncdf_getmask_keyword_TESTOP">TESTOP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">scalar string, for example 'GT 0.5'</span>
+              <span class="attr">default:</span> <span class="value">'NE'</span>
+              
+            </h4>
+        
+            <div class="comments">
+ a string describing the type of test that will be done to define the
+ mask. The test is performed on the variable specified by USEASMASK
+ keyword.
+ TESTOP can contain 1 or 2 words. The first word is the operator
+ definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The
+ second word define the testing value. If TESTOP contains only 1
+ word, then the test value is denifed by
+   1) MISSING_VALUE keyword
+   2) attribute missing_value or _fillvalue of the variable USEASMASK
+   3) !Values.f_nan (can be used only with NE and EQ operators)
+</div>
+            
             <h4 id="_ncdf_getmask_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
               
@@ -255 +281 @@
 
  IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
+
+ IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')
 </div>
           <h3>Version history</h3>
           
           <h4>Version</h4><div class="preformat">
- $Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: ncdf_getmask.pro 361 2008-07-07 14:23:42Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
@@ -282 +310 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>          24</td></tr>
+            <tr><td>McCabe cyclic</td><td>          34</td></tr>
             <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>