Ignore:
Timestamp:
06/29/06 16:59:33 (18 years ago)
Author:
pinsard
Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

Location:
trunk/SRC/Documentation/idldoc_html_output/Interpolation
Files:
18 edited

Legend:

Unmodified
Added
Removed

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

    r119 r121  
    788788               
    789789               
    790                
     790              <span class="attr">default:</span> <span class="value">0</span> 
    791791               
    792792            </h4> 
    … …  
    976976               
    977977               
    978                
     978              <span class="attr">default:</span> <span class="value">0</span> 
    979979               
    980980            </h4> 

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

    r119 r121  
    826826          <h3>Examples</h3><div class="value">  
    827827 
    828      res = clickincell() 
     828   IDL> res = clickincell() 
    829829     Click with the left button to select a cell. Clicking one more 
    830830     time in the same cell remove the cell from the selection. 
    831831     Click on the right button to quit.   
    832832 
    833   
    834  
    835833   IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho 
    836834   IDL> print, clickincell(/draw,color=150,/xy) 

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

    r119 r121  
    722722 
    723723          <h3>Return value</h3><div class="value"> 
    724         - defaut: 3d array(2,n^2,p) giving the center position of each 
     724        - default: 3d array(2,n^2,p) giving the center position of each 
    725725        piece of the parallelograms 
    726726        - /endpoints: 3d array(2,(n+1)^2,p) giving the edge positions 
    … …  
    894894 
    895895          <h3>Examples</h3><div class="value">  
    896  res = cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n) 
    897  
    898   
    899896 
    900897 IDL> x0 = [2,6,2] 

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

    r119 r121  
    722722 
    723723          <h3>Return value</h3><div class="value"> 
    724         defaut: a 3d array (2,n,p) that gives the coordinates of the 
     724        default: a 3d array (2,n,p) that gives the coordinates of the 
    725725        middle of the cutted segments. 
    726726        if /endpoints, a 3d array (2,n+1,p) that gives the 
    … …  
    839839           
    840840 
    841           <h3>Examples</h3><div class="value">   
    842  res = cutsegment(x0, y0, x1, y1, n) 
    843  
    844   
     841          <h3>Examples</h3><div class="value">  
    845842 
    846843  IDL> x0=[2,5] 

  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/directory-overview.html

    r118 r121  
    729729       
    730730        <dt><a href="get_gridparams.html?format=raw">get_gridparams.pro</a></dt> 
    731         <dd>    1) extract from a NetCDF file the longitude, latidude, and their dimensions       and make sure it is 1D or 2D arrays     or 2) given longitude and latitude arrays get their dimensions and make   sure they are 1D or 2D arrays </dd> 
     731        <dd>    1) extract from a NetCDF file the longitude, latidude, and their dimensions       and make sure it is 1D or 2D arrays     or     2) given longitude and latitude arrays get their dimensions and make   sure they are 1D or 2D arrays </dd> 
    732732       
    733733        <dt><a href="imoms3.html?format=raw">imoms3.pro</a></dt> 

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

    r119 r121  
    697697 
    698698      <div id="file_comments"> interpolate data from an irregular 2D grid to any 2D grid. 
    699    Only 1 metod available: bilinear 
     699   Only 1 metod available = bilinear 
    700700   </div> 
    701701 
    … …  
    717717         
    718718          <p class="header"> 
    719             <span class="result">result = </span>fromirr(<span class="result"><a href="#_fromirr_param_method">method</a>, <a href="#_fromirr_param_datain">datain</a>, <a href="#_fromirr_param_lonin">lonin</a>, <a href="#_fromirr_param_latin">latin</a>, <a href="#_fromirr_param_mskin">mskin</a>, <a href="#_fromirr_param_lonout">lonout</a>, <a href="#_fromirr_param_latout">latout</a>, <a href="#_fromirr_param_mskout">mskout</a></span>, <a href="#_fromirr_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromirr_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>)</p> 
     719            <span class="result">result = </span>fromirr(<span class="result"><a href="#_fromirr_param_method">method</a>, <a href="#_fromirr_param_datain">datain</a>[, <a href="#_fromirr_param_lonin">lonin</a>][, <a href="#_fromirr_param_latin">latin</a>][, <a href="#_fromirr_param_mskin">mskin</a>][, <a href="#_fromirr_param_lonout">lonout</a>][, <a href="#_fromirr_param_latout">latout</a>], <a href="#_fromirr_param_mskout">mskout</a></span>, <a href="#_fromirr_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromirr_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>)</p> 
    720720         
    721721          <div class="comments"> 
    722722</div> 
    723723 
    724           <h3>Return value</h3><div class="value"> 2D array: the interpolated data 
     724          <h3>Return value</h3><div class="value"> 2D array the interpolated data 
    725725</div> 
    726726 
    … …  
    758758              <span class="attr">in</span> 
    759759               
    760                
    761               <span class="attr">required</span> 
     760              <span class="attr">optional</span> 
     761               
    762762               
    763763               
    … …  
    771771              <span class="attr">in</span> 
    772772               
    773                
    774               <span class="attr">required</span> 
     773              <span class="attr">optional</span> 
     774               
    775775               
    776776               
    … …  
    784784              <span class="attr">in</span> 
    785785               
    786                
    787               <span class="attr">required</span> 
     786              <span class="attr">optional</span> 
     787               
    788788               
    789789               
    … …  
    797797              <span class="attr">in</span> 
    798798               
    799                
    800               <span class="attr">required</span> 
     799              <span class="attr">optional</span> 
     800               
    801801               
    802802               
    … …  
    810810              <span class="attr">in</span> 
    811811               
    812                
    813               <span class="attr">required</span> 
     812              <span class="attr">optional</span> 
     813               
    814814               
    815815               
    … …  
    877877           
    878878 
    879           <h3>Examples</h3><div class="value">   
    880  dataout = fromirr(method, datain [, lonin, latin, mskin, lonout, latout, mskout]) 
    881  
    882  
     879          <h3>Examples</h3><div class="value"> 
    883880   
    884881 IDL> tncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout) 

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

    r119 r121  
    719719         
    720720          <p class="header"> 
    721             <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>, <a href="#_fromreg_param_lonin">lonin</a>, <a href="#_fromreg_param_latin">latin</a>, <a href="#_fromreg_param_lonout">lonout</a>, <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 
     721            <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>[, <a href="#_fromreg_param_lonin">lonin</a>][, <a href="#_fromreg_param_latin">latin</a>][, <a href="#_fromreg_param_lonout">lonout</a>], <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 
    722722         
    723723          <div class="comments"> 
    724724</div> 
    725725 
    726           <h3>Return value</h3><div class="value"> 2D array: the interpolated data 
     726          <h3>Return value</h3><div class="value"> 2D array the interpolated data 
    727727</div> 
    728728 
    … …  
    761761              <span class="attr">in</span> 
    762762               
    763                
    764               <span class="attr">required</span> 
     763              <span class="attr">optional</span> 
     764               
    765765               
    766766               
    … …  
    774774              <span class="attr">in</span> 
    775775               
    776                
    777               <span class="attr">required</span> 
     776              <span class="attr">optional</span> 
     777               
    778778               
    779779               
    … …  
    787787              <span class="attr">in</span> 
    788788               
    789                
    790               <span class="attr">required</span> 
     789              <span class="attr">optional</span> 
     790               
    791791               
    792792               
    … …  
    884884 
    885885          <h3>Examples</h3><div class="value">   
    886  dataout = fromreg(method, datain [, lonin, latin, lonout, latout]) 
    887  
    888    
    889886   
    890887  IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit) 

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

    r119 r121  
    700700      and make sure it is 1D or 2D arrays 
    701701 
    702    or 2) given longitude and latitude arrays get their dimensions and make 
     702   or  
     703   2) given longitude and latitude arrays get their dimensions and make 
    703704  sure they are 1D or 2D arrays 
    704705</div> 
    … …  
    878879          <h3>Examples</h3><div class="value"> 
    879880 
    880  1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
     881 1)  
     882 IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
    881883 
    882884 or 
    883885 
    884  2) get_gridparams, lon, lat, jpi, jpj, n_dimensions 
     886 2)  
     887 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    885888 
    886889 1) 

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

    r119 r121  
    912912               
    913913               
    914                
    915                
    916             </h4> 
    917          
    918             <div class="comments"> the zoom (circle centred on the (x,y) with a radius of 
    919     zoomradius degree where we look for the the quadrilateral which;    contains the (x,y) point) used for the satellite projection 
    920     when /onsphere is activated. Default is 4 and seems to be the 
    921     minimum which can be used. Can be increase if the cell size is 
    922     larger than 5 degrees. 
     914              <span class="attr">default:</span> <span class="value">4</span> 
     915               
     916            </h4> 
     917         
     918            <div class="comments"> 
     919 the zoom (circle centred on the (x,y) with a radius of 
     920    zoomradius degree where we look for the the quadrilateral which 
     921    contains the (x,y) point) used for the satellite projection 
     922    when /onsphere is activated.  
     923    4 seems to be the minimum which can be used.  
     924    Can be increase if the cell size is larger than 5 degrees. 
    923925   </div> 
    924926             
    … …  
    954956 
    955957          <h3>Examples</h3><div class="value">  
    956  IDL> res = inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4) 
    957  
    958   
    959958 
    960959 IDL> x = 1.*[1, 2, 6, 7, 3] 

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

    r119 r121  
    828828 
    829829          <h3>Examples</h3><div class="value">  
    830  res = inrecgrid(xin, yin, left, bottom) 
    831  
    832   
    833830 
    834831  IDL> a=indgen(5) 

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

    r119 r121  
    826826 
    827827          <h3>Examples</h3><div class="value">  
    828 Result = LL_NARCS_DISTANCES(Lon, lat0, Arc_Dist, Az) 
    829  
    830   
    831 Lon_lat0 = [1.0, 2.0]; Initial point specified in radians 
    832 Arc_Dist = 2.0; Arc distance in radians 
    833 Az = 1.0; Azimuth in radians 
    834 Result = LL_ARC_DISTANCE(Lon_lat0, Arc_Dist, Az) 
    835 PRINT, Result 
     828 IDL> Lon_lat0 = [1.0, 2.0]; Initial point specified in radians 
     829 IDL> Arc_Dist = 2.0; Arc distance in radians 
     830 IDL> Az = 1.0; Azimuth in radians 
     831 IDL> Result = LL_ARC_DISTANCE(Lon_lat0, Arc_Dist, Az) 
     832 IDL> PRINT, Result 
    836833       2.91415    -0.622234 
    837834 

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

    r119 r121  
    839839               
    840840               
    841                
     841              <span class="attr">default:</span> <span class="value">6378206.4d0</span> 
    842842               
    843843            </h4> 
    844844         
    845             <div class="comments"> If given, return the distance between the two points 
    846 calculated using the given radius. 
    847  Default value is the earth radius : 6378206.4d0 
     845            <div class="comments">  
     846 If given, return the distance between the two points calculated using the  
     847 given radius. 
     848 Default value is the Earth radius. 
    848849</div> 
    849850             
    … …  
    879880           
    880881 
    881           <h3>Examples</h3><div class="value">  
    882  IDL> Result = Map_nPoints(lon0, lat0, lon1, lat1) 
    883  
    884  
     882          <h3>Examples</h3><div class="value"> 
    885883 IDL> print, $ 
    886884 map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 

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

    r119 r121  
    835835           
    836836 
    837           <h3>Examples</h3><div class="value">  
    838  IDL> Result = neighbor(lon0, lat0, lon1, lat1) 
    839  
    840  
     837          <h3>Examples</h3><div class="value"> 
    841838       IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $ 
    842839            distance=dis) 

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

    r119 r121  
    904904          <h3>Examples</h3><div class="value">  
    905905 
    906  IDL> res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3,xin,yin) 
    907   
    908   
    909  
    910906 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
    911907 IDL> tracegrille, findgen(11)*.1, findgen(11)*.1,color=indgen(12)*20 

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

    r119 r121  
    801801           
    802802 
    803           <h3>Examples</h3><div class="value">  y2 =  spl_fstdrv(x, y, yscd, x2) 
     803          <h3>Examples</h3><div class="value">  
     804 IDL> y2 =  spl_fstdrv(x, y, yscd, x2) 
    804805</div> 
    805806          <h3>Version history</h3> 

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

    r119 r121  
    847847           
    848848 
    849           <h3>Examples</h3><div class="value"> 
    850  IDL>  y2 =  spl_incr(x, y, x2) 
    851  
    852   
     849          <h3>Examples</h3><div class="value">  
    853850 
    854851 IDL> n = 100L 

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

    r119 r121  
    841841           
    842842 
    843           <h3>Examples</h3><div class="value">  y2 =  spl_keep_mean(x, y, x2) 
    844  
    845   
     843          <h3>Examples</h3><div class="value">  
    846844 
    847845    12 monthly values of precipitations into daily values: 
    848846 
    849    yr1 = 1990 
    850    yr2 = 1992 
    851    nyr = yr2-yr1+1 
    852    n1 = 12*nyr+1 
    853    x = julday(1+findgen(n1), replicate(1, n1) $ 
    854            , replicate(yr1, n1), fltarr(n1)) 
    855    n2 = 365*nyr + total(leapyr(yr1+indgen(nyr))) + 1 
    856    x2 = julday(replicate(1, n2), 1+findgen(n2) $ 
    857                , replicate(yr1, n2), fltarr(n2)) 
    858    y = abs(randomn(0, n1-1)) 
    859    y2 = spl_keep_mean(x, y, x2, /ge0) 
    860  
    861    print, min(x, max = ma), ma 
    862    print, min(x2, max = ma), ma 
    863    print, vairdate([min(x, max = ma), ma]) 
    864    print, total(y*(x[1:n1-1]-x[0:n1-2])) 
    865    print, total(y2*(x2[1:n2-1]-x2[0:n2-2])) 
     847 IDL> yr1 = 1990 
     848 IDL> yr2 = 1992 
     849 IDL> nyr = yr2-yr1+1 
     850 IDL> n1 = 12*nyr+1 
     851 IDL> x = julday(1+findgen(n1), replicate(1, n1) $ 
     852 IDL>        , replicate(yr1, n1), fltarr(n1)) 
     853 IDL> n2 = 365*nyr + total(leapyr(yr1+indgen(nyr))) + 1 
     854 IDL> x2 = julday(replicate(1, n2), 1+findgen(n2) $ 
     855 IDL>            , replicate(yr1, n2), fltarr(n2)) 
     856 IDL> y = abs(randomn(0, n1-1)) 
     857 IDL> y2 = spl_keep_mean(x, y, x2, /ge0) 
     858 
     859 IDL> print, min(x, max = ma), ma 
     860 IDL> print, min(x2, max = ma), ma 
     861 IDL> print, vairdate([min(x, max = ma), ma]) 
     862 IDL> print, total(y*(x[1:n1-1]-x[0:n1-2])) 
     863 IDL> print, total(y2*(x2[1:n2-1]-x2[0:n2-2])) 
    866864</div> 
    867865          <h3>Version history</h3> 

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

    r119 r121  
    721721 
    722722          <h2><a class="top" href="#container">top</a>square2quadrilateral <span class="categories"> image, grid manipulation 
    723 </span></h2> 
     723 
     724 </span></h2> 
    724725         
    725726          <p class="header"> 
    726             <span class="result">result = </span>square2quadrilateral(<span class="result"><a href="#_square2quadrilateral_param_x0in">x0in</a>, <a href="#_square2quadrilateral_param_y0in">y0in</a>, <a href="#_square2quadrilateral_param_x1in">x1in</a>, <a href="#_square2quadrilateral_param_y1in">y1in</a>, <a href="#_square2quadrilateral_param_x2in">x2in</a>, <a href="#_square2quadrilateral_param_y2in">y2in</a>, <a href="#_square2quadrilateral_param_x3in">x3in</a>, <a href="#_square2quadrilateral_param_y3in">y3in</a>, <a href="#_square2quadrilateral_param_xxin">xxin</a>, <a href="#_square2quadrilateral_param_yyin">yyin</a></span>)</p> 
     727            <span class="result">result = </span>square2quadrilateral(<span class="result"><a href="#_square2quadrilateral_param_x0in">x0in</a>, <a href="#_square2quadrilateral_param_y0in">y0in</a>, <a href="#_square2quadrilateral_param_x1in">x1in</a>, <a href="#_square2quadrilateral_param_y1in">y1in</a>, <a href="#_square2quadrilateral_param_x2in">x2in</a>, <a href="#_square2quadrilateral_param_y2in">y2in</a>, <a href="#_square2quadrilateral_param_x3in">x3in</a>, <a href="#_square2quadrilateral_param_y3in">y3in</a>[, <a href="#_square2quadrilateral_param_xxin">xxin</a>][, <a href="#_square2quadrilateral_param_yyin">yyin</a>]</span>)</p> 
    727728         
    728729          <div class="comments"> 
    … …  
    877878              <span class="attr">in</span> 
    878879               
    879                
    880               <span class="attr">required</span> 
     880              <span class="attr">optional</span> 
     881               
    881882               
    882883               
    … …  
    891892              <span class="attr">in</span> 
    892893               
    893                
    894               <span class="attr">required</span> 
     894              <span class="attr">optional</span> 
     895               
    895896               
    896897               
    … …  
    909910 
    910911          <h3>Examples</h3><div class="value">  
    911  IDL>  res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3[,xin,yin]) 
    912   
    913   
    914912 
    915913 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
Note: See TracChangeset for help on using the changeset viewer.