Ignore:
Timestamp:
07/12/06 11:52:09 (18 years ago)
Author:
smasson
Message:

update documentation and .idlwave_catalog

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> interpolate data from a "regular/rectangular grid" to any grid. 
    699    2 metods availables: bilinear and imoms3  
    700    A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have  
     698      <div id="file_comments"> 
     699 interpolate data from a "regular/rectangular grid" to any grid. 
     700   2 methods availables: bilinear and imoms3 
     701   A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have 
    701702   the same latitude and each latitudes columns have the same longitude. 
    702    </div> 
     703</div> 
    703704 
    704705       
    … …  
    724725</div> 
    725726 
    726           <h3>Return value</h3><div class="value"> 2D array the interpolated data 
     727          <h3>Return value</h3><div class="preformat"> 
     728 2D array the interpolated data 
    727729</div> 
    728730 
    … …  
    742744            </h4> 
    743745         
    744           <div class="comments">  a string defining the interpolation method.  
    745             must be 'bilinear' or 'imoms3'</div> 
     746          <div class="comments"> 
     747 a string defining the interpolation method. 
     748 must be 'bilinear' or 'imoms3' 
     749</div> 
    746750             
    747751            <h4 id="_fromreg_param_datain">datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    756760            </h4> 
    757761         
    758           <div class="comments">  a 2D array the input data to interpolate</div> 
     762          <div class="comments"> 
     763 a 2D array the input data to interpolate 
     764</div> 
    759765             
    760766            <h4 id="_fromreg_param_lonin">lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    769775            </h4> 
    770776         
    771           <div class="comments">  1D or 2D array defining the longitude of the input data</div> 
     777          <div class="comments"> 
     778 1D or 2D array defining the longitude of the input data 
     779</div> 
    772780             
    773781            <h4 id="_fromreg_param_latin">latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    782790            </h4> 
    783791         
    784           <div class="comments">  1D or 2D array defining the latitude of the input data</div> 
     792          <div class="comments"> 
     793 1D or 2D array defining the latitude of the input data 
     794</div> 
    785795             
    786796            <h4 id="_fromreg_param_lonout">lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    795805            </h4> 
    796806         
    797           <div class="comments">  1D or 2D array defining the longitude of the output data</div> 
     807          <div class="comments"> 
     808 1D or 2D array defining the longitude of the output data 
     809</div> 
    798810             
    799811            <h4 id="_fromreg_param_latout">latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    808820            </h4> 
    809821         
    810           <div class="comments">  1D or 2D array defining the latitude of the output data 
     822          <div class="comments"> 
     823 1D or 2D array defining the latitude of the output data 
    811824</div> 
    812825             
    … …  
    843856         
    844857            <div class="comments"> 2D arrays, weig and addr are the weight and addresses used to 
    845      perform the interpolation: 
     858 perform the interpolation: 
    846859          dataout = total(weig*datain[addr], 1) 
    847860          dataout = reform(dataout, jpio, jpjo, /over) 
    848      Those keywords can be set to named variables (that are undefined or equal to 0) into which the 
    849      values will be copied when the current routine exits. Next, they can be used to perform 
    850      the interpolation whithout computing again those 2 parameters. In that 
    851      case, lonin, latin, lonout and latout are not necessary. 
     861 Those keywords can be set to named variables (that are undefined or equal to 0) into which the 
     862 values will be copied when the current routine exits. Next, they can be used to perform 
     863 the interpolation whithout computing again those 2 parameters. In that 
     864 case, lonin, latin, lonout and latout are not necessary. 
    852865</div> 
    853866             
    … …  
    863876            </h4> 
    864877         
    865             <div class="comments"> </div> 
     878            <div class="comments"></div> 
    866879             
    867880            <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    876889            </h4> 
    877890         
    878             <div class="comments">  
    879  activate if you don't whant to take into account the northen/southern line  
     891            <div class="comments"> 
     892 activate if you don't want to take into account the northen/southern line 
    880893 of the input data when perfoming the interpolation. 
    881894</div> 
    … …  
    883896           
    884897 
    885           <h3>Examples</h3><div class="value">   
    886    
    887   IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit) 
    888  
    889   or  
    890  
    891   IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b) 
    892   IDL> help, a, b 
    893   IDL> t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b) 
     898          <h3>Examples</h3><div class="preformat"> 
     899 
     900 IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit) 
     901 
     902  or 
     903 
     904 IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b) 
     905 IDL> help, a, b 
     906 IDL> t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b) 
    894907</div> 
    895908          <h3>Version history</h3> 
    896909           
    897           <h4>Version</h4><div class="value"> $Id: fromreg.pro 118 2006-06-27 15:47:06Z pinsard $ 
    898 </div> 
    899           <h4>History</h4><div class="value"> 
    900   November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
     910          <h4>Version</h4><div class="preformat"> $Id: fromreg.pro 136 2006-07-10 15:20:19Z pinsard $ 
     911</div> 
     912          <h4>History</h4><div class="preformat"> 
     913  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    901914</div> 
    902915           
    … …  
    906919           
    907920           
    908           <h4>Restrictions</h4><div class="value"> We supposed the data are located on a sphere, with a  
    909  periodicity along the longitude. 
     921          <h4>Restrictions</h4><div class="preformat"> 
     922 We supposed the data are located on a sphere, with a periodicity along the 
     923 longitude. 
    910924</div> 
    911925         
Note: See TracChangeset for help on using the changeset viewer.