Ignore:
Timestamp:
07/29/08 15:31:00 (16 years ago)
Author:
smasson
Message:

update documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/file_interp.html

    r338 r363  
    109109         
    110110          <p class="header"> 
    111             file_interp<span class="result">, <a href="#_file_interp_param_filein">filein</a>, <a href="#_file_interp_param_fileout">fileout</a>, <a href="#_file_interp_param_gridout">gridout</a></span>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<span class="result">scalar 0 or 1</span>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_NAN_VALUE">NAN_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     111            file_interp<span class="result">, <a href="#_file_interp_param_filein">filein</a>, <a href="#_file_interp_param_fileout">fileout</a>, <a href="#_file_interp_param_gridout">gridout</a></span>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<span class="result">scalar 0 or 1</span>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_INTESTOP">INTESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTTESTOP">OUTTESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_file_interp_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    112112         
    113113          <div class="comments"> 
    … …  
    223223 determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords 
    224224 outmaskname, outinvmask, outuseasmask, outmissing_value, 
    225  outaddscl_before (see bellow) 
     225 outaddscl_before (see below). 
    226226</div> 
    227227             
    … …  
    404404         
    405405            <div class="comments"> 
    406  A string giving the name of the variable in the input mask file maskin 
    407  that will be used to build the land/sea mask. In this case the 
     406 A string giving the name of the variable in the input mask file 
     407 that will be used to build the input land/sea mask. In this case the 
    408408 mask is based on the first record (if record dimension 
    409  exists). The mask is build according to : 
    410     1 the keyword missing_value if existing 
    411     2 the attribute 'missing_value' if existing 
    412     3 NaN values if existing 
     409 exists). The input mask is build according to operator defined by INTESTOP 
     410 keyword (default NE) and the testing values defined as  
     411   1) the second word of TESTOP if existing 
     412   2) MISSING_VALUE keyword 
     413   3) attribute missing_value or _fillvalue of the variable USEASMASK 
     414   4) !Values.f_nan (can be used only with NE and EQ operators) 
    413415</div> 
    414416             
    … …  
    426428            <div class="comments"> 
    427429 To define (or redefine if the attribute is already existing) the 
    428  missing values used by INUSEASMASK keyword 
     430 missing values used with INUSEASMASK keyword to build the input mask. 
     431 Note that this value is not used if INTESTOP keyword is given and 
     432 contains 2 words. 
     433 Note: do not mismatch with MISSING_VALUE used to detect missing 
     434 values at reach record.    
    429435</div> 
    430436             
    … …  
    445451</div> 
    446452             
     453            <h4 id="_file_interp_keyword_INTESTOP">INTESTOP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     454               
     455               
     456               
     457               
     458               
     459              <span class="attr">type:</span> <span class="value">scalar string, for example 'GT 0.5'</span> 
     460              <span class="attr">default:</span> <span class="value">'NE'</span> 
     461               
     462            </h4> 
     463         
     464            <div class="comments"> 
     465 a string describing the type of test that will be done to define the 
     466 input mask. The test is performed on the variable specified by INUSEASMASK 
     467 keyword. 
     468 INTESTOP can contain 1 or 2 words. The first word is the operator 
     469 definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The 
     470 second word define the testing value. If INTESTOP contains only 1 
     471 word, then the test value is denifed by 
     472   1) INMISSING_VALUE keyword 
     473   2) attribute missing_value or _fillvalue of the variable INUSEASMASK 
     474   3) !Values.f_nan (can be used only with NE and EQ operators) 
     475</div> 
     476             
    447477            <h4 id="_file_interp_keyword_OUTMASKNAME">OUTMASKNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    448478               
    … …  
    520550</div> 
    521551             
    522             <h4 id="_file_interp_keyword_NAN_VALUE">NAN_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     552            <h4 id="_file_interp_keyword_OUTTESTOP">OUTTESTOP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     553               
     554               
     555               
     556               
     557               
     558              <span class="attr">type:</span> <span class="value">scalar string, for example 'GT 0.5'</span> 
     559              <span class="attr">default:</span> <span class="value">'NE'</span> 
     560               
     561            </h4> 
     562         
     563            <div class="comments"> 
     564 same as INTESTOP but for output mask file maskout 
     565</div> 
     566             
     567            <h4 id="_file_interp_keyword_MISSING_VALUE">MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    523568               
    524569               
    … …  
    527572               
    528573              <span class="attr">type:</span> <span class="value">scalar</span> 
    529               <span class="attr">default:</span> <span class="value">not used</span> 
    530                
    531             </h4> 
    532          
    533             <div class="comments"> 
    534  define the missing value in input data (missing values are treated 
     574              <span class="attr">default:</span> <span class="value">defined by attribute missing_value or _fillvalue</span> 
     575               
     576            </h4> 
     577         
     578            <div class="comments"> 
     579 (Re)define the missing value in input data (missing values are treated 
    535580 like masked values and will be filled with extrapolation before 
    536  interpolation). 
     581 interpolation).  
     582 Note: do not mismatch with (IN/OUT)MISSING_VALUE which are missing value 
     583 used (in association with (IN/OUT)USEASMASK) to built the mask (that 
     584 does not change from one record to another). 
     585 Note: this value will be apply to all interpolated variables 
    537586</div> 
    538587             
    … …  
    656705 IDL> file_interp, filein, fileout, gridout, inxaxisname = 'lo', inyaxisname = 'la', keep = ['lo', 'la', 'cond_sed'] 
    657706 
    658  IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, nan_value = -1000.00 
     707 IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, missing_value = -1000.00 
    659708</div> 
    660709          <h3>Version history</h3> 
    661710           
    662711          <h4>Version</h4><div class="preformat"> 
    663  $Id: file_interp.pro 330 2008-02-01 16:28:24Z smasson $ 
     712 $Id: file_interp.pro 362 2008-07-29 09:00:03Z smasson $ 
    664713</div> 
    665714          <h4>History</h4><div class="preformat"> 
    … …  
    675724 
    676725 - perform only horizontal interpolations on scalar fields 
    677  - will fill all masked and missing values before interpolation 
     726 - all masked and missing values are filled before interpolation 
     727   -> output data are not masked and have values everywhere. 
    678728 - attributes (like valid_min...) are not updated 
    679729 - see restrictions of <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a> 
     730 - output mask is not used but, if the input file contains the mask 
     731   in a variable (defined by inmaskname), this variable will contain 
     732   the output mask in the ouput file 
    680733</div> 
    681734         
    … …  
    692745          <h3>Statistics</h3> 
    693746          <table class="statistics"> 
    694             <tr><td>McCabe cyclic</td><td>          68</td></tr> 
     747            <tr><td>McCabe cyclic</td><td>          69</td></tr> 
    695748            <tr><td>McCabe essential</td><td>           1</td></tr> 
    696749            <tr><td>McCabe modular design</td><td>           1</td></tr> 
Note: See TracChangeset for help on using the changeset viewer.