Changeset 363 for trunk/SRC/Documentation/idldoc_assistant_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_assistant_output/ReadWrite/ncdf_getmask.html (modified) (5 diffs)

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

@@ -74 +74 @@
 </font></h2>
 
-      <p><font face="Courier"><i>result = </i>ncdf_getmask(<i><a href="#_ncdf_getmask_keyword_fileid">fileid</a></i>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
+      <p><font face="Courier"><i>result = </i>ncdf_getmask(<i><a href="#_ncdf_getmask_keyword_fileid">fileid</a></i>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
 
     
@@ -164 +164 @@
  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)
 
     
@@ -183 +185 @@
 
     
- 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.  
 
     
@@ -204 +206 @@
 
     
+    <a name="#_ncdf_getmask_keyword_TESTOP"></a>
+    <h4>TESTOP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+      
+      
+      
+      
+      
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string, for example 'GT 0.5'</i></font>
+      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'NE'</i></font>
+      
+    </h4>
+
+    
+ 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)
+
+    
     <a name="#_ncdf_getmask_keyword__EXTRA"></a>
     <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -227 +254 @@
  IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
 
+ IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')
+
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: ncdf_getmask.pro 361 2008-07-07 14:23:42Z smasson $
 
     <h4>History</h4>