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

update documentation and .idlwave_catalog

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

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/angle.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"> north stereographic polar projection 
     698      <div id="file_comments"> 
     699 north stereographic polar projection 
    699700 
    700701 Compute angles between grid lines and direction of the North 
     
    736737          <div class="comments"></div> 
    737738 
    738           <h3>Return value</h3><div class="value"> 
    739        gsinu,gcosu : sinus and cosinus of the angle  
    740        gsinv,gcosv   between north-south direction  
     739          <h3>Return value</h3><div class="preformat"> 
     740       gsinu,gcosu : sinus and cosinus of the angle 
     741       gsinv,gcosv   between north-south direction 
    741742       gsint,gcost   and the j-direction of the mesh 
    742743</div> 
     
    771772            </h4> 
    772773         
    773           <div class="comments">  
     774          <div class="comments"> 
    774775</div> 
    775776             
     
    792793            </h4> 
    793794         
    794             <div class="comments"> use double precision (default is float) 
     795            <div class="comments"> 
     796 use double precision (default is float) 
    795797</div> 
    796798             
     
    800802          <h3>Version history</h3> 
    801803           
    802           <h4>Version</h4><div class="value"> $Id: angle.pro 118 2006-06-27 15:47:06Z pinsard $ 
    803 </div> 
    804           <h4>History</h4><div class="value"> 
    805    -------------- 
     804          <h4>Version</h4><div class="preformat"> $Id: angle.pro 136 2006-07-10 15:20:19Z pinsard $ 
     805</div> 
     806          <h4>History</h4><div class="preformat"> 
    806807       Original :  96-07 (O. Marti) 
    807808                   98-06 (G. Madec) 
    808        Feb 2005: IDL adaptation S. Masson  
     809       Feb 2005: IDL adaptation S. Masson 
    809810</div> 
    810811           
     
    814815           
    815816           
    816           <h4>Restrictions</h4><div class="value"> to compute the lateral boundary conditions, we assume 
    817  that:  
     817          <h4>Restrictions</h4><div class="preformat"> 
     818 to compute the lateral boundary conditions, we assume that: 
    818819     (1) the first line is similar to the second line 
    819        =>    gcosu[*, 0] = gcosu[*, 1]  
    820        =>    gsinu[*, 0] = gsinu[*, 1]  
     820       =>    gcosu[*, 0] = gcosu[*, 1] 
     821       =>    gsinu[*, 0] = gsinu[*, 1] 
    821822     (2) the grid follows OPA x periodicity rule, first column is 
    822823     equal to the next to last column 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/clickincell.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"> click on a map and find in which cell the click was 
     698      <div id="file_comments"> 
     699 click on a map and find in which cell the click was 
    699700</div> 
    700701 
     
    720721          <div class="comments"></div> 
    721722 
    722           <h3>Return value</h3><div class="value"> 
     723          <h3>Return value</h3><div class="preformat"> 
    723724     the index of the selected cells regarding to the grid which 
    724725     is in memory in the variable of the common. If /ij keyword is 
    725726     activated give 2D array (2, n) which are the i,j position of the 
    726      n selected cells.  
     727     n selected cells. 
    727728</div> 
    728729 
     
    824825           
    825826 
    826           <h3>Examples</h3><div class="value">  
    827  
    828    IDL> res = clickincell() 
     827          <h3>Examples</h3><div class="preformat"> 
     828 
     829 IDL> res = clickincell() 
    829830     Click with the left button to select a cell. Clicking one more 
    830831     time in the same cell remove the cell from the selection. 
    831      Click on the right button to quit.   
    832  
    833    IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho 
    834    IDL> print, clickincell(/draw,color=150,/xy) 
     832     Click on the right button to quit. 
     833 
     834 IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho 
     835 IDL> print, clickincell(/draw,color=150,/xy) 
    835836</div> 
    836837          <h3>Version history</h3> 
    837838           
    838           <h4>Version</h4><div class="value"> $Id: clickincell.pro 118 2006-06-27 15:47:06Z pinsard $ 
    839  
    840 </div> 
    841           <h4>History</h4><div class="value"> 
     839          <h4>Version</h4><div class="preformat"> $Id: clickincell.pro 136 2006-07-10 15:20:19Z pinsard $ 
     840</div> 
     841          <h4>History</h4><div class="preformat"> 
    842842      Sebastien Masson (smasson@lodyc.jussieu.fr) 
    843843      August 2003 
     
    854854           
    855855           
    856           <h4>Uses routines</h4><div class="value"> common.pro 
     856          <h4>Uses routines</h4><div class="preformat"> common.pro 
    857857</div> 
    858858           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromirr_bilinear_weigaddr.html

    r119 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"> compute the weight and address needed to interpolate data from 
    699           an "irregular 2D grid" (defined as a grid made of quadrilateral cells) 
    700           to any grid using the bilinear method 
    701    </div> 
     698      <div id="file_comments"> 
     699 compute the weight and address needed to interpolate data from 
     700 an "irregular 2D grid" (defined as a grid made of quadrilateral cells) 
     701 to any grid using the bilinear method 
     702</div> 
    702703 
    703704       
     
    739740            </h4> 
    740741         
    741           <div class="comments"> longitudeof the input data </div> 
     742          <div class="comments"> 
     743 longitude of the input data 
     744</div> 
    742745             
    743746            <h4 id="_compute_fromirr_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    752755            </h4> 
    753756         
    754           <div class="comments"> latitude of the input data </div> 
     757          <div class="comments"> 
     758 latitude of the input data 
     759</div> 
    755760             
    756761            <h4 id="_compute_fromirr_bilinear_weigaddr_param_omsk">omsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    765770            </h4> 
    766771         
    767           <div class="comments"> land/se mask of the input data </div> 
     772          <div class="comments"> 
     773 land/sea mask of the input data 
     774</div> 
    768775             
    769776            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    778785            </h4> 
    779786         
    780           <div class="comments"> longitude of the output data </div> 
     787          <div class="comments"> 
     788 longitude of the output data 
     789</div> 
    781790             
    782791            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alat">alat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    791800            </h4> 
    792801         
    793           <div class="comments"> latitude of the output data </div> 
     802          <div class="comments"> 
     803 latitude of the output data 
     804</div> 
    794805             
    795806            <h4 id="_compute_fromirr_bilinear_weigaddr_param_amsk">amsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    804815            </h4> 
    805816         
    806           <div class="comments"> land/sea mask of the output data  
     817          <div class="comments"> 
     818 land/sea mask of the output data 
    807819</div> 
    808820             
     
    846858          <h3>Version history</h3> 
    847859           
    848           <h4>Version</h4><div class="value"> $Id: compute_fromirr_bilinear_weigaddr.pro 118 2006-06-27 15:47:06Z pinsard $ 
    849 </div> 
    850           <h4>History</h4><div class="value"> 
    851   June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)  
    852   
     860          <h4>Version</h4><div class="preformat"> $Id: compute_fromirr_bilinear_weigaddr.pro 136 2006-07-10 15:20:19Z pinsard $ 
     861</div> 
     862          <h4>History</h4><div class="preformat"> 
     863  June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    853864</div> 
    854865           
     
    858869           
    859870           
    860           <h4>Restrictions</h4><div class="value"> 
    861   -  the input grid must be an "irregular 2D grid", defined as a grid made  
    862      of quadrilateral cells which corners positions are defined with olonin and olat 
     871          <h4>Restrictions</h4><div class="preformat"> 
     872  -  the input grid must be an "irregular 2D grid", defined as a grid made 
     873  of quadrilateral cells which corners positions are defined with olonin and olat 
    863874  -  We supposed the data are located on a sphere, with a periodicity along 
    864      the longitude 
     875  the longitude 
    865876  -  to perform the bilinear interpolation within quadrilateral cells, we 
    866      first morph the cell into a square cell and then compute the bilinear 
    867      interpolation. 
    868   -  if some corners of the cell are land points, their weight is set to 0  
    869      and the weight is redistributed on the remaining "water" corners 
     877  first morph the cell into a square cell and then compute the bilinear 
     878  interpolation. 
     879  -  if some corners of the cell are land points, their weight is set to 0 
     880  and the weight is redistributed on the remaining "water" corners 
    870881  -  points located out of the southern and northern boundaries or in cells 
    871     containing only land points are set the the same value as their closest neighbor l; </div> 
     882  containing only land points are set the the same value as their closest neighbor l 
     883</div> 
    872884         
    873885           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_bilinear_weigaddr.html

    r119 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"> compute the weight and address needed to interpolate data from a 
    699           "regular grid" to any grid using the bilinear method 
    700    </div> 
     698      <div id="file_comments"> 
     699 compute the weight and address needed to interpolate data from a 
     700 "regular grid" to any grid using the bilinear method 
     701</div> 
    701702 
    702703       
     
    738739            </h4> 
    739740         
    740           <div class="comments"> longitudeof the input data </div> 
     741          <div class="comments"> 
     742 longitude of the input data 
     743</div> 
    741744             
    742745            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    751754            </h4> 
    752755         
    753           <div class="comments"> latitude of the input data </div> 
     756          <div class="comments"> 
     757 latitude of the input data 
     758</div> 
    754759             
    755760            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    764769            </h4> 
    765770         
    766           <div class="comments"> longitude of the output data </div> 
     771          <div class="comments"> 
     772 longitude of the output data 
     773</div> 
    767774             
    768775            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    777784            </h4> 
    778785         
    779           <div class="comments"> latitude of the output data  
     786          <div class="comments"> 
     787 latitude of the output data 
    780788</div> 
    781789             
     
    829837            </h4> 
    830838         
    831             <div class="comments"> activate if you don't whant to take into 
    832           account the northen line of the input data when perfoming the</div> 
     839            <div class="comments"> 
     840 activate if you don't want to take into 
     841 account the northen line of the input data when perfoming the interpolation. 
     842</div> 
    833843             
    834844            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    843853            </h4> 
    844854         
    845             <div class="comments"> activate if you don't whant to take into 
    846           account the southern line of the input data when perfoming the 
    847          interpolation. 
     855            <div class="comments"> 
     856 activate if you don't want to take into 
     857 account the southern line of the input data when perfoming the interpolation. 
    848858</div> 
    849859             
     
    853863          <h3>Version history</h3> 
    854864           
    855           <h4>Version</h4><div class="value"> $Id: compute_fromreg_bilinear_weigaddr.pro 118 2006-06-27 15:47:06Z pinsard $ 
    856 </div> 
    857           <h4>History</h4><div class="value"> 
    858   November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
    859  </div> 
     865          <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_bilinear_weigaddr.pro 136 2006-07-10 15:20:19Z pinsard $ 
     866</div> 
     867          <h4>History</h4><div class="preformat"> 
     868  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     869</div> 
    860870           
    861871           
     
    864874           
    865875           
    866           <h4>Restrictions</h4><div class="value"> 
    867   -  the input grid must be a "regular grid", defined as a grid for which each 
    868      lontitudes lines have the same latitude and each latitudes columns have the 
    869      same longitude. 
    870   -  We supposed the data are located on a sphere, with a periodicity along 
    871      the longitude. 
    872   -  points located out of the southern and northern boundaries are interpolated 
    873      using a linear interpolation only along the longitudinal direction. 
    874  </div> 
     876          <h4>Restrictions</h4><div class="preformat"> 
     877  - the input grid must be a "regular grid", defined as a grid for which each 
     878  lontitudes lines have the same latitude and each latitudes columns have the 
     879  same longitude. 
     880  - We supposed the data are located on a sphere, with a periodicity along 
     881  the longitude. 
     882  - points located out of the southern and northern boundaries are interpolated 
     883  using a linear interpolation only along the longitudinal direction. 
     884</div> 
    875885         
    876886           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_imoms3_weigaddr.html

    r119 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"> compute the weight and address neede to interpolate data from a 
    699           "regular grid" to any grid using the imoms3 method 
    700    </div> 
     698      <div id="file_comments"> 
     699 compute the weight and address neede to interpolate data from a 
     700 "regular grid" to any grid using the imoms3 method 
     701</div> 
    701702 
    702703       
     
    739740            </h4> 
    740741         
    741           <div class="comments"> longitude of the input data </div> 
     742          <div class="comments"> 
     743 longitude of the input data 
     744</div> 
    742745             
    743746            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    752755            </h4> 
    753756         
    754           <div class="comments"> latitude of the input data </div> 
     757          <div class="comments"> 
     758 latitude of the input data 
     759</div> 
    755760             
    756761            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    765770            </h4> 
    766771         
    767           <div class="comments"> longitude of the output data </div> 
     772          <div class="comments"> 
     773 longitude of the output data</div> 
    768774             
    769775            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    778784            </h4> 
    779785         
    780           <div class="comments"> latitude of the output data  
     786          <div class="comments"> 
     787 latitude of the output data 
    781788</div> 
    782789             
     
    830837            </h4> 
    831838         
    832             <div class="comments"> </div> 
     839            <div class="comments"></div> 
    833840             
    834841            <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    843850            </h4> 
    844851         
    845             <div class="comments">  
    846  activate if you don't whant to take into account the northen/southern line  
     852            <div class="comments"> 
     853 activate if you don't want to take into account the northen/southern line 
    847854 of the input data when perfoming the interpolation. 
    848855</div> 
     
    853860          <h3>Version history</h3> 
    854861           
    855           <h4>Version</h4><div class="value"> $Id: compute_fromreg_imoms3_weigaddr.pro 118 2006-06-27 15:47:06Z pinsard $ 
    856 </div> 
    857           <h4>History</h4><div class="value"> 
    858   November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
     862          <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_imoms3_weigaddr.pro 136 2006-07-10 15:20:19Z pinsard $ 
     863</div> 
     864          <h4>History</h4><div class="preformat"> 
     865  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    859866  March 2006: works for rectangular grids 
    860867</div> 
     
    865872           
    866873           
    867           <h4>Restrictions</h4><div class="value"> 
    868   -  the input grid must be a "regular/rectangular grid", defined as a grid for 
    869      which each lontitudes lines have the same latitude and each latitudes columns 
    870      have the same longitude. 
     874          <h4>Restrictions</h4><div class="preformat"> 
     875  - the input grid must be a "regular/rectangular grid", defined as a grid for 
     876  which each lontitudes lines have the same latitude and each latitudes columns 
     877  have the same longitude. 
    871878  -  We supposed the data are located on a sphere, with a periodicity along 
    872      the longitude. 
     879  the longitude. 
    873880  -  points located between the first/last 2 lines are interpolated 
    874      using a imoms3 interpolation along the longitudinal direction and linear 
    875      interpolation along the latitudinal direction 
    876   -  points located out of the southern and northern boundaries are interpolated 
    877      using a imoms3 interpolation only along the longitudinal direction. 
    878  </div> 
     881  using a imoms3 interpolation along the longitudinal direction and linear 
     882  interpolation along the latitudinal direction 
     883  - points located out of the southern and northern boundaries are interpolated 
     884  using a imoms3 interpolation only along the longitudinal direction. 
     885</div> 
    879886         
    880887           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutpar.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 parallelogram(s) into p*n^2 parallelograms 
     698      <div id="file_comments"> 
     699 cut p parallelogram(s) into p*n^2 parallelograms 
    699700</div> 
    700701 
     
    716717         
    717718          <p class="header"> 
    718             <span class="result">result = </span>cutpar(<span class="result"><a href="#_cutpar_param_x0">x0</a>, <a href="#_cutpar_param_y0">y0</a>, <a href="#_cutpar_param_x1">x1</a>, <a href="#_cutpar_param_y1">y1</a>, <a href="#_cutpar_param_x2">x2</a>, <a href="#_cutpar_param_y2">y2</a>, <a href="#_cutpar_param_x3">x3</a>, <a href="#_cutpar_param_y3">y3</a>, <a href="#_cutpar_param_n">n</a></span>, <a href="#_cutpar_keyword_endpoints">endpoints</a>=<span class="result">endpoints</span>, <a href="#_cutpar_keyword_onsphere">onsphere</a>=<span class="result">onsphere</span>)</p> 
     719            <span class="result">result = </span>cutpar(<span class="result"><a href="#_cutpar_param_x0">x0</a>, <a href="#_cutpar_param_y0">y0</a>, <a href="#_cutpar_param_x1">x1</a>, <a href="#_cutpar_param_y1">y1</a>, <a href="#_cutpar_param_x2">x2</a>, <a href="#_cutpar_param_y2">y2</a>, <a href="#_cutpar_param_x3">x3</a>, <a href="#_cutpar_param_y3">y3</a>, <a href="#_cutpar_param_n">n</a></span>, <a href="#_cutpar_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_cutpar_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: 3d array(2,n^2,p) giving the center position of each 
    725         piece of the parallelograms 
    726         - /endpoints: 3d array(2,(n+1)^2,p) giving the edge positions 
    727         of each piece of the parallelograms 
     724          <h3>Return value</h3><div class="preformat"> 
     725  - default: a 3d array(2,n^2,p) giving the center position of each 
     726  piece of the parallelograms 
     727  - if /ENDPOINTS : a 3d array(2,(n+1)^2,p) giving the edge positions 
     728  of each piece of the parallelograms 
    728729</div> 
    729730 
     
    756757            </h4> 
    757758         
    758           <div class="comments"> </div> 
     759          <div class="comments"></div> 
    759760             
    760761            <h4 id="_cutpar_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    782783            </h4> 
    783784         
    784           <div class="comments"> </div> 
     785          <div class="comments"></div> 
    785786             
    786787            <h4 id="_cutpar_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    808809            </h4> 
    809810         
    810           <div class="comments"> </div> 
     811          <div class="comments"></div> 
    811812             
    812813            <h4 id="_cutpar_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    834835            </h4> 
    835836         
    836           <div class="comments">  
    837  1d arrays of p elements, giving the edge positions. The 
    838        edges must be given as in plot to traw the parallelogram. (see 
    839        example). 
     837          <div class="comments"> 
     838 1d arrays of p elements, giving the edge positions. 
     839 The edges must be given as in plot to draw the parallelogram. (see example). 
    840840</div> 
    841841             
     
    851851            </h4> 
    852852         
    853           <div class="comments"> each parallelogram will be cutted in n^2 pieces 
     853          <div class="comments"> 
     854 each parallelogram will be cutted in n^2 pieces 
    854855</div> 
    855856             
     
    861862            <h3>Keywords</h3> 
    862863             
    863             <h4 id="_cutpar_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     864            <h4 id="_cutpar_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    864865               
    865866               
     
    872873            </h4> 
    873874         
    874             <div class="comments"> see outputs 
    875 </div> 
    876              
    877             <h4 id="_cutpar_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     875            <div class="comments"> 
     876 see outputs 
     877</div> 
     878             
     879            <h4 id="_cutpar_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    878880               
    879881               
     
    886888            </h4> 
    887889         
    888             <div class="comments"> to specify that the points are located on a 
    889          sphere. In this case, x and y corresponds to longitude and 
    890          latitude in degrees. 
    891 </div> 
    892              
    893            
    894  
    895           <h3>Examples</h3><div class="value">  
     890            <div class="comments"> 
     891 to specify that the points are located on a 
     892 sphere. In this case, x and y corresponds to longitude and 
     893 latitude in degrees. 
     894</div> 
     895             
     896           
     897 
     898          <h3>Examples</h3><div class="preformat"> 
    896899 
    897900 IDL> x0 = [2,6,2] 
     
    911914          <h3>Version history</h3> 
    912915           
    913           <h4>Version</h4><div class="value"> $Id: cutpar.pro 118 2006-06-27 15:47:06Z pinsard $ 
    914 </div> 
    915           <h4>History</h4><div class="value"> 
     916          <h4>Version</h4><div class="preformat"> $Id: cutpar.pro 136 2006-07-10 15:20:19Z pinsard $ 
     917</div> 
     918          <h4>History</h4><div class="preformat"> 
    916919           S. Masson (smasson@lodyc.jussieu.fr) 
    917920           July 5th, 2002 
     
    928931           
    929932           
    930           <h4>Uses routines</h4><div class="value"> cutsegment.pro 
     933          <h4>Uses routines</h4><div class="preformat"> cutsegment.pro 
    931934</div> 
    932935           
  • 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 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/directory-overview.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%; 
     
    699699       
    700700        <dt><a href="angle.html?format=raw">angle.pro</a></dt> 
    701         <dd> north stereographic polar projection   Compute angles between grid lines and direction of the North (fom angle.</dd> 
     701        <dd>  north stereographic polar projection   Compute angles between grid lines and direction of the North (fom angle.</dd> 
    702702       
    703703        <dt><a href="clickincell.html?format=raw">clickincell.pro</a></dt> 
    704         <dd> click on a map and find in which cell the click was </dd> 
     704        <dd>  click on a map and find in which cell the click was </dd> 
    705705       
    706706        <dt><a href="compute_fromirr_bilinear_weigaddr.html?format=raw">compute_fromirr_bilinear_weigaddr.pro</a></dt> 
    707         <dd> compute the weight and address needed to interpolate data from           an "irregular 2D grid" (defined as a grid made of quadrilateral cells)           to any grid using the bilinear method    </dd> 
     707        <dd>  compute the weight and address needed to interpolate data from  an "irregular 2D grid" (defined as a grid made of quadrilateral cells)  to any grid using the bilinear method </dd> 
    708708       
    709709        <dt><a href="compute_fromreg_bilinear_weigaddr.html?format=raw">compute_fromreg_bilinear_weigaddr.pro</a></dt> 
    710         <dd> compute the weight and address needed to interpolate data from a           "regular grid" to any grid using the bilinear method    </dd> 
     710        <dd>  compute the weight and address needed to interpolate data from a  "regular grid" to any grid using the bilinear method </dd> 
    711711       
    712712        <dt><a href="compute_fromreg_imoms3_weigaddr.html?format=raw">compute_fromreg_imoms3_weigaddr.pro</a></dt> 
    713         <dd> compute the weight and address neede to interpolate data from a           "regular grid" to any grid using the imoms3 method    </dd> 
     713        <dd>  compute the weight and address neede to interpolate data from a  "regular grid" to any grid using the imoms3 method </dd> 
    714714       
    715715        <dt><a href="cutpar.html?format=raw">cutpar.pro</a></dt> 
    716         <dd> cut p parallelogram(s) into p*n^2 parallelograms </dd> 
     716        <dd>  cut p parallelogram(s) into p*n^2 parallelograms </dd> 
    717717       
    718718        <dt><a href="cutsegment.html?format=raw">cutsegment.pro</a></dt> 
    719         <dd> cut p segments into p*n equal parts </dd> 
     719        <dd>  cut p segments into p*n equal parts </dd> 
    720720       
    721721        <dt><a href="extrapolate.html?format=raw">extrapolate.pro</a></dt> 
    722         <dd> extrapolate data (zinput) where maskinput eq 0 by filling   step by step the coastline points with the mean value of the 8 neighbourgs.</dd> 
     722        <dd>  extrapolate data (zinput) where maskinput eq 0 by filling  step by step the coastline points with the mean value of the 8 neighbourgs.</dd> 
    723723       
    724724        <dt><a href="fromirr.html?format=raw">fromirr.pro</a></dt> 
    725         <dd> interpolate data from an irregular 2D grid to any 2D grid.</dd> 
     725        <dd>  interpolate data from an irregular 2D grid to any 2D grid.</dd> 
    726726       
    727727        <dt><a href="fromreg.html?format=raw">fromreg.pro</a></dt> 
    728         <dd> interpolate data from a "regular/rectangular grid" to any grid.</dd> 
     728        <dd>  interpolate data from a "regular/rectangular grid" to any grid.</dd> 
    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> 
     
    735735       
    736736        <dt><a href="inquad.html?format=raw">inquad.pro</a></dt> 
    737         <dd> to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) </dd> 
     737        <dd>  to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) </dd> 
    738738       
    739739        <dt><a href="inrecgrid.html?format=raw">inrecgrid.pro</a></dt> 
    740         <dd> given - a list of points, (x,y) position                   - the x and y limits of a rectangular grid           find in which cell is located each given point.</dd> 
     740        <dd>  given - a list of points, (x,y) position        - the x and y limits of a rectangular grid  find in which cell is located each given point.</dd> 
    741741       
    742742        <dt><a href="ll_narcs_distances.html?format=raw">ll_narcs_distances.pro</a></dt> 
    743         <dd>  This function returns the longitude and latitude [lon, lat] of a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), from a specified location Lon0, lat0.</dd> 
     743        <dd>  This function returns the longitude and latitude [lon, lat] of  a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), from a specified location Lon0, lat0.</dd> 
    744744       
    745745        <dt><a href="map_npoints.html?format=raw">map_npoints.pro</a></dt> 
    746         <dd> Return the distance in meter between all np0 points P0 and all        np1 points P1 on a sphere.</dd> 
     746        <dd>  Return the distance in meter between all np0 points P0 and all  np1 points P1 on a sphere.</dd> 
    747747       
    748748        <dt><a href="neighbor.html?format=raw">neighbor.pro</a></dt> 
    749         <dd> find the closetest point of (P0) within a list of np1 points P1 Which can be on a sphere </dd> 
     749        <dd>  find the closetest point of (P0) within a list of np1 points  P1 Which can be on a sphere </dd> 
    750750       
    751751        <dt><a href="quadrilateral2square.html?format=raw">quadrilateral2square.pro</a></dt> 
    752         <dd> warm (or map) an arbitrary quadrilateral onto a unit square   according to the 4-point correspondences:        (x0,y0) -> (0,0)        (x1,y1) -> (1,0)        (x2,y2) -> (1,1)        (x3,y3) -> (0,1)  This is the inverse function of square2quadrilateral.</dd> 
     752        <dd>  warm (or map) an arbitrary quadrilateral onto a unit square  according to the 4-point correspondences:        (x0,y0) -> (0,0)        (x1,y1) -> (1,0)        (x2,y2) -> (1,1)        (x3,y3) -> (0,1)  This is the inverse function of square2quadrilateral.</dd> 
    753753       
    754754        <dt><a href="spl_fstdrv.html?format=raw">spl_fstdrv.pro</a></dt> 
    755         <dd> SPL_FSTDRV returns the values of the first derivative of  the interpolating function at the points X2i.</dd> 
     755        <dd>  SPL_FSTDRV returns the values of the first derivative of  the interpolating function at the points X2i.</dd> 
    756756       
    757757        <dt><a href="spl_incr.html?format=raw">spl_incr.pro</a></dt> 
     
    762762       
    763763        <dt><a href="square2quadrilateral.html?format=raw">square2quadrilateral.pro</a></dt> 
    764         <dd> warm (or map) a unit square onto an arbitrary quadrilateral  according to the 4-point correspondences:        (0,0) -> (x0,y0)        (1,0) -> (x1,y1)        (1,1) -> (x2,y2)        (0,1) -> (x3,y3)  The mapping is done using perspective transformation which preserve  lines in all orientations and permit quadrilateral to quadrilateral  mappings.</dd> 
     764        <dd>  warm (or map) a unit square onto an arbitrary quadrilateral  according to the 4-point correspondences:        (0,0) -> (x0,y0)        (1,0) -> (x1,y1)        (1,1) -> (x2,y2)        (0,1) -> (x3,y3)  The mapping is done using perspective transformation which preserve  lines in all orientations and permit quadrilateral to quadrilateral  mappings.</dd> 
    765765       
    766766      </dl> 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/extrapolate.html

    r119 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"> extrapolate data (zinput) where maskinput eq 0 by filling  
     698      <div id="file_comments"> 
     699 extrapolate data (zinput) where maskinput eq 0 by filling 
    699700 step by step the coastline points with the mean value of the 8 neighbourgs. 
    700701</div> 
     
    822823          <h3>Version history</h3> 
    823824           
    824           <h4>Version</h4><div class="value"> $Id: extrapolate.pro 118 2006-06-27 15:47:06Z pinsard $ 
     825          <h4>Version</h4><div class="preformat"> $Id: extrapolate.pro 136 2006-07-10 15:20:19Z pinsard $ 
    825826</div> 
    826827           
  • 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         
  • 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         
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/get_gridparams.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%; 
     
    697697 
    698698      <div id="file_comments"> 
    699    1) extract from a NetCDF file the longitude, latidude, and their dimensions 
    700       and make sure it is 1D or 2D arrays 
    701  
    702    or  
    703    2) given longitude and latitude arrays get their dimensions and make 
    704   sure they are 1D or 2D arrays 
     699 1) extract from a NetCDF file the longitude, latidude, and their dimensions 
     700 and make sure it is 1D or 2D arrays 
     701 
     702 or 
     703 2) given longitude and latitude arrays get their dimensions and make 
     704 sure they are 1D or 2D arrays 
    705705</div> 
    706706 
     
    744744            </h4> 
    745745         
    746           <div class="comments"> the name of the netcdf file 
     746          <div class="comments"> 
     747 the name of the netcdf file 
     748 
     749 
    747750 1d or 2D arrays defining longitudes and latitudes. 
    748  the variable that will contain the longitudes</div> 
     751 
     752 
     753 the variable that will contain the longitudes 
     754</div> 
    749755             
    750756            <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    759765            </h4> 
    760766         
    761           <div class="comments"> the name of the variable that contains the longitude in the NetCDF file 
     767          <div class="comments"> 
     768 the name of the variable that contains the longitude in the NetCDF file 
     769 
     770 
    762771 1d or 2D arrays defining longitudes and latitudes. 
    763     Note that these arrays are also outputs and can therefore be modified. 
    764  
    765  the variable that will contain the latitudes</div> 
     772 Note that these arrays are also outputs and can therefore be modified. 
     773 
     774 
     775 the variable that will contain the latitudes 
     776</div> 
    766777             
    767778            <h4 id="_get_gridparams_param_in3">in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    776787            </h4> 
    777788         
    778           <div class="comments"> the name of the variable that contains the latitude in the NetCDF file 
    779  the number of points in the longitudinal direction</div> 
     789          <div class="comments"> 
     790 the name of the variable that contains the latitude in the NetCDF file 
     791 
     792 
     793 the number of points in the longitudinal direction 
     794</div> 
    780795             
    781796            <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    790805            </h4> 
    791806         
    792           <div class="comments"> the number of points in the longitudinal direction 
    793  the number of points in the latitudinal direction</div> 
     807          <div class="comments"> 
     808 the number of points in the longitudinal direction 
     809 
     810 
     811 the number of points in the latitudinal direction 
     812</div> 
    794813             
    795814            <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    804823            </h4> 
    805824         
    806           <div class="comments"> the number of points in the latitudinal direction 
     825          <div class="comments"> 
     826 the number of points in the latitudinal direction 
     827 
     828 
    807829 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    808     arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    809     grid must be regular (each longitudes must be the same for all latitudes 
    810     and each latitudes should be the sae for all longitudes). 
     830 arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
     831 grid must be regular (each longitudes must be the same for all latitudes 
     832 and each latitudes should be the sae for all longitudes). 
    811833</div> 
    812834             
     
    822844            </h4> 
    823845         
    824           <div class="comments"> the variable that will contain the longitudes</div> 
     846          <div class="comments"> 
     847 the variable that will contain the longitudes 
     848</div> 
    825849             
    826850            <h4 id="_get_gridparams_param_in7">in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    835859            </h4> 
    836860         
    837           <div class="comments"> the variable that will contain the latitudes</div> 
     861          <div class="comments"> 
     862 the variable that will contain the latitudes 
     863</div> 
    838864             
    839865            <h4 id="_get_gridparams_param_in8">in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    848874            </h4> 
    849875         
    850           <div class="comments"> 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     876          <div class="comments"> 
     877 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    851878 
    852879 or 
     
    872899            </h4> 
    873900         
    874             <div class="comments"> use double precision to perform the computation 
    875 </div> 
    876              
    877            
    878  
    879           <h3>Examples</h3><div class="value"> 
    880  
    881  1)  
     901            <div class="comments"> 
     902 use double precision to perform the computation 
     903</div> 
     904             
     905           
     906 
     907          <h3>Examples</h3><div class="preformat"> 
     908 
     909 1) 
    882910 IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
    883911 
    884912 or 
    885913 
    886  2)  
     914 2) 
    887915 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    888916 
     
    897925          <h3>Version history</h3> 
    898926           
    899           <h4>Version</h4><div class="value"> $Id: get_gridparams.pro 118 2006-06-27 15:47:06Z pinsard $ 
    900 </div> 
    901           <h4>History</h4><div class="value"> 
     927          <h4>Version</h4><div class="preformat"> $Id: get_gridparams.pro 136 2006-07-10 15:20:19Z pinsard $ 
     928</div> 
     929          <h4>History</h4><div class="preformat"> 
    902930  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    903931</div> 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/imoms3.html

    r119 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%; 
     
    717717         
    718718          <div class="comments"> 
    719   
    720  </div> 
     719 
     720</div> 
    721721 
    722722           
     
    748748          <h3>Version history</h3> 
    749749           
    750           <h4>Version</h4><div class="value"> $Id: imoms3.pro 118 2006-06-27 15:47:06Z pinsard $ 
     750          <h4>Version</h4><div class="preformat"> $Id: imoms3.pro 134 2006-07-07 10:19:08Z navarro $ 
    751751</div> 
    752752           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/inquad.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"> to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) 
     698      <div id="file_comments"> 
     699 to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) 
    699700</div> 
    700701 
     
    720721          <div class="comments"></div> 
    721722 
    722           <h3>Return value</h3><div class="value"> 
    723     a n element vector. Where n is the number of elements of 
    724     x. res[i]=j means that the point number i is located in the 
    725     quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
     723          <h3>Return value</h3><div class="preformat"> 
     724 a n element vector. Where n is the number of elements of 
     725 x. res[i]=j means that the point number i is located in the 
     726 quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
    726727</div> 
    727728 
     
    755756         
    756757          <div class="comments"> 
    757   the coordinates of the point we want to know where it is.  
    758   Must be a scalar if /onsphere activated else can be scalar or array.  
     758 the coordinates of the point we want to know where it is. 
     759 Must be a scalar if /ONSPHERE activated else can be scalar or array. 
    759760</div> 
    760761             
     
    862863         
    863864          <div class="comments"> 
    864   the coordinates of the quadrilateral given in the CLOCKWISE order.  
    865   Scalar or array. 
     865 the coordinates of the quadrilateral given in the CLOCKWISE order. 
     866 Scalar or array. 
    866867</div> 
    867868             
     
    884885            </h4> 
    885886         
    886             <div class="comments"> to specify that the quadilateral are on a sphere and 
    887     that teir coordinates are longitude-latitude coordinates. In this 
    888     case, est-west periodicity, poles singularity and other pbs 
    889     related to longitude-latitude coordinates are managed 
    890     automatically.  
     887            <div class="comments"> 
     888 to specify that the quadilateral are on a sphere and 
     889 that teir coordinates are longitude-latitude coordinates. In this 
     890 case, est-west periodicity, poles singularity and other pbs 
     891 related to longitude-latitude coordinates are managed 
     892 automatically. 
    891893</div> 
    892894             
     
    902904            </h4> 
    903905         
    904             <div class="comments"> use double precision to perform the computation  
     906            <div class="comments"> 
     907 use double precision to perform the computation 
    905908</div> 
    906909             
     
    918921            <div class="comments"> 
    919922 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. 
    925    </div> 
     923 zoomradius degree where we look for the the quadrilateral which 
     924 contains the (x,y) point) used for the satellite projection 
     925 when /ONSPHERE is activated. 
     926 4 seems to be the minimum which can be used. 
     927 Can be increase if the cell size is larger than 5 degrees. 
     928</div> 
    926929             
    927930            <h4 id="_inquad_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    936939            </h4> 
    937940         
    938             <div class="comments"> to suppress the print messages. 
     941            <div class="comments"> 
     942 to suppress the print messages. 
    939943</div> 
    940944             
     
    955959           
    956960 
    957           <h3>Examples</h3><div class="value">  
     961          <h3>Examples</h3><div class="preformat"> 
    958962 
    959963 IDL> x = 1.*[1, 2, 6, 7, 3] 
     
    972976 IDL> print, inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4) 
    973977 
    974       On a sphere see clickincell.pro... 
     978 On a sphere see clickincell.pro... 
    975979</div> 
    976980          <h3>Version history</h3> 
    977981           
    978           <h4>Version</h4><div class="value"> $Id: inquad.pro 118 2006-06-27 15:47:06Z pinsard $ 
    979 </div> 
    980           <h4>History</h4><div class="value"> 
     982          <h4>Version</h4><div class="preformat"> $Id: inquad.pro 136 2006-07-10 15:20:19Z pinsard $ 
     983</div> 
     984          <h4>History</h4><div class="preformat"> 
    981985      Sebastien Masson (smasson@lodyc.jussieu.fr) 
    982986      August 2003 
    983       Based on Convert_clic_ij.pro written by Gurvan Madec  
     987      Based on Convert_clic_ij.pro written by Gurvan Madec 
    984988</div> 
    985989           
     
    989993           
    990994           
    991           <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
    992  twisted) is not work. This has to be tested. 
     995          <h4>Restrictions</h4><div class="preformat"> 
     996 I think degenerated quadrilateral (e.g. flat of twisted) is not work. 
     997 This has to be tested. 
    993998</div> 
    994999         
  • 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           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/ll_narcs_distances.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%; 
     
    698698      <div id="file_comments"> 
    699699 This function returns the longitude and latitude [lon, lat] of 
    700 a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    701 from a specified location Lon0, lat0. 
    702        Same as LL_ARC_DISTANCE but for n points without do loop. 
    703  
    704  
    705 Formula from Map Projections - a working manual.  USGS paper 
    706 1395.  Equations (5-5) and (5-6). 
     700 a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
     701 from a specified location Lon0, lat0. 
     702 Same as LL_ARC_DISTANCE but for n points without do loop. 
     703 
     704 Formula from Map Projections - a working manual.  USGS paper 
     705 1395. Equations (5-5) and (5-6). 
    707706</div> 
    708707 
     
    729728</div> 
    730729 
    731           <h3>Return value</h3><div class="value"> 
    732  a (2, n) array containing the  
    733        longitude / latitude of the resultings points. Values are in radians 
    734        unless the keyword DEGREES is set. 
     730          <h3>Return value</h3><div class="preformat"> 
     731 a (2, n) array containing the longitude/latitude of the resultings points. 
     732 Values are in radians unless the keyword DEGREES is set. 
    735733</div> 
    736734 
     
    750748            </h4> 
    751749         
    752           <div class="comments">  An array containing the longitude of the starting point. 
    753              Values are assumed to be in radians unless the keyword 
    754              DEGREES is set.</div> 
     750          <div class="comments"> 
     751 An array containing the longitude of the starting point. 
     752 Values are assumed to be in radians unless the keyword DEGREES is set. 
     753</div> 
    755754             
    756755            <h4 id="_LL_NARCS_DISTANCES_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    765764            </h4> 
    766765         
    767           <div class="comments">  An array containing the latitude of the starting point. 
    768              Values are assumed to be in radians unless the keyword 
    769              DEGREES is set.</div> 
     766          <div class="comments"> 
     767 An array containing the latitude of the starting point. 
     768 Values are assumed to be in radians unless the keyword DEGREES is set. 
     769</div> 
    770770             
    771771            <h4 id="_LL_NARCS_DISTANCES_param_arc_dist">arc_dist&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    780780            </h4> 
    781781         
    782           <div class="comments">  The arc distance from Lon_lat0. The value must be between 
     782          <div class="comments"> 
     783 The arc distance from Lon_lat0. The value must be between 
    783784 -!PI and +!PI. To express distances in arc units, divide 
    784785  by the radius of the globe expressed in the original units. 
    785786  For example, if the radius of the earth is 6371 km, divide 
    786   the distance in km by 6371 to obtain the arc distance.    </div> 
     787  the distance in km by 6371 to obtain the arc distance. 
     788</div> 
    787789             
    788790            <h4 id="_LL_NARCS_DISTANCES_param_az">az&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    797799            </h4> 
    798800         
    799           <div class="comments">   The azimuth from Lon_lat0. The value is assumed to be in 
    800   radians unless the keyword DEGREES is set. 
     801          <div class="comments"> 
     802 The azimuth from Lon_lat0. The value is assumed to be in 
     803 radians unless the keyword DEGREES is set. 
    801804</div> 
    802805             
     
    819822            </h4> 
    820823         
    821             <div class="comments">  Set this keyword to express all measurements and 
    822   results in degrees. 
     824            <div class="comments"> 
     825 Set this keyword to express all measurements and results in degrees. 
    823826</div> 
    824827             
    825828           
    826829 
    827           <h3>Examples</h3><div class="value">  
     830          <h3>Examples</h3><div class="preformat"> 
    828831 IDL> Lon_lat0 = [1.0, 2.0]; Initial point specified in radians 
    829832 IDL> Arc_Dist = 2.0; Arc distance in radians 
     
    833836       2.91415    -0.622234 
    834837 
    835 IDL> lon0 = [-10, 20, 100] 
    836 IDL> lat0 = [0, -10, 45] 
    837 IDL> lon1 = [10, 60, 280] 
    838 IDL> lat1 = [0, 10, 45] 
    839 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
    840 IDL> earthradius = 6378206.4d0 
    841 IDL> res = ll_narcs_distances(lon0, lat0, dist/earthradius, azi, /degrees) 
    842 IDL> print, reform(res[0, *]) 
     838 IDL> lon0 = [-10, 20, 100] 
     839 IDL> lat0 = [0, -10, 45] 
     840 IDL> lon1 = [10, 60, 280] 
     841 IDL> lat1 = [0, 10, 45] 
     842 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
     843 IDL> earthradius = 6378206.4d0 
     844 IDL> res = ll_narcs_distances(lon0, lat0, dist/earthradius, azi, /degrees) 
     845 IDL> print, reform(res[0, *]) 
    843846       10.000000       60.000000       280.00000 
    844 IDL> print, reform(res[1, *]) 
    845           1.1999280e-15       10.000000       45.000000 
     847 IDL> print, reform(res[1, *]) 
     848           1.1999280e-15       10.000000       45.000000 
    846849</div> 
    847850          <h3>Version history</h3> 
    848851           
    849           <h4>Version</h4><div class="value"> $Id: ll_narcs_distances.pro 118 2006-06-27 15:47:06Z pinsard $ 
    850 </div> 
    851           <h4>History</h4><div class="value"> 
     852          <h4>Version</h4><div class="preformat"> $Id: ll_narcs_distances.pro 136 2006-07-10 15:20:19Z pinsard $ 
     853</div> 
     854          <h4>History</h4><div class="preformat"> 
    852855       Based on the IDL function ll_arc_distance.pro,v 1.11 2003/02/03 
    853856 Sebastien Masson (smasson@lodyc.jussieu.fr) 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/map_npoints.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%; 
     
    697697 
    698698      <div id="file_comments"> 
    699 Return the distance in meter between all np0 points P0 and all 
    700        np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then 
    701        returns the distances between number n of P0 points and number 
    702        n of P1 points (in that case, np0 and np1 must be equal). 
    703        Same as map_2points with the meter parameter but for n points 
    704        without do loop. 
     699 Return the distance in meter between all np0 points P0 and all 
     700 np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then 
     701 returns the distances between number n of P0 points and number 
     702 n of P1 points (in that case, np0 and np1 must be equal). 
     703 Same as map_2points with the meter parameter but for n points 
     704 without do loop. 
    705705</div> 
    706706 
     
    722722         
    723723          <p class="header"> 
    724             <span class="result">result = </span>Map_npoints(<span class="result"><a href="#_Map_npoints_param_lon0">lon0</a>, <a href="#_Map_npoints_param_lat0">lat0</a>, <a href="#_Map_npoints_param_lon1">lon1</a>, <a href="#_Map_npoints_param_lat1">lat1</a></span>, <a href="#_Map_npoints_keyword_azimuth">azimuth</a>=<span class="result">azimuth</span>, <a href="#_Map_npoints_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>, <a href="#_Map_npoints_keyword_RADIUS">RADIUS</a>=<span class="result">RADIUS</span>, <a href="#_Map_npoints_keyword_MIDDLE">MIDDLE</a>=<span class="result">MIDDLE</span>, <a href="#_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO</a>=<span class="result">TWO_BY_TWO</span>)</p> 
     724            <span class="result">result = </span>Map_npoints(<span class="result"><a href="#_Map_npoints_param_lon0">lon0</a>, <a href="#_Map_npoints_param_lat0">lat0</a>, <a href="#_Map_npoints_param_lon1">lon1</a>, <a href="#_Map_npoints_param_lat1">lat1</a></span>, <a href="#_Map_npoints_keyword_AZIMUTH">AZIMUTH</a>=<span class="result">AZIMUTH</span>, <a href="#_Map_npoints_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>, <a href="#_Map_npoints_keyword_RADIUS">RADIUS</a>=<span class="result">RADIUS</span>, <a href="#_Map_npoints_keyword_MIDDLE">MIDDLE</a>=<span class="result">MIDDLE</span>, <a href="#_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO</a>=<span class="result">TWO_BY_TWO</span>)</p> 
    725725         
    726726          <div class="comments"> 
    727727</div> 
    728728 
    729           <h3>Return value</h3><div class="value"> 
    730        An (np0,np1) array giving the distance in meter between np0 
    731        points P0 and np1 points P1. Element (i,j) of the ouput is the 
    732        distance between element P0[i] and P1[j]. 
    733        If keyword /TWO_BY_TWO is given then Map_nPoints returns 
    734        an np-element vector giving the distance in meter between P0[i] 
    735        and P1[i] (in that case, we have np0 = np1 = np) 
    736        if /MIDDLE see this keyword. 
    737 </div> 
     729          <h3>Return value</h3><div class="preformat"> 
     730 An (np0,np1) array giving the distance in meter between np0 
     731 points P0 and np1 points P1. Element (i,j) of the ouput is the 
     732 distance between element P0[i] and P1[j]. 
     733 If keyword /TWO_BY_TWO is given then Map_nPoints returns 
     734 an np-element vector giving the distance in meter between P0[i] 
     735 and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword.</div> 
    738736 
    739737           
     
    765763            </h4> 
    766764         
    767           <div class="comments">  
    768  np0 elements vector. longitudes and latitudes of np0 points P0  
     765          <div class="comments"> 
     766 np0 elements vector. longitudes and latitudes of np0 points P0 
    769767</div> 
    770768             
     
    793791            </h4> 
    794792         
    795           <div class="comments">   
    796  np1 elements vector. longitude and latitude of np1 points P1  
     793          <div class="comments"> 
     794 np1 elements vector. longitude and latitude of np1 points P1 
    797795</div> 
    798796             
     
    804802            <h3>Keywords</h3> 
    805803             
    806             <h4 id="_Map_npoints_keyword_azimuth">azimuth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     804            <h4 id="_Map_npoints_keyword_AZIMUTH">AZIMUTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    807805               
    808806               
     
    815813            </h4> 
    816814         
    817             <div class="comments"> A named variable that will receive the azimuth of the great 
    818        circle  connecting the two points, P0 to P1</div> 
     815            <div class="comments"> 
     816 A named variable that will receive the azimuth of the great 
     817 circle connecting the two points, P0 to P1 
     818</div> 
    819819             
    820820            <h4 id="_Map_npoints_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    829829            </h4> 
    830830         
    831             <div class="comments"> if set, inputs and angular outputs are in radians, otherwise 
    832 degrees.</div> 
     831            <div class="comments"> 
     832 if set, inputs and angular outputs are in radians, otherwise degrees. 
     833</div> 
    833834             
    834835            <h4 id="_Map_npoints_keyword_RADIUS">RADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    843844            </h4> 
    844845         
    845             <div class="comments">  
    846  If given, return the distance between the two points calculated using the  
     846            <div class="comments"> 
     847 If given, return the distance between the two points calculated using the 
    847848 given radius. 
    848849 Default value is the Earth radius. 
     
    860861            </h4> 
    861862         
    862             <div class="comments"> to get the longitude/latitude of the middle point betwen P0 and P1.</div> 
     863            <div class="comments"> 
     864 to get the longitude/latitude of the middle point betwen P0 and P1. 
     865</div> 
    863866             
    864867            <h4 id="_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    873876            </h4> 
    874877         
    875             <div class="comments"> If given,then Map_nPoints returns the distances between 
    876        number n of P0 points and number n of P1 points (in that case, 
    877        np0 and np1 must be equal). 
    878 </div> 
    879              
    880            
    881  
    882           <h3>Examples</h3><div class="value"> 
     878            <div class="comments"> 
     879 If given,then Map_nPoints returns the distances between number n of 
     880 P0 points and number n of P1 points 
     881 In that case, np0 and np1 must be equal. 
     882</div> 
     883             
     884           
     885 
     886          <h3>Examples</h3><div class="preformat"> 
    883887 IDL> print, $ 
    884  map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
    885        7551369.3      5600334.8 
    886        12864354.      10921254. 
    887        14919237.      5455558.8 
     888 IDL> map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
     889 7551369.3 5600334.8 
     890 12864354. 10921254. 
     891 14919237. 5455558.8 
    888892 
    889893 IDL> lon0 = [-10, 20, 100] 
     
    891895 IDL> lon1 = [10, 60, 280] 
    892896 IDL> lat1 = [0, 10, 45] 
    893  IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi) 
     897 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi) 
    894898 IDL> help, dist, azi 
    895  DIST            DOUBLE    = Array[3, 3] 
    896  AZI             DOUBLE    = Array[3, 3] 
     899 DIST DOUBLE = Array[3, 3] 
     900 AZI DOUBLE = Array[3, 3] 
    897901 IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)] 
    898        2226414.0       4957944.5      10018863. 
    899        90.000000       64.494450  4.9615627e-15 
    900  IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
     902 2226414.0 4957944.5 10018863. 
     903 90.000000 64.494450 4.9615627e-15 
     904 IDL> dist = map_npoints(lon0, lat0, lon1, lat1, AZIMUTH = azi, /TWO_BY_TWO) 
    901905 IDL> help, dist, azi 
    902  DIST            DOUBLE    = Array[3] 
    903  AZI             DOUBLE    = Array[3] 
     906 DIST DOUBLE = Array[3] 
     907 AZI DOUBLE = Array[3] 
    904908 IDL> print, dist, azi 
    905        2226414.0       4957944.5      10018863. 
    906        90.000000       64.494450  4.9615627e-15 
     909 2226414.0 4957944.5 10018863. 
     910 90.000000 64.494450 4.9615627e-15 
    907911 IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0]) 
    908        20.000000      90.000000 
    909  IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], azi=azi)/6378206.4d0 / !dtor, azi 
    910        20.000000 
    911        90.000000 
     912 20.000000 90.000000 
     913 IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], AZIMUTH=azi)/6378206.4d0 / !dtor, azi 
     914 20.000000 
     915 90.000000 
    912916 
    913917 IDL> lon0 = [-10, 20, 100] 
     
    915919 IDL> lon1 = [10, 60, 280] 
    916920 IDL> lat1 = [0, 10, 45] 
    917  IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /middle, /two_by_two) 
     921 IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /MIDDLE, /TWO_BY_TWO) 
    918922 IDL> print, reform(mid[0,*]), reform(mid[1,*]) 
    919        0.0000000       40.000000      190.00000 
    920        0.0000000  -1.5902773e-15      90.000000 
     923 0.0000000 40.000000 190.00000 
     924 0.0000000 -1.5902773e-15 90.000000 
    921925 IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1] 
    922        0.0000000      0.0000000 
     926 0.0000000 0.0000000 
    923927 IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1] 
    924        40.000000 -1.5902773e-15 
     928 40.000000 -1.5902773e-15 
    925929 IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1] 
    926        190.00000      90.000000 
     930 190.00000 90.000000 
    927931</div> 
    928932          <h3>Version history</h3> 
    929933           
    930           <h4>Version</h4><div class="value"> $Id: map_npoints.pro 118 2006-06-27 15:47:06Z pinsard $ 
    931 </div> 
    932           <h4>History</h4><div class="value"> 
    933        Based on the IDL function map_2points.pro,v 1.6 2001/01/15 
     934          <h4>Version</h4><div class="preformat"> $Id: map_npoints.pro 136 2006-07-10 15:20:19Z pinsard $ 
     935</div> 
     936          <h4>History</h4><div class="preformat"> 
     937 Based on the IDL function map_2points.pro,v 1.6 2001/01/15 
    934938 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    935                   October 2003 
     939 October 2003 
    936940</div> 
    937941           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/neighbor.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%; 
     
    697697 
    698698      <div id="file_comments"> 
    699 find the closetest point of (P0) within a list of np1 points 
    700 P1 Which can be on a sphere  
     699 find the closetest point of (P0) within a list of np1 points 
     700 P1 Which can be on a sphere 
    701701</div> 
    702702 
     
    723723</div> 
    724724 
    725           <h3>Return value</h3><div class="value"> 
    726        index giving the P1[index] point that is the closest point of (P0) 
     725          <h3>Return value</h3><div class="preformat"> 
     726 index giving the P1[index] point that is the closest point of (P0) 
    727727</div> 
    728728 
     
    742742            </h4> 
    743743         
    744           <div class="comments">  scalar. longitudes of point P0. </div> 
     744          <div class="comments"> 
     745 scalar. longitudes of point P0. 
     746</div> 
    745747             
    746748            <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    755757            </h4> 
    756758         
    757           <div class="comments">  scalar. latitudes of point P0. </div> 
     759          <div class="comments"> 
     760 scalar. latitudes of point P0. 
     761</div> 
    758762             
    759763            <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    768772            </h4> 
    769773         
    770           <div class="comments"> </div> 
     774          <div class="comments"> 
     775</div> 
    771776             
    772777            <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    781786            </h4> 
    782787         
    783           <div class="comments">  
     788          <div class="comments"> 
    784789</div> 
    785790             
     
    816821            </h4> 
    817822         
    818             <div class="comments"> dis, to get back the distances between P0 and the np1 
    819    points P1 in the variable dis.</div> 
     823            <div class="comments"> 
     824 dis, to get back the distances between P0 and the np1 points P1 in the 
     825 variable dis. 
     826</div> 
    820827             
    821828            <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    830837            </h4> 
    831838         
    832             <div class="comments"> if set, inputs and angular outputs are in radians, otherwise 
    833 degrees.</div> 
     839            <div class="comments"> 
     840 if set, inputs and angular outputs are in radians, otherwise degrees. 
     841</div> 
    834842             
    835843           
    836844 
    837           <h3>Examples</h3><div class="value"> 
    838        IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $ 
    839            distance=dis) 
     845          <h3>Examples</h3><div class="preformat"> 
     846 IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $ 
     847 IDL> distance=dis) 
    840848                  0 
    841        IDL> print, dis 
     849 IDL> print, dis 
    842850             105.684      206.125      160.228 
    843851</div> 
    844852          <h3>Version history</h3> 
    845853           
    846           <h4>Version</h4><div class="value"> $Id: neighbor.pro 118 2006-06-27 15:47:06Z pinsard $ 
    847 </div> 
    848           <h4>History</h4><div class="value"> 
     854          <h4>Version</h4><div class="preformat"> $Id: neighbor.pro 136 2006-07-10 15:20:19Z pinsard $ 
     855</div> 
     856          <h4>History</h4><div class="preformat"> 
    849857 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    850858                  October 2003 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/quadrilateral2square.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"> warm (or map) an arbitrary quadrilateral onto a unit square  
     698      <div id="file_comments"> 
     699 warm (or map) an arbitrary quadrilateral onto a unit square 
    699700 according to the 4-point correspondences: 
    700701       (x0,y0) -> (0,0) 
     
    730731</div> 
    731732 
    732           <h3>Return value</h3><div class="value"> 
    733  
    734      (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
    735      point(s) after mapping.  
    736      If xin is a scalar, then n is equal to the number of elements of 
    737      x0. If xin is an array , then n is equal to the number of 
    738      elements of xin. 
     733          <h3>Return value</h3><div class="preformat"> 
     734 
     735 (2,n) array: the new coodinates (xout, yout) of the (xin,yin) point(s) after 
     736 mapping. 
     737 If xin is a scalar, then n is equal to the number of elements of x0. 
     738 If xin is an array , then n is equal to the number of elements of xin. 
    739739</div> 
    740740 
     
    863863            </h4> 
    864864         
    865           <div class="comments"> the coordinates of the point(s) for which we want to do the mapping. Can be scalar or array.</div> 
     865          <div class="comments"> 
     866 the coordinates of the point(s) for which we want to do the mapping. 
     867 Can be scalar or array. 
     868</div> 
    866869             
    867870            <h4 id="_quadrilateral2square_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    876879            </h4> 
    877880         
    878           <div class="comments"> the coordinates of the point(s) for which we want to do the mapping. Can be scalar or array. 
     881          <div class="comments"> 
     882 the coordinates of the point(s) for which we want to do the mapping. 
     883 Can be scalar or array. 
    879884</div> 
    880885             
     
    902907           
    903908 
    904           <h3>Examples</h3><div class="value">  
     909          <h3>Examples</h3><div class="preformat"> 
    905910 
    906911 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
     
    916921          <h3>Version history</h3> 
    917922           
    918           <h4>Version</h4><div class="value"> $Id: quadrilateral2square.pro 118 2006-06-27 15:47:06Z pinsard $ 
    919 </div> 
    920           <h4>History</h4><div class="value"> 
     923          <h4>Version</h4><div class="preformat"> $Id: quadrilateral2square.pro 136 2006-07-10 15:20:19Z pinsard $ 
     924</div> 
     925          <h4>History</h4><div class="preformat"> 
    921926      Sebastien Masson (smasson@lodyc.jussieu.fr) 
    922927      August 2003 
     
    924929      IEEE Computer Society Press, Los Alamitos, California 
    925930      Chapter 3, see p 52-56 
    926        
     931 
    927932</div> 
    928933           
     
    932937           
    933938           
    934           <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
    935  twisted) is not work. This has to be tested. 
     939          <h4>Restrictions</h4><div class="preformat"> 
     940 I think degenerated quadrilateral (e.g. flat of twisted) is not work. 
     941 This has to be tested. 
    936942</div> 
    937943         
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_fstdrv.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"> SPL_FSTDRV returns the values of the first derivative of 
     698      <div id="file_comments"> 
     699 SPL_FSTDRV returns the values of the first derivative of 
    699700 the interpolating function at the points X2i. it is a double 
    700701 precision array. 
     
    728729</div> 
    729730 
    730           <h3>Return value</h3><div class="value">  
    731  
    732     y2: f'(x2) = y2.  
     731          <h3>Return value</h3><div class="preformat"> 
     732 
     733    y2: f'(x2) = y2. 
    733734</div> 
    734735 
     
    748749            </h4> 
    749750         
    750           <div class="comments">  An n-element (at least 2) input vector that specifies the 
    751     tabulate points in ascending order. 
     751          <div class="comments"> 
     752 An n-element (at least 2) input vector that specifies the 
     753 tabulate points in ascending order. 
    752754</div> 
    753755             
     
    763765            </h4> 
    764766         
    765           <div class="comments">  f(x) = y. An n-element input vector that specifies the values 
    766     of the tabulated function F(Xi) corresponding to Xi. 
     767          <div class="comments"> 
     768 f(x) = y. An n-element input vector that specifies the values 
     769 of the tabulated function F(Xi) corresponding to Xi. 
    767770</div> 
    768771             
     
    778781            </h4> 
    779782         
    780           <div class="comments">  The output from SPL_INIT for the specified X and Y. 
     783          <div class="comments"> 
     784 The output from SPL_INIT for the specified X and Y. 
    781785</div> 
    782786             
     
    792796            </h4> 
    793797         
    794           <div class="comments">  The input values for which the first derivative values are 
    795     desired. X can be scalar or an array of values. 
     798          <div class="comments"> 
     799 The input values for which the first derivative values are desired. 
     800 X can be scalar or an array of values. 
    796801</div> 
    797802             
     
    801806           
    802807 
    803           <h3>Examples</h3><div class="value">  
     808          <h3>Examples</h3><div class="preformat"> 
    804809 IDL> y2 =  spl_fstdrv(x, y, yscd, x2) 
    805810</div> 
    806811          <h3>Version history</h3> 
    807812           
    808           <h4>Version</h4><div class="value"> $Id: spl_fstdrv.pro 118 2006-06-27 15:47:06Z pinsard $ 
    809 </div> 
    810           <h4>History</h4><div class="value"> 
     813          <h4>Version</h4><div class="preformat"> $Id: spl_fstdrv.pro 134 2006-07-07 10:19:08Z navarro $ 
     814</div> 
     815          <h4>History</h4><div class="preformat"> 
    811816  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005 
    812817</div> 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_incr.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%; 
     
    743743</div> 
    744744 
    745           <h3>Return value</h3><div class="value">  
     745          <h3>Return value</h3><div class="preformat"> 
    746746 
    747747    y2: f(x2) = y2. Double precision array 
     
    763763            </h4> 
    764764         
    765           <div class="comments">   
    766  An n-element (at least 2) input vector that specifies the tabulate points in  
     765          <div class="comments"> 
     766 An n-element (at least 2) input vector that specifies the tabulate points in 
    767767 a strict ascending order. 
    768768</div> 
     
    779779            </h4> 
    780780         
    781           <div class="comments">   
     781          <div class="comments"> 
    782782 The input values for which the interpolated values are 
    783  desired. Its values must be strictly monotonically increasing.  
     783 desired. Its values must be strictly monotonically increasing. 
    784784</div> 
    785785             
     
    795795            </h4> 
    796796         
    797           <div class="comments">   
     797          <div class="comments"> 
    798798 f(x) = y. An n-element input vector that specifies the values 
    799     of the tabulated function F(Xi) corresponding to Xi. As f is 
    800     supposed to be monotonically increasing, y values must be 
    801     monotonically increasing. y can have equal consecutive values. 
     799 of the tabulated function F(Xi) corresponding to Xi. As f is 
     800 supposed to be monotonically increasing, y values must be 
     801 monotonically increasing. y can have equal consecutive values. 
    802802</div> 
    803803             
     
    826826            </h4> 
    827827         
    828           <div class="comments"></div> 
     828          <div class="comments"> 
     829</div> 
    829830             
    830831            <h4 id="_pure_concave_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    839840            </h4> 
    840841         
    841           <div class="comments">  
    842 </div> 
    843              
    844  
    845            
    846  
    847            
    848  
    849           <h3>Examples</h3><div class="value">  
     842          <div class="comments"> 
     843</div> 
     844             
     845 
     846           
     847 
     848           
     849 
     850          <h3>Examples</h3><div class="preformat"> 
    850851 
    851852 IDL> n = 100L 
    852  IDL> x = (dindgen(n))^2  
     853 IDL> x = (dindgen(n))^2 
    853854 IDL> y = abs(randomn(0, n)) 
    854855 IDL> y[n/2:n/2+1] = 0. 
     
    863864 IDL> oplot, x2, y2, color = 100 
    864865 IDL> c = y2[1:n2-1] - y2[0:n2-2] 
    865  IDL> print, min(c) LT 0  
     866 IDL> print, min(c) LT 0 
    866867 IDL> print, min(c, max = ma), ma 
    867868 IDL> splot,c,xstyle=1,ystyle=1, yrange=[-.01,.05], ysurx=.25, petit = [1, 2, 2], /noerase 
     
    870871          <h3>Version history</h3> 
    871872           
    872           <h4>Version</h4><div class="value"> $Id: spl_incr.pro 118 2006-06-27 15:47:06Z pinsard $ 
    873 </div> 
    874           <h4>History</h4><div class="value"> 
     873          <h4>Version</h4><div class="preformat"> $Id: spl_incr.pro 136 2006-07-10 15:20:19Z pinsard $ 
     874</div> 
     875          <h4>History</h4><div class="preformat"> 
    875876  Sebastien Masson (smasson@lodyc.jussieu.fr): May-Dec 2005 
    876877</div> 
     
    881882           
    882883           
    883           <h4>Restrictions</h4><div class="value"> 
    884    It might be possible that y2[i+1]-y2[i] has very small negative 
    885    values (amplitude smaller than 1.e-6)... 
     884          <h4>Restrictions</h4><div class="preformat"> 
     885 It might be possible that y2[i+1]-y2[i] has very small negative 
     886 values (amplitude smaller than 1.e-6)... 
    886887</div> 
    887888         
     
    925926            </h4> 
    926927         
    927           <div class="comments">   
    928  An n-element (at least 2) input vector that specifies the tabulate points in  
     928          <div class="comments"> 
     929 An n-element (at least 2) input vector that specifies the tabulate points in 
    929930 a strict ascending order. 
    930931</div> 
     
    941942            </h4> 
    942943         
    943           <div class="comments">   
     944          <div class="comments"> 
    944945 The input values for which the interpolated values are 
    945  desired. Its values must be strictly monotonically increasing.  
     946 desired. Its values must be strictly monotonically increasing. 
    946947</div> 
    947948             
     
    957958            </h4> 
    958959         
    959           <div class="comments">   
     960          <div class="comments"> 
    960961 f(x) = y. An n-element input vector that specifies the values 
    961962    of the tabulated function F(Xi) corresponding to Xi. As f is 
     
    10011002            </h4> 
    10021003         
    1003           <div class="comments">  
     1004          <div class="comments"> 
    10041005</div> 
    10051006             
     
    11241125            <div class="comments"> The first derivative of the interpolating function at the 
    11251126    point Xn-1. If YPN_1 is omitted, the second derivative at the 
    1126     boundary is set to zero, resulting in a "natural spline." </div> 
     1127    boundary is set to zero, resulting in a "natural spline."</div> 
    11271128             
    11281129           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_keep_mean.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%; 
     
    728728          <div class="comments"></div> 
    729729 
    730           <h3>Return value</h3><div class="value">  
    731  
    732     y2: the meean value between two consecutive values of x2. This 
    733     array has one element less than y2. y2 has double precision. 
     730          <h3>Return value</h3><div class="preformat"> 
     731 y2: the mean value between two consecutive values of x2. This 
     732 array has one element less than y2. y2 has double precision. 
    734733</div> 
    735734 
     
    749748            </h4> 
    750749         
    751           <div class="comments">  An n-element (at least 2) input vector that specifies the 
    752     tabulate points in a strict ascending order. 
     750          <div class="comments"> 
     751 An n-element (at least 2) input vector that specifies the tabulate points in 
     752 a strict ascending order. 
    753753</div> 
    754754             
     
    764764            </h4> 
    765765         
    766           <div class="comments">  an array with one element less than x. y[i] represents the 
    767     mean value between x[i] and x[i+1]. if /GE0 is activated, y must 
    768     have positive values. 
     766          <div class="comments"> 
     767 an array with one element less than x. y[i] represents the 
     768 mean value between x[i] and x[i+1]. if /GE0 is activated, y must 
     769 have positive values. 
    769770</div> 
    770771             
     
    780781            </h4> 
    781782         
    782           <div class="comments">  The input values for which the interpolated values are 
    783     desired. Its values must be strictly monotonically increasing.  
    784  
     783          <div class="comments"> 
     784 The input values for which the interpolated values are desired. 
     785 Its values must be strictly monotonically increasing. 
    785786</div> 
    786787             
     
    803804            </h4> 
    804805         
    805             <div class="comments"> The first derivative of the interpolating function at the 
    806     point X0. If YP0 is omitted, the second derivative at the 
    807     boundary is set to zero, resulting in a "natural spline." 
     806            <div class="comments"> 
     807 The first derivative of the interpolating function at the 
     808 point X0. If YP0 is omitted, the second derivative at the 
     809 boundary is set to zero, resulting in a "natural spline." 
    808810</div> 
    809811             
     
    819821            </h4> 
    820822         
    821             <div class="comments"> The first derivative of the interpolating function at the 
    822     point Xn-1. If YPN_1 is omitted, the second derivative at the 
    823     boundary is set to zero, resulting in a "natural spline."  
     823            <div class="comments"> 
     824 The first derivative of the interpolating function at the 
     825 point Xn-1. If YPN_1 is omitted, the second derivative at the 
     826 boundary is set to zero, resulting in a "natural spline." 
    824827</div> 
    825828             
     
    835838            </h4> 
    836839         
    837             <div class="comments"> to force that y2 is always GE than 0. In that case, y must 
    838    also be GE than 0. 
     840            <div class="comments"> 
     841 to force that y2 is always GE than 0. In that case, y must also be GE than 0. 
    839842</div> 
    840843             
    841844           
    842845 
    843           <h3>Examples</h3><div class="value">  
     846          <h3>Examples</h3><div class="preformat"> 
    844847 
    845848    12 monthly values of precipitations into daily values: 
     
    865868          <h3>Version history</h3> 
    866869           
    867           <h4>Version</h4><div class="value"> $Id: spl_keep_mean.pro 118 2006-06-27 15:47:06Z pinsard $ 
    868 </div> 
    869           <h4>History</h4><div class="value"> 
     870          <h4>Version</h4><div class="preformat"> $Id: spl_keep_mean.pro 136 2006-07-10 15:20:19Z pinsard $ 
     871</div> 
     872          <h4>History</h4><div class="preformat"> 
    870873  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005 
    871874</div> 
     
    876879           
    877880           
    878           <h4>Restrictions</h4><div class="value"> 
    879    It might be possible that y2 has very small negative values 
    880    (amplitude smaller than 1.e-6)...  
    881  
     881          <h4>Restrictions</h4><div class="preformat"> 
     882 It might be possible that y2 has very small negative values 
     883 (amplitude smaller than 1.e-6)... 
    882884</div> 
    883885         
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/square2quadrilateral.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"> warm (or map) a unit square onto an arbitrary quadrilateral 
     698      <div id="file_comments"> 
     699 warm (or map) a unit square onto an arbitrary quadrilateral 
    699700 according to the 4-point correspondences: 
    700701       (0,0) -> (x0,y0) 
     
    721722 
    722723          <h2><a class="top" href="#container">top</a>square2quadrilateral <span class="categories"> image, grid manipulation 
    723  
    724  </span></h2> 
     724</span></h2> 
    725725         
    726726          <p class="header"> 
     
    730730</div> 
    731731 
    732           <h3>Return value</h3><div class="value"> 
    733  
    734      (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
    735      point(s) after mapping.  
    736      If xin is a scalar, then n is equal to the number of elements of 
    737      x0. If xin is an array , then n is equal to the number of 
    738      elements of xin. 
    739      If xin and yin are omited, square2quadrilateral returns the 
    740      matrix A which is used for the inverse transformation.  
    741  
     732          <h3>Return value</h3><div class="preformat"> 
     733 (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
     734 point(s) after mapping. 
     735 If xin is a scalar, then n is equal to the number of elements of 
     736 x0. If xin is an array , then n is equal to the number of 
     737 elements of xin. 
     738 If xin and yin are omited, square2quadrilateral returns the 
     739 matrix A which is used for the inverse transformation. 
    742740</div> 
    743741 
     
    757755            </h4> 
    758756         
    759           <div class="comments">  the coordinates of the quadrilateral 
    760      (see above for correspondance with the unit square). Can be 
    761      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    762      given in the anticlockwise order.</div> 
     757          <div class="comments"></div> 
    763758             
    764759            <h4 id="_square2quadrilateral_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    773768            </h4> 
    774769         
    775           <div class="comments">  the coordinates of the quadrilateral 
    776      (see above for correspondance with the unit square). Can be 
    777      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    778      given in the anticlockwise order.</div> 
     770          <div class="comments"></div> 
    779771             
    780772            <h4 id="_square2quadrilateral_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    789781            </h4> 
    790782         
    791           <div class="comments">  the coordinates of the quadrilateral 
    792      (see above for correspondance with the unit square). Can be 
    793      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    794      given in the anticlockwise order.</div> 
     783          <div class="comments"></div> 
    795784             
    796785            <h4 id="_square2quadrilateral_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    805794            </h4> 
    806795         
    807           <div class="comments">  the coordinates of the quadrilateral 
    808      (see above for correspondance with the unit square). Can be 
    809      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    810      given in the anticlockwise order.</div> 
     796          <div class="comments"></div> 
    811797             
    812798            <h4 id="_square2quadrilateral_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    821807            </h4> 
    822808         
    823           <div class="comments">  the coordinates of the quadrilateral 
    824      (see above for correspondance with the unit square). Can be 
    825      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    826      given in the anticlockwise order.</div> 
     809          <div class="comments"></div> 
    827810             
    828811            <h4 id="_square2quadrilateral_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    837820            </h4> 
    838821         
    839           <div class="comments">  the coordinates of the quadrilateral 
    840      (see above for correspondance with the unit square). Can be 
    841      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    842      given in the anticlockwise order.</div> 
     822          <div class="comments"></div> 
    843823             
    844824            <h4 id="_square2quadrilateral_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    853833            </h4> 
    854834         
    855           <div class="comments">  the coordinates of the quadrilateral 
    856      (see above for correspondance with the unit square). Can be 
    857      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    858      given in the anticlockwise order.</div> 
     835          <div class="comments"></div> 
    859836             
    860837            <h4 id="_square2quadrilateral_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    869846            </h4> 
    870847         
    871           <div class="comments">  the coordinates of the quadrilateral 
    872      (see above for correspondance with the unit square). Can be 
    873      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    874      given in the anticlockwise order. 
     848          <div class="comments"> 
     849 the coordinates of the quadrilateral (see above for correspondance with the 
     850 unit square). 
     851 Can be scalar or array. 
     852 (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are given in the anticlockwise order. 
     853 
    875854</div> 
    876855             
     
    886865            </h4> 
    887866         
    888           <div class="comments"> the coordinates of the point(s) for which we want to do the 
    889      mapping. Can be scalar or array.</div> 
     867          <div class="comments"></div> 
    890868             
    891869            <h4 id="_square2quadrilateral_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    900878            </h4> 
    901879         
    902           <div class="comments"> the coordinates of the point(s) for which we want to do the 
    903      mapping. Can be scalar or array. 
    904 </div> 
    905              
    906  
    907            
    908  
    909            
    910  
    911           <h3>Examples</h3><div class="value">  
     880          <div class="comments"> 
     881 the coordinates of the point(s) for which we want to do the mapping. 
     882</div> 
     883             
     884 
     885           
     886 
     887           
     888 
     889          <h3>Examples</h3><div class="preformat"> 
    912890 
    913891 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
     
    920898          <h3>Version history</h3> 
    921899           
    922           <h4>Version</h4><div class="value"> $Id: square2quadrilateral.pro 118 2006-06-27 15:47:06Z pinsard $ 
    923 </div> 
    924           <h4>History</h4><div class="value"> 
     900          <h4>Version</h4><div class="preformat"> $Id: square2quadrilateral.pro 136 2006-07-10 15:20:19Z pinsard $ 
     901</div> 
     902          <h4>History</h4><div class="preformat"> 
    925903      Sebastien Masson (smasson@lodyc.jussieu.fr) 
    926904      August 2003 
     
    928906      IEEE Computer Society Press, Los Alamitos, California 
    929907      Chapter 3, see p 52-56 
    930        
     908 
    931909</div> 
    932910           
     
    936914           
    937915           
    938           <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
    939  twisted) is not work. This has to be tested. 
     916          <h4>Restrictions</h4><div class="preformat"> 
     917 I think degenerated quadrilateral (e.g. flat of twisted) is not work. 
     918 This has to be tested. 
    940919</div> 
    941920         
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/testinterp.html

    r111 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%; 
Note: See TracChangeset for help on using the changeset viewer.