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/cutsegment.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"> cut p segments into p*n equal parts 
     698      <div id="file_comments"> 
     699 cut p segments into p*n equal parts 
    699700</div> 
    700701 
     
    716717         
    717718          <p class="header"> 
    718             <span class="result">result = </span>cutsegment(<span class="result"><a href="#_cutsegment_param_x0">x0</a>, <a href="#_cutsegment_param_y0">y0</a>, <a href="#_cutsegment_param_x1">x1</a>, <a href="#_cutsegment_param_y1">y1</a>, <a href="#_cutsegment_param_n">n</a></span>, <a href="#_cutsegment_keyword_endpoints">endpoints</a>=<span class="result">endpoints</span>, <a href="#_cutsegment_keyword_onsphere">onsphere</a>=<span class="result">onsphere</span>)</p> 
     719            <span class="result">result = </span>cutsegment(<span class="result"><a href="#_cutsegment_param_x0">x0</a>, <a href="#_cutsegment_param_y0">y0</a>, <a href="#_cutsegment_param_x1">x1</a>, <a href="#_cutsegment_param_y1">y1</a>, <a href="#_cutsegment_param_n">n</a></span>, <a href="#_cutsegment_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_cutsegment_keyword_ONSPHERE">ONSPHERE</a>=<span class="result">ONSPHERE</span>)</p> 
    719720         
    720721          <div class="comments"> 
    721722</div> 
    722723 
    723           <h3>Return value</h3><div class="value"> 
    724         default: a 3d array (2,n,p) that gives the coordinates of the 
    725         middle of the cutted segments. 
    726         if /endpoints, a 3d array (2,n+1,p) that gives the 
    727         coordinates of the endpoints of the cutted segments. 
     724          <h3>Return value</h3><div class="preformat"> 
     725  - default: a 3d array (2,n,p) that gives the coordinates of the 
     726  middle of the cutted segments. 
     727  - if /ENDPOINTS, a 3d array (2,n+1,p) that gives the 
     728  coordinates of the endpoints of the cutted segments. 
    728729</div> 
    729730 
     
    797798            </h4> 
    798799         
    799           <div class="comments"> the number of pieces we want to cut each segment 
     800          <div class="comments"> 
     801 the number of pieces we want to cut each segment 
    800802</div> 
    801803             
     
    807809            <h3>Keywords</h3> 
    808810             
    809             <h4 id="_cutsegment_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     811            <h4 id="_cutsegment_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    810812               
    811813               
     
    818820            </h4> 
    819821         
    820             <div class="comments"> see ouputs 
     822            <div class="comments"> 
     823 see ouputs 
    821824</div> 
    822825             
    823             <h4 id="_cutsegment_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     826            <h4 id="_cutsegment_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    824827               
    825828               
     
    832835            </h4> 
    833836         
    834             <div class="comments"> to specify that the points are located on a 
    835          sphere. In this case, x and y corresponds to longitude and 
    836          latitude in degrees. 
     837            <div class="comments"> 
     838 to specify that the points are located on a sphere. 
     839 In this case, x and y corresponds to longitude and latitude in degrees. 
    837840</div> 
    838841             
    839842           
    840843 
    841           <h3>Examples</h3><div class="value">  
    842  
    843   IDL> x0=[2,5] 
    844   IDL> y0=[5,1] 
    845   IDL> x1=[9,3] 
    846   IDL> y1=[1,8] 
    847   IDL> res=cutsegment(x0, y0, x1, y1, 10) 
    848   IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata 
    849   IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]] 
    850   IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3 
    851   IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]] 
    852   IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3 
     844          <h3>Examples</h3><div class="preformat"> 
     845 
     846 IDL> x0=[2,5] 
     847 IDL> y0=[5,1] 
     848 IDL> x1=[9,3] 
     849 IDL> y1=[1,8] 
     850 IDL> res=cutsegment(x0, y0, x1, y1, 10) 
     851 IDL> splot, [0,10], [0,10], xstyle = 1, ystyle = 1,/nodata 
     852 IDL> oplot, [x0[0], x1[0]], [y0[0], y1[0]] 
     853 IDL> oplot, [res[0,*,0]], [res[1,*,0]], color = 20, psym = 1, thick = 3 
     854 IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]] 
     855 IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3 
    853856</div> 
    854857          <h3>Version history</h3> 
    855858           
    856           <h4>Version</h4><div class="value"> $Id: cutsegment.pro 118 2006-06-27 15:47:06Z pinsard $ 
    857 </div> 
    858           <h4>History</h4><div class="value"> 
     859          <h4>Version</h4><div class="preformat"> $Id: cutsegment.pro 136 2006-07-10 15:20:19Z pinsard $ 
     860</div> 
     861          <h4>History</h4><div class="preformat"> 
    859862           S. Masson (smasson@lodyc.jussieu.fr) 
    860863           July 5th, 2002 
Note: See TracChangeset for help on using the changeset viewer.