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/fromirr.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 an irregular 2D grid to any 2D grid. 
    699    Only 1 metod available = bilinear 
    700    </div> 
     698      <div id="file_comments"> 
     699 interpolate data from an irregular 2D grid to any 2D grid. 
     700   Only 1 method available = bilinear 
     701</div> 
    701702 
    702703       
    … …  
    722723</div> 
    723724 
    724           <h3>Return value</h3><div class="value"> 2D array the interpolated data 
     725          <h3>Return value</h3><div class="preformat"> 
     726 2D array the interpolated data 
    725727</div> 
    726728 
    … …  
    740742            </h4> 
    741743         
    742           <div class="comments"> a string defining the interpolation method. must be 'bilinear'</div> 
     744          <div class="comments"> 
     745 a string defining the interpolation method. must be 'bilinear' 
     746</div> 
    743747             
    744748            <h4 id="_fromirr_param_datain">datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    753757            </h4> 
    754758         
    755           <div class="comments"> a 2D array the input data to interpolate</div> 
     759          <div class="comments"> 
     760 a 2D array the input data to interpolate 
     761</div> 
    756762             
    757763            <h4 id="_fromirr_param_lonin">lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    766772            </h4> 
    767773         
    768           <div class="comments"> a 2D array defining the longitude of the input data</div> 
     774          <div class="comments"> 
     775 a 2D array defining the longitude of the input data 
     776</div> 
    769777             
    770778            <h4 id="_fromirr_param_latin">latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    779787            </h4> 
    780788         
    781           <div class="comments"> a 2D array defining the latitude of the input data.</div> 
     789          <div class="comments"> 
     790 a 2D array defining the latitude of the input data. 
     791</div> 
    782792             
    783793            <h4 id="_fromirr_param_mskin">mskin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    792802            </h4> 
    793803         
    794           <div class="comments"> a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land)</div> 
     804          <div class="comments"> 
     805 a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land) 
     806</div> 
    795807             
    796808            <h4 id="_fromirr_param_lonout">lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    805817            </h4> 
    806818         
    807           <div class="comments"> 1D or 2D array defining the longitude of the output data.</div> 
     819          <div class="comments"> 
     820 1D or 2D array defining the longitude of the output data. 
     821</div> 
    808822             
    809823            <h4 id="_fromirr_param_latout">latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    818832            </h4> 
    819833         
    820           <div class="comments"> 1D or 2D array defining the latitude of the output data.</div> 
     834          <div class="comments"> 
     835 1D or 2D array defining the latitude of the output data. 
     836</div> 
    821837             
    822838            <h4 id="_fromirr_param_mskout">mskout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    831847            </h4> 
    832848         
    833           <div class="comments"> a 2D array, the land-sea mask of the ouput data (1 on ocean, 0 on land) 
     849          <div class="comments"> 
     850 a 2D array, the land-sea mask of the ouput data (1 on ocean, 0 on land) 
    834851</div> 
    835852             
    … …  
    866883         
    867884            <div class="comments"> 2D arrays, weig and addr are the weight and addresses used to 
    868      perform the interpolation: 
     885 perform the interpolation: 
    869886          dataout = total(weig*datain[addr], 1) 
    870887          dataout = reform(dataout, jpio, jpjo, /over) 
    871      Those keywords can be set to named variables (that are undefined or equal to 0) into which the 
    872      values will be copied when the current routine exits. Next, they can be used to perform 
    873      the interpolation whithout computing again those 2 parameters. This greatly 
    874      speed-up the interpolation! In that case, lonin, latin, lonout and latout are not necessary. 
    875 </div> 
    876              
    877            
    878  
    879           <h3>Examples</h3><div class="value"> 
    880    
     888 Those keywords can be set to named variables (that are undefined or equal to 0) into which the 
     889 values will be copied when the current routine exits. Next, they can be used to perform 
     890 the interpolation whithout computing again those 2 parameters. This greatly 
     891 speed-up the interpolation! In that case, lonin, latin, lonout and latout are not necessary. 
     892</div> 
     893             
     894           
     895 
     896          <h3>Examples</h3><div class="preformat"> 
     897 
    881898 IDL> tncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout) 
    882899 
    883   or  
     900  or 
    884901 
    885902 IDL> t1ncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout $ 
    … …  
    890907          <h3>Version history</h3> 
    891908           
    892           <h4>Version</h4><div class="value"> $Id: fromirr.pro 118 2006-06-27 15:47:06Z pinsard $ 
    893 </div> 
    894           <h4>History</h4><div class="value"> 
    895   June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)  
    896  </div> 
     909          <h4>Version</h4><div class="preformat"> $Id: fromirr.pro 136 2006-07-10 15:20:19Z pinsard $ 
     910</div> 
     911          <h4>History</h4><div class="preformat"> 
     912  June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     913</div> 
    897914           
    898915           
    … …  
    901918           
    902919           
    903           <h4>Restrictions</h4><div class="value"> We supposed the data are located on a sphere, with a periodicity along 
    904               the longitude. 
    905               Note that the input data can contain the same cells several times 
    906              (like ORCA grid near the north pole boundary) 
     920          <h4>Restrictions</h4><div class="preformat"> 
     921 We supposed the data are located on a sphere, with a periodicity along 
     922 the longitude. 
     923 Note that the input data can contain the same cells several times 
     924 (like ORCA grid near the north pole boundary) 
    907925</div> 
    908926         
Note: See TracChangeset for help on using the changeset viewer.