Changeset 343 for trunk

Timestamp:

04/10/08 22:14:51 (16 years ago)

Author:

smasson

Message:

small bugfix + new keyword in file_interp

File:

• trunk/SRC/Interpolation/file_interp.pro (modified) (7 diffs)

trunk/SRC/Interpolation/file_interp.pro

@@ -21 +21 @@
       nan_value GT 1.e6:mask = temporary(mask) * (data LT (nan_value-10.))
       nan_value LT -1.e6:mask = temporary(mask) * (data GT (nan_value+10.))
-      abs(nan_value) LT 1.e-6:mask = temporary(mask) * (data GT 1.e-6)
+      abs(nan_value) LT 1.e-6:mask = temporary(mask) * (abs(data) GT 1.e-6)
       ELSE:mask = temporary(mask) * (data NE nan_value)
     ENDCASE
@@ -72 +72 @@
 ; determined through <pro>ncdf_getmask</pro> according to the keywords
 ; outmaskname, outinvmask, outuseasmask, outmissing_value,
-; outaddscl_before (see bellow)
+; outaddscl_before (see bellow).
 ;
 ; @keyword KEEP {type=string array}{default=all variables}
@@ -127 +127 @@
 ;
 ; @keyword INUSEASMASK {type=scalar string}
-; 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)
 ;
 ; @keyword OUTUSEASMASK {type=scalar string}
@@ -140 +142 @@
 ; @keyword INMISSING_VALUE {type=scalar}
 ; To define (or redefine if the attribute is already existing) the
-; missing values used by INUSEASMASK keyword
+; missing values used with INUSEASMASK keyword. Note that this value is
+; not used if INTESTOP keyword is given and contains 2 words.  
 ;
 ; @keyword OUTMISSING_VALUE {type=scalar}
 ; same as inmissing_value but for output mask file maskout
+;
+; @keyword INTESTOP {default='NE'} {type=scalar string, for example 'GT 0.5'}
+; 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 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)
+;
+; @keyword OUTTESTOP {default='NE'} {type=scalar string, for example 'GT 0.5'}
+; same as INTESTOP but for output mask file maskout
 ;
 ; @keyword INADDSCL_BEFORE {default=0}{type=scalar: 0 or 1}
@@ -192 +210 @@
 ;
 ; - 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 <pro>fromreg</pro> and <pro>fromirr</pro>
+; - 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
 ;
 ; @examples
@@ -214 +236 @@
                , SET_XAXISNAME=set_xaxisname, SET_YAXISNAME=set_yaxisname $
                , INMASKNAME=inmaskname, ININVMASK=ininvmask $
-               , INUSEASMASK=inuseasmask $
-               , INMISSING_VALUE=inmissing_value $
-               , INADDSCL_BEFORE=inaddscl_before $
+               , INUSEASMASK=inuseasmask, INMISSING_VALUE=inmissing_value $
+               , INADDSCL_BEFORE=inaddscl_before, INTESTOP = intestop $
                , OUTMASKNAME=outmaskname, OUTINVMASK=outinvmask $
-               , OUTUSEASMASK=outuseasmask $
-               , OUTMISSING_VALUE=outmissing_value $
-               , OUTADDSCL_BEFORE=outaddscl_before $
+               , OUTUSEASMASK=outuseasmask, OUTMISSING_VALUE=outmissing_value $
+               , OUTADDSCL_BEFORE=outaddscl_before, OUTTESTOP = outtestop $
                , NAN_VALUE=NaN_value, WEIG=weig, ADDR=addr $
                , INXAXISNAME=inxaxisname, INYAXISNAME=inyaxisname $
@@ -268 +288 @@
 ;
   inmask = ncdf_getmask(maskin, MASKNAME = inmaskname, INVMASK = ininvmask, USEASMASK = inuseasmask $
-                       , MISSING_VALUE = inmissing_value, ADDSCL_BEFORE = inaddscl_before)
+                       , MISSING_VALUE = inmissing_value, ADDSCL_BEFORE = inaddscl_before, TESTOP = intestop)
   inmasksz = size(inmask, /dimensions)
   IF size(inmask, /n_dimensions) EQ 2 THEN inmasksz = [inmasksz, 0]
   IF n_elements(inmaskname) EQ 0 THEN inmaskname = 'not defined' ; default definition
   outmask = ncdf_getmask(maskout, MASKNAME = outmaskname, INVMASK = outinvmask, USEASMASK = outuseasmask $
-                        , MISSING_VALUE = outmissing_value, ADDSCL_BEFORE = outaddscl_before)
+                        , MISSING_VALUE = outmissing_value, ADDSCL_BEFORE = outaddscl_before, TESTOP = outtestop)
 ;
 ; irregular grids?