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/inrecgrid.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"> given - a list of points, (x,y) position   
    699                 - the x and y limits of a rectangular grid 
    700           find in which cell is located each given point. 
     698      <div id="file_comments"> 
     699 given - a list of points, (x,y) position 
     700       - the x and y limits of a rectangular grid 
     701 find in which cell is located each given point. 
    701702</div> 
    702703 
    … …  
    718719         
    719720          <p class="header"> 
    720             <span class="result">result = </span>inrecgrid(<span class="result"><a href="#_inrecgrid_param_x1d">x1d</a>, <a href="#_inrecgrid_param_y1d">y1d</a>, <a href="#_inrecgrid_param_left">left</a>, <a href="#_inrecgrid_param_bottom">bottom</a></span>, <a href="#_inrecgrid_keyword_output2d">output2d</a>=<span class="result">output2d</span>, <a href="#_inrecgrid_keyword_checkout">checkout</a>=<span class="result">checkout</span>)</p> 
     721            <span class="result">result = </span>inrecgrid(<span class="result"><a href="#_inrecgrid_param_x1d">x1d</a>, <a href="#_inrecgrid_param_y1d">y1d</a>, <a href="#_inrecgrid_param_left">left</a>, <a href="#_inrecgrid_param_bottom">bottom</a></span>, <a href="#_inrecgrid_keyword_OUTPUT2D">OUTPUT2D</a>=<span class="result">OUTPUT2D</span>, <a href="#_inrecgrid_keyword_CHECKOUT">CHECKOUT</a>=<span class="result">CHECKOUT</span>)</p> 
    721722         
    722723          <div class="comments"> 
    723724</div> 
    724725 
    725           <h3>Return value</h3><div class="value"> the index on the cell accoring to the 2d array defined by 
    726  left and bottom. 
     726          <h3>Return value</h3><div class="preformat"> 
     727 the index on the cell according to the 2d array defined by left and bottom. 
    727728</div> 
    728729 
    … …  
    742743            </h4> 
    743744         
    744           <div class="comments">  a 1d array, the x position on the points</div> 
     745          <div class="comments"> 
     746 a 1d array, the x position on the points 
     747</div> 
    745748             
    746749            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    755758            </h4> 
    756759         
    757           <div class="comments">  a 1d array, the y position on the points</div> 
     760          <div class="comments"> 
     761 a 1d array, the y position on the points 
     762</div> 
    758763             
    759764            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    768773            </h4> 
    769774         
    770           <div class="comments"> a 1d, monotonically increasing array,  
    771  the position of the "left" border of each cell.</div> 
     775          <div class="comments"> 
     776 a 1d, monotonically increasing array, 
     777 the position of the "left" border of each cell. 
     778</div> 
    772779             
    773780            <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    782789            </h4> 
    783790         
    784           <div class="comments">  a 1d, monotonically increasing array,  
     791          <div class="comments"> 
     792 a 1d, monotonically increasing array, 
    785793 the position of the "bottom" border of each cell. 
    786794</div> 
    … …  
    793801            <h3>Keywords</h3> 
    794802             
    795             <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     803            <h4 id="_inrecgrid_keyword_OUTPUT2D">OUTPUT2D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    796804               
    797805               
    … …  
    804812            </h4> 
    805813         
    806             <div class="comments"> to get the output as a 2d array (2,n_elements(x1d)), 
    807     with res[0,*] the x index accoring to the 1d array defined by 
    808     left and res[1,*] the y index accoring to the 1d array defined by 
    809    bottom. 
     814            <div class="comments"> 
     815 to get the output as a 2d array (2,n_elements(x1d)), 
     816 with res[0,*] the x index according to the 1d array defined by 
     817 left and res[1,*] the y index according to the 1d array defined by bottom. 
    810818</div> 
    811819             
    812             <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     820            <h4 id="_inrecgrid_keyword_CHECKOUT">CHECKOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    813821               
    814822               
    … …  
    821829            </h4> 
    822830         
    823             <div class="comments">=[rbgrid,ubgrid] specify the right and upper bondaries of 
    824     the grid and check if some points are out. 
     831            <div class="comments"> 
     832 = [rbgrid,ubgrid] specify the right and upper boundaries of 
     833 the grid and check if some points are out. 
    825834</div> 
    826835             
    827836           
    828837 
    829           <h3>Examples</h3><div class="value">  
    830  
    831   IDL> a=indgen(5) 
    832   IDL> b=indgen(7) 
    833   IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b) 
    834   IDL> print, r 
     838          <h3>Examples</h3><div class="preformat"> 
     839 
     840 IDL> a=indgen(5) 
     841 IDL> b=indgen(7) 
     842 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,b) 
     843 IDL> print, r 
    835844            20          13           7 
    836   IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d) 
    837   IDL> print, r 
     845 IDL> r=inrecgrid([0.25,3.25,2],[4.25,2.8,1.4],a,a+1,b,b+1,/output2d) 
     846 IDL> print, r 
    838847        0.00000      4.00000 
    839848        3.00000      2.00000 
    840849        2.00000      1.00000 
    841   </div> 
     850</div> 
    842851          <h3>Version history</h3> 
    843852           
    844           <h4>Version</h4><div class="value"> $Id: inrecgrid.pro 118 2006-06-27 15:47:06Z pinsard $ 
    845 </div> 
    846           <h4>History</h4><div class="value"> 
    847             S. Masson (smasson@lodyc.jussieu.fr) 
    848                       July 3rd, 2002 
    849                       October 3rd, 2003: use value_locate 
     853          <h4>Version</h4><div class="preformat"> $Id: inrecgrid.pro 136 2006-07-10 15:20:19Z pinsard $ 
     854</div> 
     855          <h4>History</h4><div class="preformat"> 
     856 S. Masson (smasson@lodyc.jussieu.fr) 
     857 July 3rd, 2002 
     858 October 3rd, 2003: use value_locate 
    850859</div> 
    851860           
Note: See TracChangeset for help on using the changeset viewer.