Changeset 363 for trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/file_interp.html

Timestamp:

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

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/file_interp.html (modified) (9 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/file_interp.html

@@ -74 +74 @@
 </font></h2>
 
-      <p><font face="Courier">file_interp<i>, <a href="#_file_interp_keyword_filein">filein</a>, <a href="#_file_interp_keyword_fileout">fileout</a>, <a href="#_file_interp_keyword_gridout">gridout</a></i>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<i>string array</i>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<i>string array</i>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<i>scalar 0 or 1</i>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_NAN_VALUE">NAN_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
+      <p><font face="Courier">file_interp<i>, <a href="#_file_interp_keyword_filein">filein</a>, <a href="#_file_interp_keyword_fileout">fileout</a>, <a href="#_file_interp_keyword_gridout">gridout</a></i>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<i>string array</i>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<i>string array</i>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<i>scalar 0 or 1</i>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_INTESTOP">INTESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTTESTOP">OUTTESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_file_interp_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
 
     
@@ -195 +195 @@
  determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords
  outmaskname, outinvmask, outuseasmask, outmissing_value,
- outaddscl_before (see bellow)
+ outaddscl_before (see below).
 
     
@@ -387 +387 @@
 
     
- A string giving the name of the variable in the input mask file maskin
- that will be used to build the land/sea mask. In this case the
+ A string giving the name of the variable in the input mask file
+ that will be used to build the input 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 input mask is build according to operator defined by INTESTOP
+ 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)
 
     
@@ -410 +412 @@
     
  To define (or redefine if the attribute is already existing) the
- missing values used by INUSEASMASK keyword
+ missing values used with INUSEASMASK keyword to build the input mask.
+ Note that this value is not used if INTESTOP keyword is given and
+ contains 2 words.
+ Note: do not mismatch with MISSING_VALUE used to detect missing
+ values at reach record.   
 
     
@@ -430 +436 @@
 
     
+    <a name="#_file_interp_keyword_INTESTOP"></a>
+    <h4>INTESTOP&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
+ input mask. The test is performed on the variable specified by INUSEASMASK
+ keyword.
+ INTESTOP 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 INTESTOP contains only 1
+ word, then the test value is denifed by
+   1) INMISSING_VALUE keyword
+   2) attribute missing_value or _fillvalue of the variable INUSEASMASK
+   3) !Values.f_nan (can be used only with NE and EQ operators)
+
+    
     <a name="#_file_interp_keyword_OUTMASKNAME"></a>
     <h4>OUTMASKNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -510 +541 @@
 
     
-    <a name="#_file_interp_keyword_NAN_VALUE"></a>
-    <h4>NAN_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+    <a name="#_file_interp_keyword_OUTTESTOP"></a>
+    <h4>OUTTESTOP&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>
+
+    
+ same as INTESTOP but for output mask file maskout
+
+    
+    <a name="#_file_interp_keyword_MISSING_VALUE"></a>
+    <h4>MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
       
       
@@ -518 +565 @@
       
       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
-      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
-      
-    </h4>
-
-    
- define the missing value in input data (missing values are treated
+      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by attribute missing_value or _fillvalue</i></font>
+      
+    </h4>
+
+    
+ (Re)define the missing value in input data (missing values are treated
  like masked values and will be filled with extrapolation before
- interpolation).
+ interpolation). 
+ Note: do not mismatch with (IN/OUT)MISSING_VALUE which are missing value
+ used (in association with (IN/OUT)USEASMASK) to built the mask (that
+ does not change from one record to another).
+ Note: this value will be apply to all interpolated variables
 
     
@@ -654 +705 @@
  IDL> file_interp, filein, fileout, gridout, inxaxisname = 'lo', inyaxisname = 'la', keep = ['lo', 'la', 'cond_sed']
 
- IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, nan_value = -1000.00
+ IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, missing_value = -1000.00
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: file_interp.pro 330 2008-02-01 16:28:24Z smasson $
+ $Id: file_interp.pro 362 2008-07-29 09:00:03Z smasson $
 
     <h4>History</h4>
@@ -673 +724 @@
 
  - perform only horizontal interpolations on scalar fields
- - will fill all masked and missing values before interpolation
+ - all masked and missing values are filled before interpolation
+   -> output data are not masked and have values everywhere.
  - attributes (like valid_min...) are not updated
  - see restrictions of <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a>
+ - output mask is not used but, if the input file contains the mask
+   in a variable (defined by inmaskname), this variable will contain
+   the output mask in the ouput file