Ignore:
Timestamp:
06/12/06 10:29:56 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Interpolation *.pro files for better idldoc output

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

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/angle.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> north stereographic polar projection 
     90 
     91 Compute angles between grid lines and direction of the North 
     92(fom angle.F,v 2.2 in OPA8.2) 
     93</div> 
    9094 
    9195       
     
    102106           
    103107          <dt><p><a href="#_fsnspp"><span class="result">result = </span>fsnspp(<span class="result">plam, pphi</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> 
    104           <dd>  NAME:angle.</dd>         
     108          <dd></dd>      
    105109           
    106110          <dt><p><a href="#_angle">angle<span class="result">, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</span>, IODIRECTORY=<span class="result">IODIRECTORY</span>, DOUBLE=<span class="result">DOUBLE</span></a></p><dt> 
     
    121125            <span class="result">result = </span>fsnspp(<span class="result"><a href="#_fsnspp_param_plam">plam</a>, <a href="#_fsnspp_param_pphi">pphi</a></span>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> 
    122126         
    123           <div class="comments"> 
    124  NAME:angle.pro (fom angle.F,v 2.2 in OPA8.2) 
    125  
    126  PURPOSE:Compute angles between grid lines and direction of the North 
    127  
    128  CALLING SEQUENCE:  
    129      angle, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint 
    130  
    131  INPUTS: 
    132      fileocemesh a netcdf file that contains (at least): 
    133         glamu, gphiu: longitudes and latitudes at U-points 
    134         glamv, gphiv: longitudes and latitudes at V-points 
    135         glamf, gphif: longitudes and latitudes at F-points 
    136  
    137  KEYWORD PARAMETERS: 
    138  
    139     IODIRECTORY: the directory path where is located fileocemesh 
    140  
    141     /DOUBLE: use double precision (default is float) 
    142  
    143  OUTPUTS: 
     127          <div class="comments"></div> 
     128 
     129          <h3>Return value</h3><div class="value"> 
    144130       gsinu,gcosu : sinus and cosinus of the angle  
    145131       gsinv,gcosv   between north-south direction  
    146132       gsint,gcost   and the j-direction of the mesh 
    147                        
    148  
    149  RESTRICTIONS: to compute the lateral boundary conditions, we assume 
     133</div> 
     134 
     135           
     136            <h3>Parameters</h3> 
     137         
     138             
     139            <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140               
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments"></div> 
     151             
     152            <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"></div> 
     164             
     165 
     166           
     167 
     168           
     169 
     170            <h3>Keywords</h3> 
     171             
     172            <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180               
     181            </h4> 
     182         
     183            <div class="comments"> use double precision (default is float) 
     184</div> 
     185             
     186           
     187 
     188           
     189          <h3>Version history</h3> 
     190           
     191           
     192          <h4>History</h4><div class="value"> 
     193   -------------- 
     194       Original :  96-07 (O. Marti) 
     195                   98-06 (G. Madec) 
     196       Feb 2005: IDL adaptation S. Masson </div> 
     197           
     198           
     199          <h3>Known issues</h3> 
     200           
     201           
     202           
     203          <h4>Restrictions</h4><div class="value"> to compute the lateral boundary conditions, we assume 
    150204 that:  
    151205     (1) the first line is similar to the second line 
     
    157211       =>    gsinv[0, *] = gsinv[jpj-2, *] 
    158212 
    159  
    160  MODIFICATION HISTORY: 
    161    -------------- 
    162        Original :  96-07 (O. Marti) 
    163                    98-06 (G. Madec) 
    164        Feb 2005: IDL adaptation S. Masson </div> 
    165  
    166            
    167  
    168            
    169             <h3>Parameters</h3> 
    170          
    171              
    172             <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180                
    181             </h4> 
    182          
    183           <div class="comments"></div> 
    184              
    185             <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments"></div> 
    197              
    198  
    199            
    200  
    201            
    202  
    203             <h3>Keywords</h3> 
    204              
    205             <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    206                
    207                
    208                
    209                
    210                
    211                
    212                
    213                
    214             </h4> 
    215          
    216             <div class="comments"></div> 
    217              
    218            
    219  
    220            
    221            
    222            
    223            
    224            
    225            
    226            
    227            
    228            
    229            
    230            
    231            
     213</div> 
    232214         
    233215           
     
    260242             
    261243            <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    262                
    263                
    264                
    265                
    266                
    267                
    268                
    269                
    270             </h4> 
    271          
    272           <div class="comments"></div> 
     244              <span class="attr">in</span> 
     245               
     246               
     247              <span class="attr">required</span> 
     248               
     249               
     250               
     251               
     252            </h4> 
     253         
     254          <div class="comments"> a netcdf file that contains (at least): 
     255        glamu, gphiu: longitudes and latitudes at U-points 
     256        glamv, gphiv: longitudes and latitudes at V-points 
     257        glamf, gphif: longitudes and latitudes at F-points 
     258</div> 
    273259             
    274260            <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    368354            </h4> 
    369355         
    370             <div class="comments"></div> 
     356            <div class="comments"> the directory path where is located fileocemesh</div> 
    371357             
    372358            <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    381367            </h4> 
    382368         
    383             <div class="comments"></div> 
     369            <div class="comments"> use double precision (default is float)</div> 
    384370             
    385371           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/clickincell.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> click on a map and find in which cell the click was 
     90</div> 
    9091 
    9192       
     
    102103        <div class="routine_details" id="_clickincell"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>clickincell </h2> 
     105          <h2><a class="top" href="#container">top</a>clickincell <span class="categories"> finding where is a point on a grid 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
    107109            <span class="result">result = </span>clickincell(<a href="#_clickincell_keyword_CELLTYPE">CELLTYPE</a>=<span class="result">CELLTYPE</span>, <a href="#_clickincell_keyword_DRAWCELL">DRAWCELL</a>=<span class="result">DRAWCELL</span>, <a href="#_clickincell_keyword_COLOR">COLOR</a>=<span class="result">COLOR</span>, <a href="#_clickincell_keyword_ORIGINAL">ORIGINAL</a>=<span class="result">ORIGINAL</span>, <a href="#_clickincell_keyword_IJ">IJ</a>=<span class="result">IJ</span>, <a href="#_clickincell_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    108110         
    109           <div class="comments"> 
    110  NAME:clickincell 
    111  
    112  PURPOSE: click on a map and find in which cell the click was 
    113  
    114  CATEGORY:finding where is a point on a grid 
    115  
    116  CALLING SEQUENCE: 
     111          <div class="comments"></div> 
     112 
     113          <h3>Return value</h3><div class="value"> 
     114     the index of the selected cells regarding to the grid which 
     115     is in memory in the variable of the common. If /ij keyword is 
     116     activated give 2D array (2, n) which are the i,j position of the 
     117     n selected cells.  
     118</div> 
     119 
     120           
     121 
     122           
     123 
     124            <h3>Keywords</h3> 
     125             
     126            <h4 id="_clickincell_keyword_CELLTYPE">CELLTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     127               
     128               
     129               
     130               
     131               
     132               
     133               
     134               
     135            </h4> 
     136         
     137            <div class="comments"> = 'T', 'W', 'U', 'V' or 'F' This this the type of point 
     138     that is located in the center of the cell which the click is 
     139     located. default is T type of cell (with corner defined by F 
     140     points). 
     141</div> 
     142             
     143            <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     144               
     145               
     146               
     147               
     148               
     149               
     150               
     151               
     152            </h4> 
     153         
     154            <div class="comments"> to draw the cell in which we clicked 
     155</div> 
     156             
     157            <h4 id="_clickincell_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     158               
     159               
     160               
     161               
     162               
     163               
     164               
     165               
     166            </h4> 
     167         
     168            <div class="comments">  the color used to draw the cells (Clicking one more 
     169     time in the same cell will draw the cell with the white color) 
     170</div> 
     171             
     172            <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180               
     181            </h4> 
     182         
     183            <div class="comments"> to get the position of the cell regarding the original 
     184     grid (with no key_shift, ixminmesh, iyminmesh...) 
     185</div> 
     186             
     187            <h4 id="_clickincell_keyword_IJ">IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     188               
     189               
     190               
     191               
     192               
     193               
     194               
     195               
     196            </h4> 
     197         
     198            <div class="comments"> see outpus 
     199</div> 
     200             
     201            <h4 id="_clickincell_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     202               
     203               
     204               
     205               
     206               
     207               
     208               
     209               
     210            </h4> 
     211         
     212            <div class="comments"> to pass extra keywords to inquad and plot (when /drawcell) 
     213</div> 
     214             
     215           
     216 
     217          <h3>Examples</h3><div class="value">  
    117218 
    118219     res = clickincell() 
     
    121222     Click on the right button to quit.   
    122223 
    123  INPUTS:None 
    124  
    125  KEYWORD PARAMETERS: 
    126  
    127      CELLTYPE = 'T', 'W', 'U', 'V' or 'F': This this the type of point 
    128      that is located in the center of the cell which the click is 
    129      located. default is T type of cell (with corner defined by F 
    130      points). 
    131  
    132      /DRAWCELL: to draw the cell in which we clicked 
    133  
    134      COLOR = the color used to draw the cells (Clicking one more 
    135      time in the same cell will draw the cell with the white color) 
    136  
    137      /ORIGINAL: to get the position of the cell regarding the original 
    138      grid (with no key_shift, ixminmesh, iyminmesh...) 
    139  
    140      /IJ: see outpus 
    141  
    142      _EXTRA: to pass extra keywords to inquad and plot (when /drawcell) 
    143  
    144  OUTPUTS: 
    145      the the index of the selected cells regarding to the grid which 
    146      is in memory in the variable of the common. If /ij keyword is 
    147      activated give 2D array (2, n) which are the i,j position of the 
    148      n selected cells.  
    149  
    150  COMMON BLOCKS:common.pro 
    151  
    152  SIDE EFFECTS: 
    153  
    154  RESTRICTIONS: 
    155  
    156  EXAMPLE: 
     224  
    157225 
    158226   IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho 
    159227   IDL> print, clickincell(/draw,color=150,/xy) 
    160  
    161  MODIFICATION HISTORY:</div> 
    162  
    163            
    164  
    165            
    166  
    167            
    168  
    169             <h3>Keywords</h3> 
    170              
    171             <h4 id="_clickincell_keyword_CELLTYPE">CELLTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    172                
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180             </h4> 
    181          
    182             <div class="comments"></div> 
    183              
    184             <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    185                
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193             </h4> 
    194          
    195             <div class="comments"></div> 
    196              
    197             <h4 id="_clickincell_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    198                
    199                
    200                
    201                
    202                
    203                
    204                
    205                
    206             </h4> 
    207          
    208             <div class="comments"></div> 
    209              
    210             <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    211                
    212                
    213                
    214                
    215                
    216                
    217                
    218                
    219             </h4> 
    220          
    221             <div class="comments"></div> 
    222              
    223             <h4 id="_clickincell_keyword_IJ">IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    224                
    225                
    226                
    227                
    228                
    229                
    230                
    231                
    232             </h4> 
    233          
    234             <div class="comments"></div> 
    235              
    236             <h4 id="_clickincell_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    237                
    238                
    239                
    240                
    241                
    242                
    243                
    244                
    245             </h4> 
    246          
    247             <div class="comments"></div> 
    248              
    249            
    250  
    251            
    252            
    253            
    254            
    255            
    256            
    257            
    258            
    259            
    260            
    261            
    262            
    263          
    264            
    265            
    266            
    267            
     228</div> 
     229          <h3>Version history</h3> 
     230           
     231           
     232          <h4>History</h4><div class="value"> 
     233      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     234      August 2003 
     235</div> 
     236           
     237           
     238           
     239           
     240           
     241           
     242           
     243         
     244          <h3>Other attributes</h3> 
     245           
     246           
     247          <h4>Uses routines</h4><div class="value"> common.pro 
     248</div> 
    268249           
    269250           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_bilinear_weigaddr.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> compute the weight and address neede to interpolate data from a 
     90          "regular grid" to any grid using the bilinear method 
     91   </div> 
    9092 
    9193       
     
    102104        <div class="routine_details" id="_compute_fromreg_bilinear_weigaddr"> 
    103105 
    104           <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr </h2> 
     106          <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr <span class="categories"> interpolation 
     107</span></h2> 
    105108         
    106109          <p class="header"> 
    107110            compute_fromreg_bilinear_weigaddr<span class="result">, <a href="#_compute_fromreg_bilinear_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p> 
    108111         
    109           <div class="comments"> 
    110  NAME: compute_fromreg_bilinear_weigaddr 
    111  
    112  PURPOSE: compute the weight and address neede to interpolate data from a 
    113           "regular grid" to any grid using the bilinear method 
    114     
    115  CATEGORY:interpolation 
    116  
    117  CALLING SEQUENCE:  
    118      compute_fromreg_bilinear_weigaddr, alon, alat, olon, olat, weig, addr 
    119  
    120  INPUTS: 
    121      lonin and latin: longitude/latitude of the input data  
    122      lonout and latout: longitude/latitude of the output data  
    123  
    124  KEYWORD PARAMETERS:  
    125  
    126      /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into 
    127           account the northen/southern line of the input data when perfoming the 
    128           interpolation. 
    129  
    130  OUTPUTS:  
     112          <div class="comments"></div> 
     113 
     114          <h3>Return value</h3><div class="value">  
    131115     weig, addr: 2D arrays, weig and addr are the weight and addresses used to 
    132116     perform the interpolation: 
    133117          dataout = total(weig*datain[addr], 1) 
    134118          dataout = reform(dataout, jpio, jpjo, /over) 
    135  
    136  COMMON BLOCKS: none 
    137  
    138  SIDE EFFECTS: ? 
    139  
    140  RESTRICTIONS: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127               
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments"> longitudeof the input data </div> 
     137             
     138            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     139              <span class="attr">in</span> 
     140               
     141               
     142              <span class="attr">required</span> 
     143               
     144               
     145               
     146               
     147            </h4> 
     148         
     149          <div class="comments"> latitude of the input data </div> 
     150             
     151            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     152              <span class="attr">in</span> 
     153               
     154               
     155              <span class="attr">required</span> 
     156               
     157               
     158               
     159               
     160            </h4> 
     161         
     162          <div class="comments"> longitude of the output data </div> 
     163             
     164            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     165              <span class="attr">in</span> 
     166               
     167               
     168              <span class="attr">required</span> 
     169               
     170               
     171               
     172               
     173            </h4> 
     174         
     175          <div class="comments"> latitude of the output data  
     176</div> 
     177             
     178            <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179               
     180               
     181               
     182               
     183               
     184               
     185               
     186               
     187            </h4> 
     188         
     189          <div class="comments"></div> 
     190             
     191            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     192               
     193               
     194               
     195               
     196               
     197               
     198               
     199               
     200            </h4> 
     201         
     202          <div class="comments"></div> 
     203             
     204 
     205           
     206 
     207           
     208 
     209            <h3>Keywords</h3> 
     210             
     211            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     212               
     213               
     214               
     215               
     216               
     217               
     218               
     219               
     220            </h4> 
     221         
     222            <div class="comments"> activate if you don't whant to take into 
     223          account the northen line of the input data when perfoming the</div> 
     224             
     225            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     226               
     227               
     228               
     229               
     230               
     231               
     232               
     233               
     234            </h4> 
     235         
     236            <div class="comments"> activate if you don't whant to take into 
     237          account the southern line of the input data when perfoming the 
     238          interpolation. 
     239</div> 
     240             
     241           
     242 
     243           
     244          <h3>Version history</h3> 
     245           
     246           
     247          <h4>History</h4><div class="value"></div> 
     248           
     249           
     250          <h3>Known issues</h3> 
     251           
     252           
     253           
     254          <h4>Restrictions</h4><div class="value"> 
    141255  -  the input grid must be a "regular grid", defined as a grid for which each 
    142256     lontitudes lines have the same latitude and each latitudes columns have the 
     
    146260  -  points located out of the southern and northern boundaries are interpolated 
    147261     using a linear interpolation only along the longitudinal direction. 
    148   
    149  EXAMPLE:  
    150  
    151  MODIFICATION HISTORY:</div> 
    152  
    153            
    154  
    155            
    156             <h3>Parameters</h3> 
    157          
    158              
    159             <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    160                
    161                
    162                
    163                
    164                
    165                
    166                
    167                
    168             </h4> 
    169          
    170           <div class="comments"></div> 
    171              
    172             <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180                
    181             </h4> 
    182          
    183           <div class="comments"></div> 
    184              
    185             <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments"></div> 
    197              
    198             <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    199                
    200                
    201                
    202                
    203                
    204                
    205                
    206                
    207             </h4> 
    208          
    209           <div class="comments"></div> 
    210              
    211             <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    212                
    213                
    214                
    215                
    216                
    217                
    218                
    219                
    220             </h4> 
    221          
    222           <div class="comments"></div> 
    223              
    224             <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    225                
    226                
    227                
    228                
    229                
    230                
    231                
    232                
    233             </h4> 
    234          
    235           <div class="comments"></div> 
    236              
    237  
    238            
    239  
    240            
    241  
    242             <h3>Keywords</h3> 
    243              
    244             <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    245                
    246                
    247                
    248                
    249                
    250                
    251                
    252                
    253             </h4> 
    254          
    255             <div class="comments"></div> 
    256              
    257             <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    258                
    259                
    260                
    261                
    262                
    263                
    264                
    265                
    266             </h4> 
    267          
    268             <div class="comments"></div> 
    269              
    270            
    271  
    272            
    273            
    274            
    275            
    276            
    277            
    278            
    279            
    280            
    281            
    282            
    283            
     262 </div> 
    284263         
    285264           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_imoms3_weigaddr.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> compute the weight and address neede to interpolate data from a 
     90          "regular grid" to any grid using the imoms3 method 
     91   </div> 
    9092 
    9193       
     
    102104        <div class="routine_details" id="_compute_fromreg_imoms3_weigaddr"> 
    103105 
    104           <h2><a class="top" href="#container">top</a>compute_fromreg_imoms3_weigaddr </h2> 
     106          <h2><a class="top" href="#container">top</a>compute_fromreg_imoms3_weigaddr <span class="categories"> interpolation</span></h2> 
    105107         
    106108          <p class="header"> 
    107             compute_fromreg_imoms3_weigaddr<span class="result">, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p> 
     109            compute_fromreg_imoms3_weigaddr<span class="result">, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr  PRO compute_fromreg_imoms3_weigaddr">addr  PRO compute_fromreg_imoms3_weigaddr</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p> 
    108110         
    109111          <div class="comments"> 
    110  NAME: compute_fromreg_imoms3_weigaddr 
    111  
    112  PURPOSE: compute the weight and address neede to interpolate data from a 
    113           "regular grid" to any grid using the imoms3 method 
    114     
    115  CATEGORY:interpolation 
    116  
    117  CALLING SEQUENCE:  
    118      compute_fromreg_imoms3_weigaddr, alon, alat, olon, olat, weig, addr 
    119  
    120  INPUTS: 
    121      lonin and latin: longitude/latitude of the input data  
    122      lonout and latout: longitude/latitude of the output data  
    123  
    124  KEYWORD PARAMETERS:  
    125  
    126      /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into 
    127           account the northen/southern line of the input data when perfoming the 
    128           interpolation. 
    129  
    130  OUTPUTS:  
    131      weig, addr: 2D arrays, weig and addr are the weight and addresses used to 
    132      perform the interpolation: 
    133           dataout = total(weig*datain[addr], 1) 
    134           dataout = reform(dataout, jpio, jpjo, /over) 
    135  
    136  COMMON BLOCKS: none 
    137  
    138  SIDE EFFECTS: ? 
    139  
    140  RESTRICTIONS: 
    141   -  the input grid must be a "regular/rectangular grid", defined as a grid for 
    142      which each lontitudes lines have the same latitude and each latitudes columns 
    143      have the same longitude. 
    144   -  We supposed the data are located on a sphere, with a periodicity along 
    145      the longitude. 
    146   -  points located between the first/last 2 lines are interpolated 
    147      using a imoms3 interpolation along the longitudinal direction and linear 
    148      interpolation along the latitudinal direction 
    149   -  points located out of the southern and northern boundaries are interpolated 
    150      using a imoms3 interpolation only along the longitudinal direction. 
    151   
    152  EXAMPLE:  
    153  
    154  MODIFICATION HISTORY:</div> 
     112</div> 
    155113 
    156114           
     
    159117            <h3>Parameters</h3> 
    160118         
     119             
     120            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     121               
     122               
     123               
     124               
     125               
     126               
     127               
     128               
     129            </h4> 
     130         
     131          <div class="comments"></div> 
     132             
     133            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     134               
     135               
     136               
     137               
     138               
     139               
     140               
     141               
     142            </h4> 
     143         
     144          <div class="comments"></div> 
     145             
     146            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     147               
     148               
     149               
     150               
     151               
     152               
     153               
     154               
     155            </h4> 
     156         
     157          <div class="comments"></div> 
     158             
     159            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     160               
     161               
     162               
     163               
     164               
     165               
     166               
     167               
     168            </h4> 
     169         
     170          <div class="comments"></div> 
     171             
     172            <h4 id="_compute_fromreg_imoms3_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180               
     181            </h4> 
     182         
     183          <div class="comments"></div> 
     184             
     185            <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr  PRO compute_fromreg_imoms3_weigaddr">addr  PRO compute_fromreg_imoms3_weigaddr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193               
     194            </h4> 
     195         
     196          <div class="comments"></div> 
    161197             
    162198            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutpar.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> cut p parallelogram(s) into p*n^2 parallelograms 
     90</div> 
    9091 
    9192       
     
    102103        <div class="routine_details" id="_cutpar"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>cutpar </h2> 
     105          <h2><a class="top" href="#container">top</a>cutpar <span class="categories"> basic work 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
     
    108110         
    109111          <div class="comments"> 
    110  NAME: cutpar 
    111  
    112  PURPOSE: cut p parallelogram(s) into p*n^2 parallelograms 
    113  
    114  CATEGORY: basic work 
    115  
    116  CALLING SEQUENCE:res = cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n) 
    117  
    118  INPUTS: 
    119        x0,y0 1d arrays of p elements, giving the edge positions. The 
    120        edges must be given as in plot to traw the parallelogram. (see 
    121        example). 
    122        n: each parallelogram will be cutted in n^2 pieces 
    123  
    124  KEYWORD PARAMETERS:  
    125  
    126          /endpoints: see outputs 
    127  
    128          /onsphere: to specify that the points are located on a 
    129          sphere. In this case, x and y corresponds to longitude and 
    130          latitude in degrees. 
    131  
    132  OUTPUTS: 
     112</div> 
     113 
     114          <h3>Return value</h3><div class="value"> 
    133115        -defaut: 3d array(2,n^2,p) giving the center position of each 
    134116        piece of the parallelograms 
    135117        -/endpoints: 3d array(2,(n+1)^2,p) giving the edge positions 
    136118        of each piece of the parallelograms 
    137  
    138  COMMON BLOCKS: no 
    139  
    140  SIDE EFFECTS: need cutsegment.pro 
    141  
    142  RESTRICTIONS: ? 
    143  
    144  EXAMPLE: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_cutpar_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127               
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments"> 1d arrays of p elements, giving the edge positions. The 
     137       edges must be given as in plot to traw the parallelogram. (see 
     138       example).</div> 
     139             
     140            <h4 id="_cutpar_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148               
     149            </h4> 
     150         
     151          <div class="comments"></div> 
     152             
     153            <h4 id="_cutpar_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161               
     162            </h4> 
     163         
     164          <div class="comments"></div> 
     165             
     166            <h4 id="_cutpar_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     167               
     168               
     169               
     170               
     171               
     172               
     173               
     174               
     175            </h4> 
     176         
     177          <div class="comments"></div> 
     178             
     179            <h4 id="_cutpar_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     180               
     181               
     182               
     183               
     184               
     185               
     186               
     187               
     188            </h4> 
     189         
     190          <div class="comments"></div> 
     191             
     192            <h4 id="_cutpar_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     193               
     194               
     195               
     196               
     197               
     198               
     199               
     200               
     201            </h4> 
     202         
     203          <div class="comments"></div> 
     204             
     205            <h4 id="_cutpar_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     206               
     207               
     208               
     209               
     210               
     211               
     212               
     213               
     214            </h4> 
     215         
     216          <div class="comments"></div> 
     217             
     218            <h4 id="_cutpar_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     219               
     220               
     221               
     222               
     223               
     224               
     225               
     226               
     227            </h4> 
     228         
     229          <div class="comments"></div> 
     230             
     231            <h4 id="_cutpar_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     232              <span class="attr">in</span> 
     233               
     234               
     235              <span class="attr">required</span> 
     236               
     237               
     238               
     239               
     240            </h4> 
     241         
     242          <div class="comments"> each parallelogram will be cutted in n^2 pieces 
     243</div> 
     244             
     245 
     246           
     247 
     248           
     249 
     250            <h3>Keywords</h3> 
     251             
     252            <h4 id="_cutpar_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     253               
     254               
     255               
     256               
     257               
     258               
     259               
     260               
     261            </h4> 
     262         
     263            <div class="comments"> see outputs 
     264</div> 
     265             
     266            <h4 id="_cutpar_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     267               
     268               
     269               
     270               
     271               
     272               
     273               
     274               
     275            </h4> 
     276         
     277            <div class="comments"> to specify that the points are located on a 
     278         sphere. In this case, x and y corresponds to longitude and 
     279         latitude in degrees. 
     280</div> 
     281             
     282           
     283 
     284          <h3>Examples</h3><div class="value">  
     285 res = cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n) 
     286 
     287  
    145288 
    146289 x0 = [2,6,2] 
     
    157300 res=cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n) 
    158301 for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3 
    159  
    160  MODIFICATION HISTORY:</div> 
    161  
    162            
    163  
    164            
    165             <h3>Parameters</h3> 
    166          
    167              
    168             <h4 id="_cutpar_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    169                
    170                
    171                
    172                
    173                
    174                
    175                
    176                
    177             </h4> 
    178          
    179           <div class="comments"></div> 
    180              
    181             <h4 id="_cutpar_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    182                
    183                
    184                
    185                
    186                
    187                
    188                
    189                
    190             </h4> 
    191          
    192           <div class="comments"></div> 
    193              
    194             <h4 id="_cutpar_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    195                
    196                
    197                
    198                
    199                
    200                
    201                
    202                
    203             </h4> 
    204          
    205           <div class="comments"></div> 
    206              
    207             <h4 id="_cutpar_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    208                
    209                
    210                
    211                
    212                
    213                
    214                
    215                
    216             </h4> 
    217          
    218           <div class="comments"></div> 
    219              
    220             <h4 id="_cutpar_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    221                
    222                
    223                
    224                
    225                
    226                
    227                
    228                
    229             </h4> 
    230          
    231           <div class="comments"></div> 
    232              
    233             <h4 id="_cutpar_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    234                
    235                
    236                
    237                
    238                
    239                
    240                
    241                
    242             </h4> 
    243          
    244           <div class="comments"></div> 
    245              
    246             <h4 id="_cutpar_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    247                
    248                
    249                
    250                
    251                
    252                
    253                
    254                
    255             </h4> 
    256          
    257           <div class="comments"></div> 
    258              
    259             <h4 id="_cutpar_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    260                
    261                
    262                
    263                
    264                
    265                
    266                
    267                
    268             </h4> 
    269          
    270           <div class="comments"></div> 
    271              
    272             <h4 id="_cutpar_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    273                
    274                
    275                
    276                
    277                
    278                
    279                
    280                
    281             </h4> 
    282          
    283           <div class="comments"></div> 
    284              
    285  
    286            
    287  
    288            
    289  
    290             <h3>Keywords</h3> 
    291              
    292             <h4 id="_cutpar_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    293                
    294                
    295                
    296                
    297                
    298                
    299                
    300                
    301             </h4> 
    302          
    303             <div class="comments"></div> 
    304              
    305             <h4 id="_cutpar_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    306                
    307                
    308                
    309                
    310                
    311                
    312                
    313                
    314             </h4> 
    315          
    316             <div class="comments"></div> 
    317              
    318            
    319  
    320            
    321            
    322            
    323            
    324            
    325            
    326            
    327            
    328            
    329            
    330            
    331            
    332          
    333            
    334            
    335            
    336            
     302</div> 
     303          <h3>Version history</h3> 
     304           
     305           
     306          <h4>History</h4><div class="value"> 
     307           S. Masson (smasson@lodyc.jussieu.fr) 
     308           July 5th, 2002</div> 
     309           
     310           
     311           
     312           
     313           
     314           
     315           
     316         
     317          <h3>Other attributes</h3> 
     318           
     319           
     320          <h4>Uses routines</h4><div class="value"> cutsegment.pro 
     321</div> 
    337322           
    338323           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/cutsegment.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> cut p segments into p*n equal parts 
     90</div> 
    9091 
    9192       
     
    102103        <div class="routine_details" id="_cutsegment"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>cutsegment </h2> 
     105          <h2><a class="top" href="#container">top</a>cutsegment <span class="categories"> basic work 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
     
    108110         
    109111          <div class="comments"> 
    110  NAME: cutsegment 
    111  
    112  PURPOSE: cut p segments into p*n equal parts 
    113  
    114  CATEGORY: basic work 
    115  
    116  CALLING SEQUENCE: res = cutsegment(x0, y0, x1, y1, n) 
    117  
    118  INPUTS:  
    119          x0,y0 and x1,y1, 1d arrays of p elements, the coordinates of 
    120          the endpoints of the p segmements 
    121          n: the number of pieces we want to cut each segment 
    122  
    123  KEYWORD PARAMETERS: 
    124  
    125          /endpoints: see ouputs 
    126  
    127          /onsphere: to specify that the points are located on a 
    128          sphere. In this case, x and y corresponds to longitude and 
    129          latitude in degrees. 
    130  
    131  OUTPUTS: 
     112</div> 
     113 
     114          <h3>Return value</h3><div class="value"> 
    132115        defaut: a 3d array (2,n,p) that gives the coordinates of the 
    133116        middle of the cutted segments. 
    134117        if /endpoints, a 3d array (2,n+1,p) that gives the 
    135118        coordinates of the endpoints of the cutted segments. 
    136  
    137  COMMON BLOCKS: no 
    138  
    139  SIDE EFFECTS: no 
    140  
    141  RESTRICTIONS: ? 
    142  
    143  EXAMPLE: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_cutsegment_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127               
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments">  1d arrays of p elements, the coordinates of 
     137         the endpoints of the p segmements</div> 
     138             
     139            <h4 id="_cutsegment_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140               
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments"></div> 
     151             
     152            <h4 id="_cutsegment_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"></div> 
     164             
     165            <h4 id="_cutsegment_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     166               
     167               
     168               
     169               
     170               
     171               
     172               
     173               
     174            </h4> 
     175         
     176          <div class="comments"></div> 
     177             
     178            <h4 id="_cutsegment_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179              <span class="attr">in</span> 
     180               
     181               
     182              <span class="attr">required</span> 
     183               
     184               
     185               
     186               
     187            </h4> 
     188         
     189          <div class="comments">  the number of pieces we want to cut each segment 
     190 
     191</div> 
     192             
     193 
     194           
     195 
     196           
     197 
     198            <h3>Keywords</h3> 
     199             
     200            <h4 id="_cutsegment_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     201               
     202               
     203               
     204               
     205               
     206               
     207               
     208               
     209            </h4> 
     210         
     211            <div class="comments"> see ouputs 
     212</div> 
     213             
     214            <h4 id="_cutsegment_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     215               
     216               
     217               
     218               
     219               
     220               
     221               
     222               
     223            </h4> 
     224         
     225            <div class="comments"> to specify that the points are located on a 
     226         sphere. In this case, x and y corresponds to longitude and 
     227         latitude in degrees. 
     228</div> 
     229             
     230           
     231 
     232          <h3>Examples</h3><div class="value">   
     233 res = cutsegment(x0, y0, x1, y1, n) 
     234 
     235  
    144236 
    145237  IDL> x0=[2,5] 
     
    153245  IDL> oplot, [x0[1], x1[1]], [y0[1], y1[1]] 
    154246  IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3 
    155  
    156  MODIFICATION HISTORY:</div> 
    157  
    158            
    159  
    160            
    161             <h3>Parameters</h3> 
    162          
    163              
    164             <h4 id="_cutsegment_param_x0">x0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    165                
    166                
    167                
    168                
    169                
    170                
    171                
    172                
    173             </h4> 
    174          
    175           <div class="comments"></div> 
    176              
    177             <h4 id="_cutsegment_param_y0">y0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    178                
    179                
    180                
    181                
    182                
    183                
    184                
    185                
    186             </h4> 
    187          
    188           <div class="comments"></div> 
    189              
    190             <h4 id="_cutsegment_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    191                
    192                
    193                
    194                
    195                
    196                
    197                
    198                
    199             </h4> 
    200          
    201           <div class="comments"></div> 
    202              
    203             <h4 id="_cutsegment_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    204                
    205                
    206                
    207                
    208                
    209                
    210                
    211                
    212             </h4> 
    213          
    214           <div class="comments"></div> 
    215              
    216             <h4 id="_cutsegment_param_n">n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    217                
    218                
    219                
    220                
    221                
    222                
    223                
    224                
    225             </h4> 
    226          
    227           <div class="comments"></div> 
    228              
    229  
    230            
    231  
    232            
    233  
    234             <h3>Keywords</h3> 
    235              
    236             <h4 id="_cutsegment_keyword_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    237                
    238                
    239                
    240                
    241                
    242                
    243                
    244                
    245             </h4> 
    246          
    247             <div class="comments"></div> 
    248              
    249             <h4 id="_cutsegment_keyword_onsphere">onsphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    250                
    251                
    252                
    253                
    254                
    255                
    256                
    257                
    258             </h4> 
    259          
    260             <div class="comments"></div> 
    261              
    262            
    263  
    264            
    265            
    266            
    267            
    268            
     247</div> 
     248          <h3>Version history</h3> 
     249           
     250           
     251          <h4>History</h4><div class="value"> 
     252           S. Masson (smasson@lodyc.jussieu.fr) 
     253           July 5th, 2002</div> 
    269254           
    270255           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/directory-overview.html

    r89 r101  
    9090       
    9191        <dt><a href="angle.html?format=raw">angle.pro</a></dt> 
    92         <dd></dd> 
     92        <dd> north stereographic polar projection   Compute angles between grid lines and direction of the North (fom angle.</dd> 
    9393       
    9494        <dt><a href="clickincell.html?format=raw">clickincell.pro</a></dt> 
    95         <dd></dd> 
     95        <dd> click on a map and find in which cell the click was </dd> 
    9696       
    9797        <dt><a href="compute_fromreg_bilinear_weigaddr.html?format=raw">compute_fromreg_bilinear_weigaddr.pro</a></dt> 
    98         <dd></dd> 
     98        <dd> compute the weight and address neede to interpolate data from a           "regular grid" to any grid using the bilinear method    </dd> 
    9999       
    100100        <dt><a href="compute_fromreg_imoms3_weigaddr.html?format=raw">compute_fromreg_imoms3_weigaddr.pro</a></dt> 
    101         <dd></dd> 
     101        <dd> compute the weight and address neede to interpolate data from a           "regular grid" to any grid using the imoms3 method    </dd> 
    102102       
    103103        <dt><a href="cutpar.html?format=raw">cutpar.pro</a></dt> 
    104         <dd></dd> 
     104        <dd> cut p parallelogram(s) into p*n^2 parallelograms </dd> 
    105105       
    106106        <dt><a href="cutsegment.html?format=raw">cutsegment.pro</a></dt> 
    107         <dd></dd> 
     107        <dd> cut p segments into p*n equal parts </dd> 
    108108       
    109109        <dt><a href="extrapolate.html?format=raw">extrapolate.pro</a></dt> 
    110         <dd></dd> 
     110        <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> 
    111111       
    112112        <dt><a href="fromreg.html?format=raw">fromreg.pro</a></dt> 
    113         <dd></dd> 
     113        <dd> interpolate data from a "regular/rectangular grid" to any grid.</dd> 
    114114       
    115115        <dt><a href="get_gridparams.html?format=raw">get_gridparams.pro</a></dt> 
    116         <dd></dd> 
     116        <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> 
    117117       
    118118        <dt><a href="imoms3.html?format=raw">imoms3.pro</a></dt> 
     
    120120       
    121121        <dt><a href="inquad.html?format=raw">inquad.pro</a></dt> 
    122         <dd></dd> 
     122        <dd> to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) </dd> 
    123123       
    124124        <dt><a href="inrecgrid.html?format=raw">inrecgrid.pro</a></dt> 
    125         <dd></dd> 
     125        <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> 
    126126       
    127127        <dt><a href="ll_narcs_distances.html?format=raw">ll_narcs_distances.pro</a></dt> 
    128         <dd></dd> 
     128        <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> 
    129129       
    130130        <dt><a href="map_npoints.html?format=raw">map_npoints.pro</a></dt> 
    131         <dd></dd> 
     131        <dd> Return the distance in meter between all np0 points P0 and all        np1 points P1 on a sphere.</dd> 
    132132       
    133133        <dt><a href="neighbor.html?format=raw">neighbor.pro</a></dt> 
    134         <dd></dd> 
     134        <dd> find the closetest point of (P0) within a list of np1 points P1 Which can be on a sphere  </dd> 
    135135       
    136136        <dt><a href="quadrilateral2square.html?format=raw">quadrilateral2square.pro</a></dt> 
    137         <dd></dd> 
     137        <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> 
    138138       
    139139        <dt><a href="spl_fstdrv.html?format=raw">spl_fstdrv.pro</a></dt> 
    140         <dd></dd> 
     140        <dd> SPL_FSTDRV returns the values of the first derivative of  the interpolating function at the points X2i.</dd> 
    141141       
    142142        <dt><a href="spl_incr.html?format=raw">spl_incr.pro</a></dt> 
    143         <dd></dd> 
     143        <dd>   Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  SPL_INCR function returns an interpolated value for the given values  of X2.</dd> 
    144144       
    145145        <dt><a href="spl_keep_mean.html?format=raw">spl_keep_mean.pro</a></dt> 
    146         <dd></dd> 
     146        <dd>   Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  SPL_INCR function returns an interpolated value for the given values  of X2.</dd> 
    147147       
    148148        <dt><a href="square2quadrilateral.html?format=raw">square2quadrilateral.pro</a></dt> 
    149         <dd></dd> 
     149        <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> 
    150150       
    151151        <dt><a href="testinterp.html?format=raw">testinterp.pro</a></dt> 
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/extrapolate.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> extrapolate data (zinput) where maskinput eq 0 by filling step by 
     90 step the coastline points with the mean value of the 8 neighbourgs. 
     91</div> 
    9092 
    9193       
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromreg.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_fromreg"> 
    103  
    104           <h2><a class="top" href="#container">top</a>fromreg </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>, <a href="#_fromreg_param_lonin">lonin</a>, <a href="#_fromreg_param_latin">latin</a>, <a href="#_fromreg_param_lonout">lonout</a>, <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME: fromreg 
    111  
    112  PURPOSE: interpolate data from a "regular/rectangular grid" to any grid. 
     89      <div id="file_comments"> interpolate data from a "regular/rectangular grid" to any grid. 
    11390   2 metods availables: bilinear and imoms3  
    11491   A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have  
    11592   the same latitude and each latitudes columns have the same longitude. 
    116     
    117  CATEGORY:interpolation 
    118  
    119  CALLING SEQUENCE: dataout = fromreg(method, datain [, lonin, latin, lonout, latout]) 
    120  
    121  INPUTS: 
    122     method: a string defining the interpolation method.  
    123             must be 'bilinear' or 'imoms3' 
    124     datain: a 2D array the input data to interpolate 
    125     lonin and latin: longitude/latitude of the input data. optionals if 
     93   </div> 
     94 
     95       
     96 
     97       
     98 
     99       
     100 
     101       
     102 
     103      <div id="routine_details"> 
     104         
     105 
     106        <div class="routine_details" id="_fromreg"> 
     107 
     108          <h2><a class="top" href="#container">top</a>fromreg <span class="categories"> interpolation 
     109</span></h2> 
     110         
     111          <p class="header"> 
     112            <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>, <a href="#_fromreg_param_lonin">lonin</a>, <a href="#_fromreg_param_latin">latin</a>, <a href="#_fromreg_param_lonout">lonout</a>, <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 
     113         
     114          <div class="comments"> 
     115</div> 
     116 
     117          <h3>Return value</h3><div class="value"> 2D array: the interpolated data 
     118</div> 
     119 
     120           
     121            <h3>Parameters</h3> 
     122         
     123             
     124            <h4 id="_fromreg_param_method">method&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     125              <span class="attr">in</span> 
     126               
     127               
     128              <span class="attr">required</span> 
     129               
     130               
     131               
     132               
     133            </h4> 
     134         
     135          <div class="comments">  a string defining the interpolation method.  
     136            must be 'bilinear' or 'imoms3'</div> 
     137             
     138            <h4 id="_fromreg_param_datain">datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     139              <span class="attr">in</span> 
     140               
     141               
     142              <span class="attr">required</span> 
     143               
     144               
     145               
     146               
     147            </h4> 
     148         
     149          <div class="comments">  a 2D array the input data to interpolate</div> 
     150             
     151            <h4 id="_fromreg_param_lonin">lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     152              <span class="attr">in</span> 
     153               
     154               
     155              <span class="attr">required</span> 
     156               
     157               
     158               
     159               
     160            </h4> 
     161         
     162          <div class="comments">  longitude/latitude of the input data. optionals if 
     163            WEIG and ADDR keywords used.</div> 
     164             
     165            <h4 id="_fromreg_param_latin">latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     166               
     167               
     168               
     169               
     170               
     171               
     172               
     173               
     174            </h4> 
     175         
     176          <div class="comments"></div> 
     177             
     178            <h4 id="_fromreg_param_lonout">lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179              <span class="attr">in</span> 
     180               
     181               
     182              <span class="attr">required</span> 
     183               
     184               
     185               
     186               
     187            </h4> 
     188         
     189          <div class="comments">  longitude/latitude of the output data. optionals if 
    126190            WEIG and ADDR keywords used. 
    127     lonout and latout: longitude/latitude of the output data. optionals if 
    128             WEIG and ADDR keywords used. 
    129  
    130  KEYWORD PARAMETERS:  
    131  
    132      WEIG, ADDR: 2D arrays, weig and addr are the weight and addresses used to 
     191</div> 
     192             
     193            <h4 id="_fromreg_param_latout">latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     194               
     195               
     196               
     197               
     198               
     199               
     200               
     201               
     202            </h4> 
     203         
     204          <div class="comments"></div> 
     205             
     206 
     207           
     208 
     209           
     210 
     211            <h3>Keywords</h3> 
     212             
     213            <h4 id="_fromreg_keyword_WEIG">WEIG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     214               
     215               
     216               
     217               
     218               
     219               
     220               
     221               
     222            </h4> 
     223         
     224            <div class="comments">, ADDR 2D arrays, weig and addr are the weight and addresses used to 
    133225     perform the interpolation: 
    134226          dataout = total(weig*datain[addr], 1) 
     
    138230     the interpolation whithout computing again those 2 parameters. In that 
    139231     case, lonin, latin, lonout and latout are not necessary. 
    140  
    141      /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into 
     232</div> 
     233             
     234            <h4 id="_fromreg_keyword_ADDR">ADDR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     235               
     236               
     237               
     238               
     239               
     240               
     241               
     242               
     243            </h4> 
     244         
     245            <div class="comments"></div> 
     246             
     247            <h4 id="_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     248               
     249               
     250               
     251               
     252               
     253               
     254               
     255               
     256            </h4> 
     257         
     258            <div class="comments"> and /NOSOUTHERNLINE activate if you don't whant to take into 
    142259          account the northen/southern line of the input data when perfoming the 
    143260          interpolation. 
    144  
    145  OUTPUTS: 2D array: the interpolated data 
    146  
    147  COMMON BLOCKS: none 
    148  
    149  SIDE EFFECTS: ? 
    150  
    151  RESTRICTIONS:We supposed the data are located on a sphere, with a periodicity along 
    152               the longitude. 
    153  
    154  EXAMPLE:  
     261</div> 
     262             
     263            <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     264               
     265               
     266               
     267               
     268               
     269               
     270               
     271               
     272            </h4> 
     273         
     274            <div class="comments"></div> 
     275             
     276           
     277 
     278          <h3>Examples</h3><div class="value">   
     279 dataout = fromreg(method, datain [, lonin, latin, lonout, latout]) 
     280 
     281   
    155282   
    156283  topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit) 
     
    161288  help, a, b 
    162289  t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b) 
    163  
    164  MODIFICATION HISTORY:</div> 
    165  
    166            
    167  
    168            
    169             <h3>Parameters</h3> 
    170          
    171              
    172             <h4 id="_fromreg_param_method">method&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180                
    181             </h4> 
    182          
    183           <div class="comments"></div> 
    184              
    185             <h4 id="_fromreg_param_datain">datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments"></div> 
    197              
    198             <h4 id="_fromreg_param_lonin">lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    199                
    200                
    201                
    202                
    203                
    204                
    205                
    206                
    207             </h4> 
    208          
    209           <div class="comments"></div> 
    210              
    211             <h4 id="_fromreg_param_latin">latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    212                
    213                
    214                
    215                
    216                
    217                
    218                
    219                
    220             </h4> 
    221          
    222           <div class="comments"></div> 
    223              
    224             <h4 id="_fromreg_param_lonout">lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    225                
    226                
    227                
    228                
    229                
    230                
    231                
    232                
    233             </h4> 
    234          
    235           <div class="comments"></div> 
    236              
    237             <h4 id="_fromreg_param_latout">latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    238                
    239                
    240                
    241                
    242                
    243                
    244                
    245                
    246             </h4> 
    247          
    248           <div class="comments"></div> 
    249              
    250  
    251            
    252  
    253            
    254  
    255             <h3>Keywords</h3> 
    256              
    257             <h4 id="_fromreg_keyword_WEIG">WEIG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    258                
    259                
    260                
    261                
    262                
    263                
    264                
    265                
    266             </h4> 
    267          
    268             <div class="comments"></div> 
    269              
    270             <h4 id="_fromreg_keyword_ADDR">ADDR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    271                
    272                
    273                
    274                
    275                
    276                
    277                
    278                
    279             </h4> 
    280          
    281             <div class="comments"></div> 
    282              
    283             <h4 id="_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    284                
    285                
    286                
    287                
    288                
    289                
    290                
    291                
    292             </h4> 
    293          
    294             <div class="comments"></div> 
    295              
    296             <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    297                
    298                
    299                
    300                
    301                
    302                
    303                
    304                
    305             </h4> 
    306          
    307             <div class="comments"></div> 
    308              
    309            
    310  
    311            
    312            
    313            
    314            
    315            
    316            
    317            
    318            
    319            
    320            
    321            
    322            
     290</div> 
     291          <h3>Version history</h3> 
     292           
     293           
     294          <h4>History</h4><div class="value"> 
     295  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
     296 </div> 
     297           
     298           
     299          <h3>Known issues</h3> 
     300           
     301           
     302           
     303          <h4>Restrictions</h4><div class="value"> We supposed the data are located on a sphere, with a  
     304 periodicity along the longitude. 
     305</div> 
    323306         
    324307           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/get_gridparams.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_get_gridparams"> 
    103  
    104           <h2><a class="top" href="#container">top</a>get_gridparams </h2> 
    105          
    106           <p class="header"> 
    107             get_gridparams<span class="result">, <a href="#_get_gridparams_param_in1">in1</a>, <a href="#_get_gridparams_param_in2">in2</a>, <a href="#_get_gridparams_param_in3">in3</a>, <a href="#_get_gridparams_param_in4">in4</a>, <a href="#_get_gridparams_param_in5">in5</a>, <a href="#_get_gridparams_param_in6">in6</a>, <a href="#_get_gridparams_param_in7">in7</a>, <a href="#_get_gridparams_param_in8">in8</a></span>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p> 
    108          
    109           <div class="comments"> 
    110  NAME: get_gridparams 
    111  
    112  PURPOSE:  
     89      <div id="file_comments">  
    11390   1) extract from a NetCDF file the longitude, latidude, and their dimensions 
    11491      and make sure it is 1D or 2D arrays  
     
    11693   or 2) given longitude and latitude arrays get their dimensions and make sure  
    11794      they are 1D or 2D arrays  
    118  
    119  CATEGORY:for interpolations tools 
    120  
    121  CALLING SEQUENCE: 
    122   
    123  1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
    124  
    125  or  
    126  
    127  2) get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    128  
    129  INPUTS: 
    130  
    131  1)  
    132   file: the name of the netcdf file 
    133   loname: the name of the variable that contains the longitude in the NetCDF file 
    134   latname: the name of the variable that contains the latitude in the NetCDF file 
    135  
    136  or  
    137  
    138  2) lon and lat: 1d or 2D arrays defining longitudes and latitudes.  
    139     Note that these arrays are also outputs and can therefore be modified.  
    140  
    141  KEYWORD PARAMETERS: none 
    142  
    143  OUTPUTS: 
    144   lon the variable that will contain the longitudes 
    145   lat the variable that will contain the latitudes 
    146   jpi the number of points in the longitudinal direction 
    147   jpj the number of points in the latitudinal direction 
    148   n_dimensions: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     95</div> 
     96 
     97       
     98 
     99       
     100 
     101       
     102 
     103       
     104 
     105      <div id="routine_details"> 
     106         
     107 
     108        <div class="routine_details" id="_get_gridparams"> 
     109 
     110          <h2><a class="top" href="#container">top</a>get_gridparams <span class="categories"> interpolation 
     111</span></h2> 
     112         
     113          <p class="header"> 
     114            get_gridparams<span class="result">, <a href="#_get_gridparams_param_in1">in1</a>, <a href="#_get_gridparams_param_in2">in2</a>, <a href="#_get_gridparams_param_in3">in3</a>, <a href="#_get_gridparams_param_in4">in4</a>, <a href="#_get_gridparams_param_in5">in5</a>, <a href="#_get_gridparams_param_in6">in6</a>, <a href="#_get_gridparams_param_in7">in7</a>, <a href="#_get_gridparams_param_in8">in8</a></span>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p> 
     115         
     116          <div class="comments"> 
     117</div> 
     118 
     119           
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_get_gridparams_param_in1">in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127              <span class="attr">out</span> 
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments">  the name of the netcdf file 
     137 the variable that will contain the longitudes</div> 
     138             
     139            <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140              <span class="attr">in</span> 
     141              <span class="attr">out</span> 
     142               
     143              <span class="attr">required</span> 
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments">  the name of the variable that contains the longitude in the NetCDF file 
     151 the variable that will contain the latitudes</div> 
     152             
     153            <h4 id="_get_gridparams_param_in3">in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     154              <span class="attr">in</span> 
     155              <span class="attr">out</span> 
     156               
     157              <span class="attr">required</span> 
     158               
     159               
     160               
     161               
     162            </h4> 
     163         
     164          <div class="comments">  the name of the variable that contains the latitude in the NetCDF file 
     165 the number of points in the longitudinal direction</div> 
     166             
     167            <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     168               
     169              <span class="attr">out</span> 
     170               
     171               
     172               
     173               
     174               
     175               
     176            </h4> 
     177         
     178          <div class="comments"> the number of points in the longitudinal direction 
     179 the number of points in the latitudinal direction</div> 
     180             
     181            <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     182               
     183              <span class="attr">out</span> 
     184               
     185               
     186               
     187               
     188               
     189               
     190            </h4> 
     191         
     192          <div class="comments"> the number of points in the latitudinal direction 
     193 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    149194    arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    150195    grid must be regular (each longitudes must be the same for all latitudes 
    151196    and each latitudes should be the sae for all longitudes).  
    152  
    153  COMMON BLOCKS: none 
    154  
    155  SIDE EFFECTS: ? 
    156  
    157  RESTRICTIONS: ? 
    158  
    159  EXAMPLE:  
     197</div> 
     198             
     199            <h4 id="_get_gridparams_param_in6">in6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     200               
     201              <span class="attr">out</span> 
     202               
     203               
     204               
     205               
     206               
     207               
     208            </h4> 
     209         
     210          <div class="comments"> the variable that will contain the longitudes</div> 
     211             
     212            <h4 id="_get_gridparams_param_in7">in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     213               
     214              <span class="attr">out</span> 
     215               
     216               
     217               
     218               
     219               
     220               
     221            </h4> 
     222         
     223          <div class="comments"> the variable that will contain the latitudes</div> 
     224             
     225            <h4 id="_get_gridparams_param_in8">in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     226               
     227              <span class="attr">out</span> 
     228               
     229               
     230               
     231               
     232               
     233               
     234            </h4> 
     235         
     236          <div class="comments"> 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     237 
     238 or  
     239 
     240 2) </div> 
     241             
     242 
     243           
     244 
     245           
     246 
     247            <h3>Keywords</h3> 
     248             
     249            <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     250               
     251               
     252               
     253               
     254               
     255               
     256               
     257               
     258            </h4> 
     259         
     260            <div class="comments"></div> 
     261             
     262           
     263 
     264          <h3>Examples</h3><div class="value">  
     265  
     266 1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
     267 
     268 or  
     269 
     270 2) get_gridparams, lon, lat, jpi, jpj, n_dimensions 
     271 
     272 1)  
     273   
    160274  
    161275 1) ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $ 
     
    163277 
    164278 2) ncdf_get_gridparams, olon, olat, jpio, jpjo, 2 
    165  
    166  MODIFICATION HISTORY:</div> 
    167  
    168            
    169  
    170            
    171             <h3>Parameters</h3> 
    172          
    173              
    174             <h4 id="_get_gridparams_param_in1">in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    175                
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183             </h4> 
    184          
    185           <div class="comments"></div> 
    186              
    187             <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188                
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196             </h4> 
    197          
    198           <div class="comments"></div> 
    199              
    200             <h4 id="_get_gridparams_param_in3">in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    201                
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209             </h4> 
    210          
    211           <div class="comments"></div> 
    212              
    213             <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    214                
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222             </h4> 
    223          
    224           <div class="comments"></div> 
    225              
    226             <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    227                
    228                
    229                
    230                
    231                
    232                
    233                
    234                
    235             </h4> 
    236          
    237           <div class="comments"></div> 
    238              
    239             <h4 id="_get_gridparams_param_in6">in6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    240                
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248             </h4> 
    249          
    250           <div class="comments"></div> 
    251              
    252             <h4 id="_get_gridparams_param_in7">in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    253                
    254                
    255                
    256                
    257                
    258                
    259                
    260                
    261             </h4> 
    262          
    263           <div class="comments"></div> 
    264              
    265             <h4 id="_get_gridparams_param_in8">in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    266                
    267                
    268                
    269                
    270                
    271                
    272                
    273                
    274             </h4> 
    275          
    276           <div class="comments"></div> 
    277              
    278  
    279            
    280  
    281            
    282  
    283             <h3>Keywords</h3> 
    284              
    285             <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    286                
    287                
    288                
    289                
    290                
    291                
    292                
    293                
    294             </h4> 
    295          
    296             <div class="comments"></div> 
    297              
    298            
    299  
    300            
    301            
    302            
    303            
    304            
     279</div> 
     280          <h3>Version history</h3> 
     281           
     282           
     283          <h4>History</h4><div class="value"> 
     284  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)  
     285 </div> 
    305286           
    306287           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/imoms3.html

    r89 r101  
    107107            <span class="result">result = </span>imoms3(<span class="result"><a href="#_imoms3_param_xin">xin</a></span>)</p> 
    108108         
    109           <div class="comments"></div> 
     109          <div class="comments"> 
     110 </div> 
    110111 
    111112           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/inquad.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) 
     90</div> 
    9091 
    9192       
     
    102103        <div class="routine_details" id="_inquad"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>inquad </h2> 
     105          <h2><a class="top" href="#container">top</a>inquad <span class="categories"> grid manipulation 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
    107109            <span class="result">result = </span>inquad(<span class="result"><a href="#_inquad_param_x">x</a>, <a href="#_inquad_param_y">y</a>, <a href="#_inquad_param_x1">x1</a>, <a href="#_inquad_param_y1">y1</a>, <a href="#_inquad_param_x2">x2</a>, <a href="#_inquad_param_y2">y2</a>, <a href="#_inquad_param_x3">x3</a>, <a href="#_inquad_param_y3">y3</a>, <a href="#_inquad_param_x4">x4</a>, <a href="#_inquad_param_y4">y4</a></span>, <a href="#_inquad_keyword_ONSPHERE">ONSPHERE</a>=<span class="result">ONSPHERE</span>, <a href="#_inquad_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_inquad_keyword_ZOOMRADIUS">ZOOMRADIUS</a>=<span class="result">ZOOMRADIUS</span>, <a href="#_inquad_keyword_NOPRINT">NOPRINT</a>=<span class="result">NOPRINT</span>, <a href="#_inquad_keyword_NEWCOORD">NEWCOORD</a>=<span class="result">NEWCOORD</span>)</p> 
    108110         
    109           <div class="comments"> 
    110  NAME:inquad 
    111  
    112  PURPOSE: to find if an (x,y) point is in a quadrilateral (x1,x2,x3,x4) 
    113  
    114  CATEGORY:grid manipulation 
    115  
    116  CALLING SEQUENCE: 
    117  
    118      res = inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4) 
    119  
    120  INPUTS: 
    121  
    122      x,y: the coordinates of the point we want to know where it 
     111          <div class="comments"></div> 
     112 
     113          <h3>Return value</h3><div class="value"> 
     114    a n element vector. Where n is the number of elements of 
     115    x. res[i]=j means that the point number i is located in the 
     116    quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
     117</div> 
     118 
     119           
     120            <h3>Parameters</h3> 
     121         
     122             
     123            <h4 id="_inquad_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     124              <span class="attr">in</span> 
     125               
     126               
     127              <span class="attr">required</span> 
     128               
     129               
     130               
     131               
     132            </h4> 
     133         
     134          <div class="comments">  the coordinates of the point we want to know where it 
    123135     is. Must be a scalar if /onsphere activated else can be scalar 
    124136     or array.  
    125  
    126      x1, y1, x2, y2, x3, y3, x4, y4: the coordinates of the 
     137</div> 
     138             
     139            <h4 id="_inquad_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140               
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments"></div> 
     151             
     152            <h4 id="_inquad_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153              <span class="attr">in</span> 
     154               
     155               
     156              <span class="attr">required</span> 
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments">  the coordinates of the 
    127164     quadrilateral given in the CLOCKWISE order. Scalar or array. 
    128165 
    129  KEYWORD PARAMETERS: 
    130  
    131     /DOUBLE: use double precision to perform the computation  
    132  
    133     /ONSPHERE: to specify that the quadilateral are on a sphere and 
     166</div> 
     167             
     168            <h4 id="_inquad_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     169               
     170               
     171               
     172               
     173               
     174               
     175               
     176               
     177            </h4> 
     178         
     179          <div class="comments"></div> 
     180             
     181            <h4 id="_inquad_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     182               
     183               
     184               
     185               
     186               
     187               
     188               
     189               
     190            </h4> 
     191         
     192          <div class="comments"></div> 
     193             
     194            <h4 id="_inquad_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     195               
     196               
     197               
     198               
     199               
     200               
     201               
     202               
     203            </h4> 
     204         
     205          <div class="comments"></div> 
     206             
     207            <h4 id="_inquad_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     208               
     209               
     210               
     211               
     212               
     213               
     214               
     215               
     216            </h4> 
     217         
     218          <div class="comments"></div> 
     219             
     220            <h4 id="_inquad_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     221               
     222               
     223               
     224               
     225               
     226               
     227               
     228               
     229            </h4> 
     230         
     231          <div class="comments"></div> 
     232             
     233            <h4 id="_inquad_param_x4">x4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     234               
     235               
     236               
     237               
     238               
     239               
     240               
     241               
     242            </h4> 
     243         
     244          <div class="comments"></div> 
     245             
     246            <h4 id="_inquad_param_y4">y4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     247               
     248               
     249               
     250               
     251               
     252               
     253               
     254               
     255            </h4> 
     256         
     257          <div class="comments"></div> 
     258             
     259 
     260           
     261 
     262           
     263 
     264            <h3>Keywords</h3> 
     265             
     266            <h4 id="_inquad_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     267               
     268               
     269               
     270               
     271               
     272               
     273               
     274               
     275            </h4> 
     276         
     277            <div class="comments"> to specify that the quadilateral are on a sphere and 
    134278    that teir coordinates are longitude-latitude coordinates. In this 
    135279    case, est-west periodicity, poles singularity and other pbs 
    136280    related to longitude-latitude coordinates are managed 
    137281    automatically.  
    138  
    139     ZOOMRADIUS:the zoom (circle centred on the (x,y) with a radius of 
     282</div> 
     283             
     284            <h4 id="_inquad_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     285               
     286               
     287               
     288               
     289               
     290               
     291               
     292               
     293            </h4> 
     294         
     295            <div class="comments"> use double precision to perform the computation  
     296</div> 
     297             
     298            <h4 id="_inquad_keyword_ZOOMRADIUS">ZOOMRADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     299               
     300               
     301               
     302               
     303               
     304               
     305               
     306               
     307            </h4> 
     308         
     309            <div class="comments"> :the zoom (circle centred on the (x,y) with a radius of 
    140310    zoomradius degree where we look for the the quadrilateral which;    contains the (x,y) point) used for the satellite projection 
    141311    when /onsphere is activated. Default is 4 and seems to be the 
    142312    minimum which can be used. Can be increase if the cell size is 
    143313    larger than 5 degrees. 
    144     
    145     /NOPRINT: to suppress the print messages. 
    146  
    147  OUTPUTS: 
    148  
    149     res, a n element vector. Where n is the number of elements of 
    150     x. res[i]=j means that the point number i is located in the 
    151     quadrilateral number j with (0 <= j <= n_elements(x0)-1) 
    152  
    153  COMMON BLOCKS:none 
    154  
    155  SIDE EFFECTS: 
    156  
    157  RESTRICTIONS: I think degenerated quadrilateral (e.g. flat of 
    158  twisted) is not work. This has to be tested. 
    159  
    160  EXAMPLE: 
     314   </div> 
     315             
     316            <h4 id="_inquad_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     317               
     318               
     319               
     320               
     321               
     322               
     323               
     324               
     325            </h4> 
     326         
     327            <div class="comments"> to suppress the print messages. 
     328</div> 
     329             
     330            <h4 id="_inquad_keyword_NEWCOORD">NEWCOORD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     331               
     332               
     333               
     334               
     335               
     336               
     337               
     338               
     339            </h4> 
     340         
     341            <div class="comments"></div> 
     342             
     343           
     344 
     345          <h3>Examples</h3><div class="value">  
     346 
     347     res = inquad(x, y, x1, y1, x2, y2, x3, y3, x4, y4) 
     348 
     349  
    161350 
    162351       x = 1.*[1, 2, 6, 7, 3] 
     
    176365 
    177366      On a sphere see clickincell.pro... 
    178  
    179  MODIFICATION HISTORY:</div> 
    180  
    181            
    182  
    183            
    184             <h3>Parameters</h3> 
    185          
    186              
    187             <h4 id="_inquad_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188                
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196             </h4> 
    197          
    198           <div class="comments"></div> 
    199              
    200             <h4 id="_inquad_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    201                
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209             </h4> 
    210          
    211           <div class="comments"></div> 
    212              
    213             <h4 id="_inquad_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    214                
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222             </h4> 
    223          
    224           <div class="comments"></div> 
    225              
    226             <h4 id="_inquad_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    227                
    228                
    229                
    230                
    231                
    232                
    233                
    234                
    235             </h4> 
    236          
    237           <div class="comments"></div> 
    238              
    239             <h4 id="_inquad_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    240                
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248             </h4> 
    249          
    250           <div class="comments"></div> 
    251              
    252             <h4 id="_inquad_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    253                
    254                
    255                
    256                
    257                
    258                
    259                
    260                
    261             </h4> 
    262          
    263           <div class="comments"></div> 
    264              
    265             <h4 id="_inquad_param_x3">x3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    266                
    267                
    268                
    269                
    270                
    271                
    272                
    273                
    274             </h4> 
    275          
    276           <div class="comments"></div> 
    277              
    278             <h4 id="_inquad_param_y3">y3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    279                
    280                
    281                
    282                
    283                
    284                
    285                
    286                
    287             </h4> 
    288          
    289           <div class="comments"></div> 
    290              
    291             <h4 id="_inquad_param_x4">x4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    292                
    293                
    294                
    295                
    296                
    297                
    298                
    299                
    300             </h4> 
    301          
    302           <div class="comments"></div> 
    303              
    304             <h4 id="_inquad_param_y4">y4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    305                
    306                
    307                
    308                
    309                
    310                
    311                
    312                
    313             </h4> 
    314          
    315           <div class="comments"></div> 
    316              
    317  
    318            
    319  
    320            
    321  
    322             <h3>Keywords</h3> 
    323              
    324             <h4 id="_inquad_keyword_ONSPHERE">ONSPHERE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    325                
    326                
    327                
    328                
    329                
    330                
    331                
    332                
    333             </h4> 
    334          
    335             <div class="comments"></div> 
    336              
    337             <h4 id="_inquad_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    338                
    339                
    340                
    341                
    342                
    343                
    344                
    345                
    346             </h4> 
    347          
    348             <div class="comments"></div> 
    349              
    350             <h4 id="_inquad_keyword_ZOOMRADIUS">ZOOMRADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    351                
    352                
    353                
    354                
    355                
    356                
    357                
    358                
    359             </h4> 
    360          
    361             <div class="comments"></div> 
    362              
    363             <h4 id="_inquad_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    364                
    365                
    366                
    367                
    368                
    369                
    370                
    371                
    372             </h4> 
    373          
    374             <div class="comments"></div> 
    375              
    376             <h4 id="_inquad_keyword_NEWCOORD">NEWCOORD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    377                
    378                
    379                
    380                
    381                
    382                
    383                
    384                
    385             </h4> 
    386          
    387             <div class="comments"></div> 
    388              
    389            
    390  
    391            
    392            
    393            
    394            
    395            
    396            
    397            
    398            
    399            
    400            
    401            
    402            
     367</div> 
     368          <h3>Version history</h3> 
     369           
     370           
     371          <h4>History</h4><div class="value"> 
     372      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     373      August 2003 
     374      Based on Convert_clic_ij.pro written by Gurvan Madec  
     375</div> 
     376           
     377           
     378          <h3>Known issues</h3> 
     379           
     380           
     381           
     382          <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
     383 twisted) is not work. This has to be tested. 
     384</div> 
    403385         
    404386           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/inrecgrid.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> given - a list of points, (x,y) position   
     90                - the x and y limits of a rectangular grid 
     91          find in which cell is located each given point. 
     92</div> 
    9093 
    9194       
     
    102105        <div class="routine_details" id="_inrecgrid"> 
    103106 
    104           <h2><a class="top" href="#container">top</a>inrecgrid </h2> 
     107          <h2><a class="top" href="#container">top</a>inrecgrid <span class="categories"> no DO loop, use the wonderfull value_locate function! 
     108</span></h2> 
    105109         
    106110          <p class="header"> 
     
    108112         
    109113          <div class="comments"> 
    110  NAME: inrecgrid 
    111  
    112  PURPOSE: given - a list of points, (x,y) position   
    113                 - the x and y limits of a rectangular grid 
    114           find in which cell is located each given point. 
    115  
    116  CATEGORY: no DO loop, use the wonderfull value_locate function! 
    117  
    118  CALLING SEQUENCE:res = inrecgrid(xin, yin, left, bottom) 
    119  
    120  INPUTS:  
    121  
    122     x1d: a 1d array, the x position on the points 
    123     y1d: a 1d array, the y position on the points 
    124     left: a 1d, monotonically increasing array, the position of the 
    125     "left" border of each cell. 
    126     bottom: a 1d, monotonically increasing array, the position of the 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="value"> the index on the cell accoring to the 2d array defined by 
     117 left and bottom. 
     118</div> 
     119 
     120           
     121            <h3>Parameters</h3> 
     122         
     123             
     124            <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     125              <span class="attr">in</span> 
     126               
     127               
     128              <span class="attr">required</span> 
     129               
     130               
     131               
     132               
     133            </h4> 
     134         
     135          <div class="comments">  a 1d array, the x position on the points</div> 
     136             
     137            <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     138              <span class="attr">in</span> 
     139               
     140               
     141              <span class="attr">required</span> 
     142               
     143               
     144               
     145               
     146            </h4> 
     147         
     148          <div class="comments">  a 1d, monotonically increasing array, the position of the 
     149    "left" border of each cell.</div> 
     150             
     151            <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     152               
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160            </h4> 
     161         
     162          <div class="comments"></div> 
     163             
     164            <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     165              <span class="attr">in</span> 
     166               
     167               
     168              <span class="attr">required</span> 
     169               
     170               
     171               
     172               
     173            </h4> 
     174         
     175          <div class="comments">  a 1d, monotonically increasing array, the position of the 
    127176    "bottom" border of each cell. 
    128177 
    129  OPTIONAL INPUTS: 
    130  
    131  KEYWORD PARAMETERS:; 
    132  
    133     /output2d: to get the output as a 2d array (2,n_elements(x1d)), 
     178</div> 
     179             
     180 
     181           
     182 
     183           
     184 
     185            <h3>Keywords</h3> 
     186             
     187            <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     188               
     189               
     190               
     191               
     192               
     193               
     194               
     195               
     196            </h4> 
     197         
     198            <div class="comments"> to get the output as a 2d array (2,n_elements(x1d)), 
    134199    with res[0,*] the x index accoring to the 1d array defined by 
    135200    left and res[1,*] the y index accoring to the 1d array defined by 
    136201    bottom. 
    137  
    138     checkout=[rbgrid,ubgrid] specify the right and upper bondaries of 
     202</div> 
     203             
     204            <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     205               
     206               
     207               
     208               
     209               
     210               
     211               
     212               
     213            </h4> 
     214         
     215            <div class="comments">=[rbgrid,ubgrid] specify the right and upper bondaries of 
    139216    the grid and check if some points are out. 
    140  
    141  OUTPUTS:the index on the cell accoring to the 2d array defined by 
    142  left and bottom. 
    143  
    144  OPTIONAL OUTPUTS: 
    145  
    146  COMMON BLOCKS: no 
    147  
    148  SIDE EFFECTS: 
    149  
    150  RESTRICTIONS: 
    151  
    152  PROCEDURE: 
    153  
    154  EXAMPLE: 
     217</div> 
     218             
     219           
     220 
     221          <h3>Examples</h3><div class="value">  
     222 res = inrecgrid(xin, yin, left, bottom) 
     223 
     224  
    155225 
    156226  IDL> a=indgen(5) 
     
    164234        3.00000      2.00000 
    165235        2.00000      1.00000 
    166    
    167  MODIFICATION HISTORY:</div> 
    168  
    169            
    170  
    171            
    172             <h3>Parameters</h3> 
    173          
    174              
    175             <h4 id="_inrecgrid_param_x1d">x1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183                
    184             </h4> 
    185          
    186           <div class="comments"></div> 
    187              
    188             <h4 id="_inrecgrid_param_y1d">y1d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196                
    197             </h4> 
    198          
    199           <div class="comments"></div> 
    200              
    201             <h4 id="_inrecgrid_param_left">left&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209                
    210             </h4> 
    211          
    212           <div class="comments"></div> 
    213              
    214             <h4 id="_inrecgrid_param_bottom">bottom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222                
    223             </h4> 
    224          
    225           <div class="comments"></div> 
    226              
    227  
    228            
    229  
    230            
    231  
    232             <h3>Keywords</h3> 
    233              
    234             <h4 id="_inrecgrid_keyword_output2d">output2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    235                
    236                
    237                
    238                
    239                
    240                
    241                
    242                
    243             </h4> 
    244          
    245             <div class="comments"></div> 
    246              
    247             <h4 id="_inrecgrid_keyword_checkout">checkout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    248                
    249                
    250                
    251                
    252                
    253                
    254                
    255                
    256             </h4> 
    257          
    258             <div class="comments"></div> 
    259              
    260            
    261  
    262            
    263            
    264            
    265            
    266            
     236  </div> 
     237          <h3>Version history</h3> 
     238           
     239           
     240          <h4>History</h4><div class="value"> 
     241            S. Masson (smasson@lodyc.jussieu.fr) 
     242                      July 3rd, 2002 
     243                      October 3rd, 2003: use value_locate</div> 
    267244           
    268245           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/ll_narcs_distances.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90 This function returns the longitude and latitude [lon, lat] of 
     91a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
     92from a specified location Lon0, lat0. 
     93       Same as LL_ARC_DISTANCE but for n points without do loop. 
     94 
     95 
     96Formula from Map Projections - a working manual.  USGS paper 
     971395.  Equations (5-5) and (5-6). 
     98</div> 
    9099 
    91100       
     
    102111        <div class="routine_details" id="_LL_NARCS_DISTANCES"> 
    103112 
    104           <h2><a class="top" href="#container">top</a>LL_NARCS_DISTANCES </h2> 
     113          <h2><a class="top" href="#container">top</a>LL_NARCS_DISTANCES <span class="categories"> Mapping, geography 
     114</span></h2> 
    105115         
    106116          <p class="header"> 
     
    108118         
    109119          <div class="comments"> 
    110  NAME: 
    111         LL_NARCS_DISTANCES 
    112  
    113  PURPOSE: 
    114         This function returns the longitude and latitude [lon, lat] of 
    115         a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    116         from a specified location Lon0, lat0. 
    117        Same as LL_ARC_DISTANCE but for n points without do loop. 
    118  
    119  CATEGORY: 
    120         Mapping, geography. 
    121  
    122  CALLING SEQUENCE: 
    123         Result = LL_NARCS_DISTANCES(Lon, lat0, Arc_Dist, Az) 
    124  
    125  INPUTS: 
    126         Lon0: An array containing the longitude of the starting point. 
    127              Values are assumed to be in radians unless the keyword 
    128              DEGREES is set. 
    129         Lat0: An array containing the latitude of the starting point. 
    130              Values are assumed to be in radians unless the keyword 
    131              DEGREES is set. 
    132         Arc_Dist: The arc distance from Lon_lat0. The value must be between 
    133                   -!PI and +!PI. To express distances in arc units, divide 
    134                   by the radius of the globe expressed in the original units. 
    135                   For example, if the radius of the earth is 6371 km, divide 
    136                   the distance in km by 6371 to obtain the arc distance.     
    137         Az:       The azimuth from Lon_lat0. The value is assumed to be in 
    138                   radians unless the keyword DEGREES is set. 
    139  
    140  KEYWORD PARAMETERS: 
    141         DEGREES:  Set this keyword to express all measurements and 
    142                   results in degrees. 
    143  
    144  OUTPUTS: 
    145         This function returns a (2, n) array containing the  
     120</div> 
     121 
     122          <h3>Return value</h3><div class="value"> 
     123 a (2, n) array containing the  
    146124       longitude / latitude of the resultings points. Values are in radians 
    147125       unless the keyword DEGREES is set. 
    148  
    149  PROCEDURE: 
    150         Formula from Map Projections - a working manual.  USGS paper 
    151         1395.  Equations (5-5) and (5-6). 
    152  
    153  EXAMPLE: 
    154         Lon_lat0 = [1.0, 2.0]           ; Initial point specified in radians     
    155         Arc_Dist = 2.0                  ; Arc distance in radians 
    156         Az = 1.0                        ; Azimuth in radians 
    157         Result = LL_ARC_DISTANCE(Lon_lat0, Arc_Dist, Az) 
    158         PRINT, Result 
    159           2.91415    -0.622234 
    160  
    161         IDL> lon0 = [-10, 20, 100] 
    162         IDL> lat0 = [0, -10, 45] 
    163         IDL> lon1 = [10, 60, 280] 
    164         IDL> lat1 = [0, 10, 45] 
    165         IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
    166         IDL> earthradius = 6378206.4d0 
    167         IDL> res = ll_narcs_distances(lon0, lat0, dist/earthradius, azi, /degrees) 
    168         IDL> print, reform(res[0, *]) 
    169                10.000000       60.000000       280.00000 
    170         IDL> print, reform(res[1, *]) 
     126</div> 
     127 
     128           
     129            <h3>Parameters</h3> 
     130         
     131             
     132            <h4 id="_LL_NARCS_DISTANCES_param_lon0">lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     133              <span class="attr">in</span> 
     134               
     135               
     136              <span class="attr">required</span> 
     137               
     138               
     139               
     140               
     141            </h4> 
     142         
     143          <div class="comments">  An array containing the longitude of the starting point. 
     144             Values are assumed to be in radians unless the keyword 
     145             DEGREES is set.</div> 
     146             
     147            <h4 id="_LL_NARCS_DISTANCES_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     148              <span class="attr">in</span> 
     149               
     150               
     151              <span class="attr">required</span> 
     152               
     153               
     154               
     155               
     156            </h4> 
     157         
     158          <div class="comments">  An array containing the latitude of the starting point. 
     159             Values are assumed to be in radians unless the keyword 
     160             DEGREES is set.</div> 
     161             
     162            <h4 id="_LL_NARCS_DISTANCES_param_arc_dist">arc_dist&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     163              <span class="attr">in</span> 
     164               
     165               
     166              <span class="attr">required</span> 
     167               
     168               
     169               
     170               
     171            </h4> 
     172         
     173          <div class="comments">  The arc distance from Lon_lat0. The value must be between 
     174 -!PI and +!PI. To express distances in arc units, divide 
     175  by the radius of the globe expressed in the original units. 
     176  For example, if the radius of the earth is 6371 km, divide 
     177  the distance in km by 6371 to obtain the arc distance.    </div> 
     178             
     179            <h4 id="_LL_NARCS_DISTANCES_param_az">az&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     180              <span class="attr">in</span> 
     181               
     182               
     183              <span class="attr">required</span> 
     184               
     185               
     186               
     187               
     188            </h4> 
     189         
     190          <div class="comments">   The azimuth from Lon_lat0. The value is assumed to be in 
     191  radians unless the keyword DEGREES is set. 
     192</div> 
     193             
     194 
     195           
     196 
     197           
     198 
     199            <h3>Keywords</h3> 
     200             
     201            <h4 id="_LL_NARCS_DISTANCES_keyword_DEGREES">DEGREES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     202               
     203               
     204               
     205               
     206               
     207               
     208               
     209               
     210            </h4> 
     211         
     212            <div class="comments">  Set this keyword to express all measurements and 
     213  results in degrees. 
     214</div> 
     215             
     216           
     217 
     218          <h3>Examples</h3><div class="value">  
     219Result = LL_NARCS_DISTANCES(Lon, lat0, Arc_Dist, Az) 
     220 
     221  
     222Lon_lat0 = [1.0, 2.0]; Initial point specified in radians 
     223Arc_Dist = 2.0; Arc distance in radians 
     224Az = 1.0; Azimuth in radians 
     225Result = LL_ARC_DISTANCE(Lon_lat0, Arc_Dist, Az) 
     226PRINT, Result 
     227       2.91415    -0.622234 
     228 
     229IDL> lon0 = [-10, 20, 100] 
     230IDL> lat0 = [0, -10, 45] 
     231IDL> lon1 = [10, 60, 280] 
     232IDL> lat1 = [0, 10, 45] 
     233IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
     234IDL> earthradius = 6378206.4d0 
     235IDL> res = ll_narcs_distances(lon0, lat0, dist/earthradius, azi, /degrees) 
     236IDL> print, reform(res[0, *]) 
     237       10.000000       60.000000       280.00000 
     238IDL> print, reform(res[1, *]) 
    171239          1.1999280e-15       10.000000       45.000000 
    172  
    173  MODIFICATION HISTORY: 
    174        Based on the IDL function ll_arc_distance.pro,v 1.11 2003/02/03</div> 
    175  
    176            
    177  
    178            
    179             <h3>Parameters</h3> 
    180          
    181              
    182             <h4 id="_LL_NARCS_DISTANCES_param_lon0">lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    183                
    184                
    185                
    186                
    187                
    188                
    189                
    190                
    191             </h4> 
    192          
    193           <div class="comments"></div> 
    194              
    195             <h4 id="_LL_NARCS_DISTANCES_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    196                
    197                
    198                
    199                
    200                
    201                
    202                
    203                
    204             </h4> 
    205          
    206           <div class="comments"></div> 
    207              
    208             <h4 id="_LL_NARCS_DISTANCES_param_arc_dist">arc_dist&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    209                
    210                
    211                
    212                
    213                
    214                
    215                
    216                
    217             </h4> 
    218          
    219           <div class="comments"></div> 
    220              
    221             <h4 id="_LL_NARCS_DISTANCES_param_az">az&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    222                
    223                
    224                
    225                
    226                
    227                
    228                
    229                
    230             </h4> 
    231          
    232           <div class="comments"></div> 
    233              
    234  
    235            
    236  
    237            
    238  
    239             <h3>Keywords</h3> 
    240              
    241             <h4 id="_LL_NARCS_DISTANCES_keyword_DEGREES">DEGREES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    242                
    243                
    244                
    245                
    246                
    247                
    248                
    249                
    250             </h4> 
    251          
    252             <div class="comments"></div> 
    253              
    254            
    255  
    256            
    257            
    258            
    259            
    260            
     240</div> 
     241          <h3>Version history</h3> 
     242           
     243           
     244          <h4>History</h4><div class="value"> 
     245       Based on the IDL function ll_arc_distance.pro,v 1.11 2003/02/03 
     246 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     247                  August 2005</div> 
    261248           
    262249           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/map_npoints.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_Map_npoints"> 
    103  
    104           <h2><a class="top" href="#container">top</a>Map_npoints </h2> 
    105          
    106           <p class="header"> 
    107             <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> 
    108          
    109           <div class="comments"> 
    110  NAME: 
    111         Map_nPoints 
    112  
    113  PURPOSE: 
    114         Return the distance in meter between all np0 points P0 and all 
     89      <div id="file_comments"> 
     90Return the distance in meter between all np0 points P0 and all 
    11591       np1 points P1 on a sphere. If keyword /TWO_BY_TWO is given then 
    11692       returns the distances between number n of P0 points and number 
     
    11894       Same as map_2points with the meter parameter but for n points 
    11995       without do loop. 
    120  
    121  CATEGORY: 
    122         Maps. 
    123  
    124  CALLING SEQUENCE: 
    125         Result = Map_nPoints(lon0, lat0, lon1, lat1) 
    126  
    127  INPUTS: 
    128         Lon0, Lat0 = np0 elements vector. longitudes and latitudes of 
    129         np0 points P0  
    130         Lon1, Lat1 = np1 elements vector. longitude and latitude of 
    131         np1 points P1  
    132  
    133  KEYWORD PARAMETERS: 
    134  
    135    AZIMUTH: A named variable that will receive the azimuth of the great 
    136        circle  connecting the two points, P0 to P1 
    137    /MIDDLE: to get the longitude/latitude of the middle point betwen P0 and P1. 
    138    RADIANS = if set, inputs and angular outputs are in radians, otherwise 
    139         degrees. 
    140    RADIUS: If given, return the distance between the two points 
    141         calculated using the given radius. 
    142        Default value is the earth radius : 6378206.4d0 
    143    TWO_BY_TWO:If given,then Map_nPoints returns the distances between 
    144        number n of P0 points and number n of P1 points (in that case, 
    145        np0 and np1 must be equal). 
    146  
    147  OUTPUTS: 
     96</div> 
     97 
     98       
     99 
     100       
     101 
     102       
     103 
     104       
     105 
     106      <div id="routine_details"> 
     107         
     108 
     109        <div class="routine_details" id="_Map_npoints"> 
     110 
     111          <h2><a class="top" href="#container">top</a>Map_npoints <span class="categories"> Maps 
     112</span></h2> 
     113         
     114          <p class="header"> 
     115            <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> 
     116         
     117          <div class="comments"> 
     118</div> 
     119 
     120          <h3>Return value</h3><div class="value"> 
    148121       An (np0,np1) array giving the distance in meter between np0 
    149122       points P0 and np1 points P1. Element (i,j) of the ouput is the 
     
    153126       and P1[i] (in that case, we have np0 = np1 = np) 
    154127       if /MIDDLE see this keyword. 
    155  
    156  EXAMPLES: 
    157         IDL> print, $ 
    158         map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
    159                7551369.3       5600334.8 
    160                12864354.       10921254. 
    161                14919237.       5455558.8 
    162          
    163         IDL> lon0 = [-10, 20, 100] 
    164         IDL> lat0 = [0, -10, 45] 
    165         IDL> lon1 = [10, 60, 280] 
    166         IDL> lat1 = [0, 10, 45] 
    167         IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi) 
    168         IDL> help, dist, azi 
    169         DIST            DOUBLE    = Array[3, 3] 
    170         AZI             DOUBLE    = Array[3, 3] 
    171         IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)] 
    172                2226414.0       4957944.5       10018863. 
    173                90.000000       64.494450   4.9615627e-15 
    174         IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
    175         IDL> help, dist, azi 
    176         DIST            DOUBLE    = Array[3] 
    177         AZI             DOUBLE    = Array[3] 
    178         IDL> print, dist, azi 
    179                2226414.0       4957944.5       10018863. 
    180                90.000000       64.494450   4.9615627e-15 
    181         IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0]) 
    182                20.000000       90.000000 
    183         IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], azi=azi)/6378206.4d0 / !dtor, azi 
    184                20.000000 
    185                90.000000 
    186  
    187         IDL> lon0 = [-10, 20, 100] 
    188         IDL> lat0 = [0, -10, 45] 
    189         IDL> lon1 = [10, 60, 280] 
    190         IDL> lat1 = [0, 10, 45] 
    191         IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /middle, /two_by_two) 
    192         IDL> print, reform(mid[0,*]), reform(mid[1,*]) 
    193                0.0000000       40.000000       190.00000 
    194                0.0000000  -1.5902773e-15       90.000000 
    195         IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1] 
    196                0.0000000       0.0000000 
    197         IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1] 
    198                40.000000  -1.5902773e-15 
    199         IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1] 
    200                190.00000       90.000000 
    201          
    202  MODIFICATION HISTORY: 
    203        Based on the IDL function map_2points.pro,v 1.6 2001/01/15</div> 
    204  
    205            
     128</div> 
    206129 
    207130           
     
    210133             
    211134            <h4 id="_Map_npoints_param_lon0">lon0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     135              <span class="attr">in</span> 
     136               
     137               
     138              <span class="attr">required</span> 
     139               
     140               
     141               
     142               
     143            </h4> 
     144         
     145          <div class="comments"> np0 elements vector. longitudes and latitudes of np0 points P0 </div> 
     146             
     147            <h4 id="_Map_npoints_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    212148               
    213149               
     
    222158          <div class="comments"></div> 
    223159             
    224             <h4 id="_Map_npoints_param_lat0">lat0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     160            <h4 id="_Map_npoints_param_lon1">lon1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     161              <span class="attr">in</span> 
     162               
     163               
     164              <span class="attr">required</span> 
     165               
     166               
     167               
     168               
     169            </h4> 
     170         
     171          <div class="comments">  np1 elements vector. longitude and latitude of np1 points P1  
     172</div> 
     173             
     174            <h4 id="_Map_npoints_param_lat1">lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    225175               
    226176               
     
    235185          <div class="comments"></div> 
    236186             
    237             <h4 id="_Map_npoints_param_lon1">lon1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    238                
    239                
    240                
    241                
    242                
    243                
    244                
    245                
    246             </h4> 
    247          
    248           <div class="comments"></div> 
    249              
    250             <h4 id="_Map_npoints_param_lat1">lat1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    251                
    252                
    253                
    254                
    255                
    256                
    257                
    258                
    259             </h4> 
    260          
    261           <div class="comments"></div> 
    262              
    263187 
    264188           
     
    279203            </h4> 
    280204         
    281             <div class="comments"></div> 
     205            <div class="comments"> A named variable that will receive the azimuth of the great 
     206       circle  connecting the two points, P0 to P1</div> 
    282207             
    283208            <h4 id="_Map_npoints_keyword_RADIANS">RADIANS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    292217            </h4> 
    293218         
    294             <div class="comments"></div> 
     219            <div class="comments"> = if set, inputs and angular outputs are in radians, otherwise 
     220degrees.</div> 
    295221             
    296222            <h4 id="_Map_npoints_keyword_RADIUS">RADIUS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    305231            </h4> 
    306232         
    307             <div class="comments"></div> 
     233            <div class="comments"> If given, return the distance between the two points 
     234calculated using the given radius. 
     235       Default value is the earth radius : 6378206.4d0</div> 
    308236             
    309237            <h4 id="_Map_npoints_keyword_MIDDLE">MIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    318246            </h4> 
    319247         
    320             <div class="comments"></div> 
     248            <div class="comments"> to get the longitude/latitude of the middle point betwen P0 and P1.</div> 
    321249             
    322250            <h4 id="_Map_npoints_keyword_TWO_BY_TWO">TWO_BY_TWO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    331259            </h4> 
    332260         
    333             <div class="comments"></div> 
    334              
    335            
    336  
    337            
    338            
    339            
    340            
    341            
     261            <div class="comments">:If given,then Map_nPoints returns the distances between 
     262       number n of P0 points and number n of P1 points (in that case, 
     263       np0 and np1 must be equal). 
     264</div> 
     265             
     266           
     267 
     268          <h3>Examples</h3><div class="value">  
     269Result = Map_nPoints(lon0, lat0, lon1, lat1) 
     270 
     271 
     272IDL> print, $ 
     273map_npoints([-105.15,1],[40.02,1],[-0.07,100,50],[51.30,20,0]) 
     274       7551369.3       5600334.8 
     275       12864354.       10921254. 
     276       14919237.       5455558.8 
     277 
     278IDL> lon0 = [-10, 20, 100] 
     279IDL> lat0 = [0, -10, 45] 
     280IDL> lon1 = [10, 60, 280] 
     281IDL> lat1 = [0, 10, 45] 
     282IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi) 
     283IDL> help, dist, azi 
     284DIST            DOUBLE    = Array[3, 3] 
     285AZI             DOUBLE    = Array[3, 3] 
     286IDL> print, dist[4*lindgen(3)], azi[4*lindgen(3)] 
     287       2226414.0       4957944.5       10018863. 
     288       90.000000       64.494450   4.9615627e-15 
     289IDL> dist = map_npoints(lon0, lat0, lon1, lat1, azimuth = azi, /two_by_two) 
     290IDL> help, dist, azi 
     291DIST            DOUBLE    = Array[3] 
     292AZI             DOUBLE    = Array[3] 
     293IDL> print, dist, azi 
     294       2226414.0       4957944.5       10018863. 
     295       90.000000       64.494450   4.9615627e-15 
     296IDL> print, map_2points(lon0[0], lat0[0], lon1[0], lat1[0]) 
     297       20.000000       90.000000 
     298IDL> print, map_npoints(lon0[0], lat0[0], lon1[0], lat1[0], azi=azi)/6378206.4d0 / !dtor, azi 
     299       20.000000 
     300       90.000000 
     301 
     302IDL> lon0 = [-10, 20, 100] 
     303IDL> lat0 = [0, -10, 45] 
     304IDL> lon1 = [10, 60, 280] 
     305IDL> lat1 = [0, 10, 45] 
     306IDL> mid = map_npoints(lon0, lat0, lon1, lat1, /middle, /two_by_two) 
     307IDL> print, reform(mid[0,*]), reform(mid[1,*]) 
     308       0.0000000       40.000000       190.00000 
     309       0.0000000  -1.5902773e-15       90.000000 
     310IDL> print, (map_2points(lon0[0], lat0[0], lon1[0], lat1[0], npath = 3))[*, 1] 
     311       0.0000000       0.0000000 
     312IDL> print, (map_2points(lon0[1], lat0[1], lon1[1], lat1[1], npath = 3))[*, 1] 
     313       40.000000  -1.5902773e-15 
     314IDL> print, (map_2points(lon0[2], lat0[2], lon1[2], lat1[2], npath = 3))[*, 1] 
     315       190.00000       90.000000 
     316</div> 
     317          <h3>Version history</h3> 
     318           
     319           
     320          <h4>History</h4><div class="value"> 
     321       Based on the IDL function map_2points.pro,v 1.6 2001/01/15 
     322 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     323                  October 2003</div> 
    342324           
    343325           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/neighbor.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90find the closetest point of (P0) within a list of np1 points 
     91P1 Which can be on a sphere  
     92</div> 
    9093 
    9194       
     
    102105        <div class="routine_details" id="_neighbor"> 
    103106 
    104           <h2><a class="top" href="#container">top</a>neighbor </h2> 
     107          <h2><a class="top" href="#container">top</a>neighbor <span class="categories"> Maps 
     108</span></h2> 
    105109         
    106110          <p class="header"> 
     
    108112         
    109113          <div class="comments"> 
    110  NAME: 
    111         neighbor 
    112  
    113  PURPOSE: 
    114         find the closetest point of (P0) within a list of np1 points 
    115         P1 Which can be on a sphere  
    116  
    117  CATEGORY: 
    118         Maps. 
    119  
    120  CALLING SEQUENCE: 
    121         Result = neighbor(lon0, lat0, lon1, lat1) 
    122  
    123  INPUTS: 
    124         Lon0, Lat0 = scalar. longitudes and latitudes of point P0.  
    125         Lon1, Lat1 = np1 elements vector. longitude and latitude of 
    126         np1 points P1  
    127  
    128  KEYWORD PARAMETERS: 
    129    RADIANS = if set, inputs and angular outputs are in radians, otherwise 
    130         degrees. 
    131    DISTANCE = dis, to get back the distances between P0 and the np1 
    132    points P1 in the variable dis. 
    133    /SPHERE to activate if points are located on a sphere. 
    134  
    135  OUTPUTS: 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="value"> 
    136117       index giving the P1[index] point that is the closetest point 
    137118       of (P0) 
    138  
    139  EXAMPLES: 
     119</div> 
     120 
     121           
     122            <h3>Parameters</h3> 
     123         
     124             
     125            <h4 id="_neighbor_param_p0lon">p0lon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
     127               
     128               
     129              <span class="attr">required</span> 
     130               
     131               
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments">  scalar. longitudes of point P0. </div> 
     137             
     138            <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     139              <span class="attr">in</span> 
     140               
     141               
     142              <span class="attr">required</span> 
     143               
     144               
     145               
     146               
     147            </h4> 
     148         
     149          <div class="comments">  scalar. latitudes of point P0.  
     150</div> 
     151             
     152            <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"></div> 
     164             
     165            <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     166               
     167               
     168               
     169               
     170               
     171               
     172               
     173               
     174            </h4> 
     175         
     176          <div class="comments"></div> 
     177             
     178 
     179           
     180 
     181           
     182 
     183            <h3>Keywords</h3> 
     184             
     185            <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193               
     194            </h4> 
     195         
     196            <div class="comments"> to activate if points are located on a sphere. 
     197</div> 
     198             
     199            <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     200               
     201               
     202               
     203               
     204               
     205               
     206               
     207               
     208            </h4> 
     209         
     210            <div class="comments"> dis, to get back the distances between P0 and the np1 
     211   points P1 in the variable dis.</div> 
     212             
     213            <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     214               
     215               
     216               
     217               
     218               
     219               
     220               
     221               
     222            </h4> 
     223         
     224            <div class="comments"> if set, inputs and angular outputs are in radians, otherwise 
     225degrees.</div> 
     226             
     227           
     228 
     229          <h3>Examples</h3><div class="value">  
     230 IDL> Result = neighbor(lon0, lat0, lon1, lat1) 
     231 
     232 
    140233       IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $ 
    141234            distance=dis) 
     
    143236       IDL> print, dis 
    144237             105.684      206.125      160.228 
    145  
    146  MODIFICATION HISTORY:</div> 
    147  
    148            
    149  
    150            
    151             <h3>Parameters</h3> 
    152          
    153              
    154             <h4 id="_neighbor_param_p0lon">p0lon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    155                
    156                
    157                
    158                
    159                
    160                
    161                
    162                
    163             </h4> 
    164          
    165           <div class="comments"></div> 
    166              
    167             <h4 id="_neighbor_param_p0lat">p0lat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    168                
    169                
    170                
    171                
    172                
    173                
    174                
    175                
    176             </h4> 
    177          
    178           <div class="comments"></div> 
    179              
    180             <h4 id="_neighbor_param_neighlon">neighlon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    181                
    182                
    183                
    184                
    185                
    186                
    187                
    188                
    189             </h4> 
    190          
    191           <div class="comments"></div> 
    192              
    193             <h4 id="_neighbor_param_neighlat">neighlat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    194                
    195                
    196                
    197                
    198                
    199                
    200                
    201                
    202             </h4> 
    203          
    204           <div class="comments"></div> 
    205              
    206  
    207            
    208  
    209            
    210  
    211             <h3>Keywords</h3> 
    212              
    213             <h4 id="_neighbor_keyword_sphere">sphere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    214                
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222             </h4> 
    223          
    224             <div class="comments"></div> 
    225              
    226             <h4 id="_neighbor_keyword_distance">distance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    227                
    228                
    229                
    230                
    231                
    232                
    233                
    234                
    235             </h4> 
    236          
    237             <div class="comments"></div> 
    238              
    239             <h4 id="_neighbor_keyword_radians">radians&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    240                
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248             </h4> 
    249          
    250             <div class="comments"></div> 
    251              
    252            
    253  
    254            
    255            
    256            
    257            
    258            
     238</div> 
     239          <h3>Version history</h3> 
     240           
     241           
     242          <h4>History</h4><div class="value"> 
     243 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     244                  October 2003</div> 
    259245           
    260246           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/quadrilateral2square.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_quadrilateral2square"> 
    103  
    104           <h2><a class="top" href="#container">top</a>quadrilateral2square </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>quadrilateral2square(<span class="result"><a href="#_quadrilateral2square_param_x0in">x0in</a>, <a href="#_quadrilateral2square_param_y0in">y0in</a>, <a href="#_quadrilateral2square_param_x1in">x1in</a>, <a href="#_quadrilateral2square_param_y1in">y1in</a>, <a href="#_quadrilateral2square_param_x2in">x2in</a>, <a href="#_quadrilateral2square_param_y2in">y2in</a>, <a href="#_quadrilateral2square_param_x3in">x3in</a>, <a href="#_quadrilateral2square_param_y3in">y3in</a>, <a href="#_quadrilateral2square_param_xxin">xxin</a>, <a href="#_quadrilateral2square_param_yyin">yyin</a></span>, <a href="#_quadrilateral2square_keyword_PERF">PERF</a>=<span class="result">PERF</span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME:quadrilateral2square 
    111  
    112  PURPOSE:warm (or map) an arbitrary quadrilateral onto a unit square  
     89      <div id="file_comments"> warm (or map) an arbitrary quadrilateral onto a unit square  
    11390 according to the 4-point correspondences: 
    11491       (x0,y0) -> (0,0) 
     
    12097 lines in all orientations and permit quadrilateral to quadrilateral 
    12198 mappings. see ref. bellow. 
    122  
    123  CATEGORY:image/grid manipulation 
    124  
    125  CALLING SEQUENCE: 
    126  
    127      res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3,xin,yin) 
    128   
    129  INPUTS: 
    130  
    131      x0,y0,x1,y1,x2,y2,x3,y3 the coordinates of the quadrilateral 
    132      (see above for correspondance with the unit square). Can be 
    133      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    134      given in the anticlockwise order. 
    135  
    136      xin,yin:the coordinates of the point(s) for which we want to do the 
    137      mapping. Can be scalar or array. 
    138  
    139  KEYWORD PARAMETERS: 
    140  
    141     /DOUBLE: use double precision to perform the computation  
    142  
    143  OUTPUTS: 
     99</div> 
     100 
     101       
     102 
     103       
     104 
     105       
     106 
     107       
     108 
     109      <div id="routine_details"> 
     110         
     111 
     112        <div class="routine_details" id="_quadrilateral2square"> 
     113 
     114          <h2><a class="top" href="#container">top</a>quadrilateral2square <span class="categories"> image, grid manipulation 
     115</span></h2> 
     116         
     117          <p class="header"> 
     118            <span class="result">result = </span>quadrilateral2square(<span class="result"><a href="#_quadrilateral2square_param_x0in">x0in</a>, <a href="#_quadrilateral2square_param_y0in">y0in</a>, <a href="#_quadrilateral2square_param_x1in">x1in</a>, <a href="#_quadrilateral2square_param_y1in">y1in</a>, <a href="#_quadrilateral2square_param_x2in">x2in</a>, <a href="#_quadrilateral2square_param_y2in">y2in</a>, <a href="#_quadrilateral2square_param_x3in">x3in</a>, <a href="#_quadrilateral2square_param_y3in">y3in</a>, <a href="#_quadrilateral2square_param_xxin">xxin</a>, <a href="#_quadrilateral2square_param_yyin">yyin</a></span>, <a href="#_quadrilateral2square_keyword_PERF">PERF</a>=<span class="result">PERF</span>)</p> 
     119         
     120          <div class="comments"> 
     121</div> 
     122 
     123          <h3>Return value</h3><div class="value"> 
    144124 
    145125     (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
     
    148128     x0. If xin is an array , then n is equal to the number of 
    149129     elements of xin. 
    150  
    151  COMMON BLOCKS:none 
    152  
    153  SIDE EFFECTS: 
    154  
    155  RESTRICTIONS: I think degenerated quadrilateral (e.g. flat of 
    156  twisted) is not work. This has to be tested. 
    157  
    158  EXAMPLE: 
     130</div> 
     131 
     132           
     133            <h3>Parameters</h3> 
     134         
     135             
     136            <h4 id="_quadrilateral2square_param_x0in">x0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     137              <span class="attr">in</span> 
     138               
     139               
     140              <span class="attr">required</span> 
     141               
     142               
     143               
     144               
     145            </h4> 
     146         
     147          <div class="comments">  the coordinates of the quadrilateral</div> 
     148             
     149            <h4 id="_quadrilateral2square_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150              <span class="attr">in</span> 
     151               
     152               
     153              <span class="attr">required</span> 
     154               
     155               
     156               
     157               
     158            </h4> 
     159         
     160          <div class="comments">  the coordinates of the quadrilateral</div> 
     161             
     162            <h4 id="_quadrilateral2square_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     163              <span class="attr">in</span> 
     164               
     165               
     166              <span class="attr">required</span> 
     167               
     168               
     169               
     170               
     171            </h4> 
     172         
     173          <div class="comments">  the coordinates of the quadrilateral</div> 
     174             
     175            <h4 id="_quadrilateral2square_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     176              <span class="attr">in</span> 
     177               
     178               
     179              <span class="attr">required</span> 
     180               
     181               
     182               
     183               
     184            </h4> 
     185         
     186          <div class="comments">  the coordinates of the quadrilateral</div> 
     187             
     188            <h4 id="_quadrilateral2square_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     189              <span class="attr">in</span> 
     190               
     191               
     192              <span class="attr">required</span> 
     193               
     194               
     195               
     196               
     197            </h4> 
     198         
     199          <div class="comments">  the coordinates of the quadrilateral</div> 
     200             
     201            <h4 id="_quadrilateral2square_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     202              <span class="attr">in</span> 
     203               
     204               
     205              <span class="attr">required</span> 
     206               
     207               
     208               
     209               
     210            </h4> 
     211         
     212          <div class="comments">  the coordinates of the quadrilateral</div> 
     213             
     214            <h4 id="_quadrilateral2square_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     215              <span class="attr">in</span> 
     216               
     217               
     218              <span class="attr">required</span> 
     219               
     220               
     221               
     222               
     223            </h4> 
     224         
     225          <div class="comments">  the coordinates of the quadrilateral</div> 
     226             
     227            <h4 id="_quadrilateral2square_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     228              <span class="attr">in</span> 
     229               
     230               
     231              <span class="attr">required</span> 
     232               
     233               
     234               
     235               
     236            </h4> 
     237         
     238          <div class="comments">  the coordinates of the quadrilateral 
     239     (see above for correspondance with the unit square). Can be 
     240     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     241     given in the anticlockwise order. 
     242</div> 
     243             
     244            <h4 id="_quadrilateral2square_param_xxin">xxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     245              <span class="attr">in</span> 
     246               
     247               
     248              <span class="attr">required</span> 
     249               
     250               
     251               
     252               
     253            </h4> 
     254         
     255          <div class="comments"> the coordinates of the point(s) for which we want to do the 
     256     mapping. Can be scalar or array.</div> 
     257             
     258            <h4 id="_quadrilateral2square_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     259              <span class="attr">in</span> 
     260               
     261               
     262              <span class="attr">required</span> 
     263               
     264               
     265               
     266               
     267            </h4> 
     268         
     269          <div class="comments"> the coordinates of the point(s) for which we want to do the 
     270     mapping. Can be scalar or array. 
     271</div> 
     272             
     273 
     274           
     275 
     276           
     277 
     278            <h3>Keywords</h3> 
     279             
     280            <h4 id="_quadrilateral2square_keyword_PERF">PERF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     281               
     282               
     283               
     284               
     285               
     286               
     287               
     288               
     289            </h4> 
     290         
     291            <div class="comments"></div> 
     292             
     293           
     294 
     295          <h3>Examples</h3><div class="value">  
     296 
     297     res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3,xin,yin) 
     298  
     299  
    159300 
    160301 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
     
    167308 IDL> inorg=quadrilateral2square(2,1,3,0,5,1,2,3,out[0,*],out[1,*]) 
    168309 IDL> tracegrille, reform(inorg[0,*],11,11), reform(inorg[1,*],11,11),color=indgen(12)*20 
    169  
    170  MODIFICATION HISTORY:</div> 
    171  
    172            
    173  
    174            
    175             <h3>Parameters</h3> 
    176          
    177              
    178             <h4 id="_quadrilateral2square_param_x0in">x0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    179                
    180                
    181                
    182                
    183                
    184                
    185                
    186                
    187             </h4> 
    188          
    189           <div class="comments"></div> 
    190              
    191             <h4 id="_quadrilateral2square_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    192                
    193                
    194                
    195                
    196                
    197                
    198                
    199                
    200             </h4> 
    201          
    202           <div class="comments"></div> 
    203              
    204             <h4 id="_quadrilateral2square_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    205                
    206                
    207                
    208                
    209                
    210                
    211                
    212                
    213             </h4> 
    214          
    215           <div class="comments"></div> 
    216              
    217             <h4 id="_quadrilateral2square_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    218                
    219                
    220                
    221                
    222                
    223                
    224                
    225                
    226             </h4> 
    227          
    228           <div class="comments"></div> 
    229              
    230             <h4 id="_quadrilateral2square_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    231                
    232                
    233                
    234                
    235                
    236                
    237                
    238                
    239             </h4> 
    240          
    241           <div class="comments"></div> 
    242              
    243             <h4 id="_quadrilateral2square_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    244                
    245                
    246                
    247                
    248                
    249                
    250                
    251                
    252             </h4> 
    253          
    254           <div class="comments"></div> 
    255              
    256             <h4 id="_quadrilateral2square_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    257                
    258                
    259                
    260                
    261                
    262                
    263                
    264                
    265             </h4> 
    266          
    267           <div class="comments"></div> 
    268              
    269             <h4 id="_quadrilateral2square_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    270                
    271                
    272                
    273                
    274                
    275                
    276                
    277                
    278             </h4> 
    279          
    280           <div class="comments"></div> 
    281              
    282             <h4 id="_quadrilateral2square_param_xxin">xxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    283                
    284                
    285                
    286                
    287                
    288                
    289                
    290                
    291             </h4> 
    292          
    293           <div class="comments"></div> 
    294              
    295             <h4 id="_quadrilateral2square_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    296                
    297                
    298                
    299                
    300                
    301                
    302                
    303                
    304             </h4> 
    305          
    306           <div class="comments"></div> 
    307              
    308  
    309            
    310  
    311            
    312  
    313             <h3>Keywords</h3> 
    314              
    315             <h4 id="_quadrilateral2square_keyword_PERF">PERF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    316                
    317                
    318                
    319                
    320                
    321                
    322                
    323                
    324             </h4> 
    325          
    326             <div class="comments"></div> 
    327              
    328            
    329  
    330            
    331            
    332            
    333            
    334            
    335            
    336            
    337            
    338            
    339            
    340            
    341            
     310</div> 
     311          <h3>Version history</h3> 
     312           
     313           
     314          <h4>History</h4><div class="value"> 
     315      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     316      August 2003 
     317      Based on "Digital Image Warping" by G. Wolberg 
     318      IEEE Computer Society Press, Los Alamitos, California 
     319      Chapter 3, see p 52-56 
     320      </div> 
     321           
     322           
     323          <h3>Known issues</h3> 
     324           
     325           
     326           
     327          <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
     328 twisted) is not work. This has to be tested. 
     329</div> 
    342330         
    343331           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_fstdrv.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_spl_fstdrv"> 
    103  
    104           <h2><a class="top" href="#container">top</a>spl_fstdrv </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>spl_fstdrv(<span class="result"><a href="#_spl_fstdrv_param_x">x</a>, <a href="#_spl_fstdrv_param_y">y</a>, <a href="#_spl_fstdrv_param_yscd">yscd</a>, <a href="#_spl_fstdrv_param_x2">x2</a></span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME:spl_fstdrv 
    111  
    112  PURPOSE: SPL_FSTDRV returns the values of the first derivative of 
     89      <div id="file_comments"> SPL_FSTDRV returns the values of the first derivative of 
    11390 the interpolating function at the points X2i. it is a double 
    11491 precision array. 
     
    11996 of X2. The interpolation method is based on cubic spline, corrected 
    12097 in a way that interpolated value are also in ascending order 
    121  
    122  CATEGORY: 
    123  
    124  CALLING SEQUENCE: y2 =  spl_fstdrv(x, y, yscd, x2) 
    125  
    126  INPUTS: 
    127  
    128     x: An n-element (at least 2) input vector that specifies the 
     98</div> 
     99 
     100       
     101 
     102       
     103 
     104       
     105 
     106       
     107 
     108      <div id="routine_details"> 
     109         
     110 
     111        <div class="routine_details" id="_spl_fstdrv"> 
     112 
     113          <h2><a class="top" href="#container">top</a>spl_fstdrv </h2> 
     114         
     115          <p class="header"> 
     116            <span class="result">result = </span>spl_fstdrv(<span class="result"><a href="#_spl_fstdrv_param_x">x</a>, <a href="#_spl_fstdrv_param_y">y</a>, <a href="#_spl_fstdrv_param_yscd">yscd</a>, <a href="#_spl_fstdrv_param_x2">x2</a></span>)</p> 
     117         
     118          <div class="comments"> 
     119</div> 
     120 
     121          <h3>Return value</h3><div class="value">  
     122 
     123    y2: f'(x2) = y2.  
     124 
     125</div> 
     126 
     127           
     128            <h3>Parameters</h3> 
     129         
     130             
     131            <h4 id="_spl_fstdrv_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     132              <span class="attr">in</span> 
     133               
     134               
     135              <span class="attr">required</span> 
     136               
     137               
     138               
     139               
     140            </h4> 
     141         
     142          <div class="comments">  An n-element (at least 2) input vector that specifies the 
    129143    tabulate points in ascending order. 
    130  
    131     y: f(x) = y. An n-element input vector that specifies the values 
     144</div> 
     145             
     146            <h4 id="_spl_fstdrv_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     147              <span class="attr">in</span> 
     148               
     149               
     150              <span class="attr">required</span> 
     151               
     152               
     153               
     154               
     155            </h4> 
     156         
     157          <div class="comments">  f(x) = y. An n-element input vector that specifies the values 
    132158    of the tabulated function F(Xi) corresponding to Xi. 
    133  
    134     yscd: The output from SPL_INIT for the specified X and Y. 
    135  
    136     x2: The input values for which the first derivative values are 
     159</div> 
     160             
     161            <h4 id="_spl_fstdrv_param_yscd">yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     162              <span class="attr">in</span> 
     163               
     164               
     165              <span class="attr">required</span> 
     166               
     167               
     168               
     169               
     170            </h4> 
     171         
     172          <div class="comments">  The output from SPL_INIT for the specified X and Y. 
     173</div> 
     174             
     175            <h4 id="_spl_fstdrv_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     176              <span class="attr">in</span> 
     177               
     178               
     179              <span class="attr">required</span> 
     180               
     181               
     182               
     183               
     184            </h4> 
     185         
     186          <div class="comments">  The input values for which the first derivative values are 
    137187    desired. X can be scalar or an array of values. 
    138  
    139  KEYWORD PARAMETERS: none 
    140  
    141  OUTPUTS:  
    142  
    143     y2: f'(x2) = y2.  
    144  
    145  COMMON BLOCKS: none 
    146  
    147  SIDE EFFECTS: ? 
    148  
    149  RESTRICTIONS: ? 
    150  
    151  EXAMPLE: 
    152  
    153  MODIFICATION HISTORY:</div> 
    154  
    155            
    156  
    157            
    158             <h3>Parameters</h3> 
    159          
    160              
    161             <h4 id="_spl_fstdrv_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    162                
    163                
    164                
    165                
    166                
    167                
    168                
    169                
    170             </h4> 
    171          
    172           <div class="comments"></div> 
    173              
    174             <h4 id="_spl_fstdrv_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    175                
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183             </h4> 
    184          
    185           <div class="comments"></div> 
    186              
    187             <h4 id="_spl_fstdrv_param_yscd">yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188                
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196             </h4> 
    197          
    198           <div class="comments"></div> 
    199              
    200             <h4 id="_spl_fstdrv_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    201                
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209             </h4> 
    210          
    211           <div class="comments"></div> 
    212              
    213  
    214            
    215  
    216            
    217  
    218            
    219            
    220            
    221            
    222            
     188</div> 
     189             
     190 
     191           
     192 
     193           
     194 
     195          <h3>Examples</h3><div class="value">  y2 =  spl_fstdrv(x, y, yscd, x2) 
     196</div> 
     197          <h3>Version history</h3> 
     198           
     199           
     200          <h4>History</h4><div class="value"> 
     201  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005</div> 
    223202           
    224203           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_incr.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90 
     91 Given the arrays X and Y, which tabulate a function (with the X[i] 
     92 AND Y[i] in ascending order), and given an input value X2, the 
     93 SPL_INCR function returns an interpolated value for the given values 
     94 of X2. The interpolation method is based on cubic spline, corrected 
     95 in a way that interpolated values are also monotonically increasing. 
     96</div> 
    9097 
    9198       
     
    102109           
    103110          <dt><p><a href="#_pure_concave"><span class="result">result = </span>pure_concave(<span class="result">x1, x2, y1, y2, der2, x</span>)</a></p><dt> 
    104           <dd>  NAME:spl_incr   PURPOSE:   Given the arrays X and Y, which tabulate a function (with the X[i]  AND Y[i] in ascending order), and given an input value X2, the  SPL_INCR function returns an interpolated value for the given values  of X2.</dd>         
     111          <dd> </dd>     
    105112           
    106113          <dt><p><a href="#_pure_convex"><span class="result">result = </span>pure_convex(<span class="result">x1, x2, y1, y2, der2, x</span>)</a></p><dt> 
     
    125132         
    126133          <div class="comments"> 
    127  NAME:spl_incr 
    128  
    129  PURPOSE: 
    130  
    131  Given the arrays X and Y, which tabulate a function (with the X[i] 
    132  AND Y[i] in ascending order), and given an input value X2, the 
    133  SPL_INCR function returns an interpolated value for the given values 
    134  of X2. The interpolation method is based on cubic spline, corrected 
    135  in a way that interpolated values are also monotonically increasing. 
    136  
    137  CATEGORY: 
    138  
    139  CALLING SEQUENCE: y2 =  spl_incr(x, y, x2) 
    140  
    141  INPUTS: 
    142  
    143     x: An n-element (at least 2) input vector that specifies the 
     134</div> 
     135 
     136          <h3>Return value</h3><div class="value">  
     137 
     138    y2: f(x2) = y2. Double precision array 
     139</div> 
     140 
     141           
     142            <h3>Parameters</h3> 
     143         
     144             
     145            <h4 id="_pure_concave_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     146              <span class="attr">in</span> 
     147               
     148               
     149              <span class="attr">required</span> 
     150               
     151               
     152               
     153               
     154            </h4> 
     155         
     156          <div class="comments">  An n-element (at least 2) input vector that specifies the 
    144157    tabulate points in a strict ascending order. 
    145  
    146     y: f(x) = y. An n-element input vector that specifies the values 
     158</div> 
     159             
     160            <h4 id="_pure_concave_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     161              <span class="attr">in</span> 
     162               
     163               
     164              <span class="attr">required</span> 
     165               
     166               
     167               
     168               
     169            </h4> 
     170         
     171          <div class="comments">  The input values for which the interpolated values are 
     172    desired. Its values must be strictly monotonically increasing.  
     173 
     174 
     175 
     176</div> 
     177             
     178            <h4 id="_pure_concave_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179              <span class="attr">in</span> 
     180               
     181               
     182              <span class="attr">required</span> 
     183               
     184               
     185               
     186               
     187            </h4> 
     188         
     189          <div class="comments">  f(x) = y. An n-element input vector that specifies the values 
    147190    of the tabulated function F(Xi) corresponding to Xi. As f is 
    148191    supposed to be monotonically increasing, y values must be 
    149192    monotonically increasing. y can have equal consecutive values. 
    150  
    151     x2: The input values for which the interpolated values are 
    152     desired. Its values must be strictly monotonically increasing.  
    153  
    154  KEYWORD PARAMETERS: 
    155  
    156     YP0: The first derivative of the interpolating function at the 
    157     point X0. If YP0 is omitted, the second derivative at the 
    158     boundary is set to zero, resulting in a "natural spline." 
    159  
    160     YPN_1: The first derivative of the interpolating function at the 
    161     point Xn-1. If YPN_1 is omitted, the second derivative at the 
    162     boundary is set to zero, resulting in a "natural spline."  
    163  
    164  OUTPUTS:  
    165  
    166     y2: f(x2) = y2. Double precision array 
    167  
    168  COMMON BLOCKS: none 
    169  
    170  SIDE EFFECTS: ? 
    171  
    172  RESTRICTIONS: 
    173    It might be possible that y2[i+1]-y2[i] has very small negative 
    174    values (amplitude smaller than 1.e-6)... 
    175  
    176  EXAMPLE: 
     193</div> 
     194             
     195            <h4 id="_pure_concave_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     196               
     197               
     198               
     199               
     200               
     201               
     202               
     203               
     204            </h4> 
     205         
     206          <div class="comments"></div> 
     207             
     208            <h4 id="_pure_concave_param_der2">der2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     209               
     210               
     211               
     212               
     213               
     214               
     215               
     216               
     217            </h4> 
     218         
     219          <div class="comments"></div> 
     220             
     221            <h4 id="_pure_concave_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     222               
     223               
     224               
     225               
     226               
     227               
     228               
     229               
     230            </h4> 
     231         
     232          <div class="comments"></div> 
     233             
     234 
     235           
     236 
     237           
     238 
     239          <h3>Examples</h3><div class="value">  y2 =  spl_incr(x, y, x2) 
     240 
     241  
    177242 
    178243     n = 100L 
     
    194259     splot,c,xstyle=1,ystyle=1, yrange=[-.01,.05], ysurx=.25, petit = [1, 2, 2], /noerase 
    195260     oplot,[0, n_elements(c)], [0, 0], linestyle = 1 
    196  
    197  MODIFICATION HISTORY:</div> 
    198  
    199            
    200  
    201            
    202             <h3>Parameters</h3> 
    203          
    204              
    205             <h4 id="_pure_concave_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    206                
    207                
    208                
    209                
    210                
    211                
    212                
    213                
    214             </h4> 
    215          
    216           <div class="comments"></div> 
    217              
    218             <h4 id="_pure_concave_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    219                
    220                
    221                
    222                
    223                
    224                
    225                
    226                
    227             </h4> 
    228          
    229           <div class="comments"></div> 
    230              
    231             <h4 id="_pure_concave_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    232                
    233                
    234                
    235                
    236                
    237                
    238                
    239                
    240             </h4> 
    241          
    242           <div class="comments"></div> 
    243              
    244             <h4 id="_pure_concave_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    245                
    246                
    247                
    248                
    249                
    250                
    251                
    252                
    253             </h4> 
    254          
    255           <div class="comments"></div> 
    256              
    257             <h4 id="_pure_concave_param_der2">der2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    258                
    259                
    260                
    261                
    262                
    263                
    264                
    265                
    266             </h4> 
    267          
    268           <div class="comments"></div> 
    269              
    270             <h4 id="_pure_concave_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    271                
    272                
    273                
    274                
    275                
    276                
    277                
    278                
    279             </h4> 
    280          
    281           <div class="comments"></div> 
    282              
    283  
    284            
    285  
    286            
    287  
    288            
    289            
    290            
    291            
    292            
    293            
    294            
    295            
    296            
    297            
    298            
    299            
     261</div> 
     262          <h3>Version history</h3> 
     263           
     264           
     265          <h4>History</h4><div class="value"> 
     266  Sebastien Masson (smasson@lodyc.jussieu.fr): May-Dec 2005</div> 
     267           
     268           
     269          <h3>Known issues</h3> 
     270           
     271           
     272           
     273          <h4>Restrictions</h4><div class="value"> 
     274   It might be possible that y2[i+1]-y2[i] has very small negative 
     275   values (amplitude smaller than 1.e-6)... 
     276</div> 
    300277         
    301278           
     
    508485            </h4> 
    509486         
    510             <div class="comments"></div> 
     487            <div class="comments"> The first derivative of the interpolating function at the 
     488    point X0. If YP0 is omitted, the second derivative at the 
     489    boundary is set to zero, resulting in a "natural spline."</div> 
    511490             
    512491            <h4 id="_spl_incr_keyword_YPN_1">YPN_1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    521500            </h4> 
    522501         
    523             <div class="comments"></div> 
     502            <div class="comments"> The first derivative of the interpolating function at the 
     503    point Xn-1. If YPN_1 is omitted, the second derivative at the 
     504    boundary is set to zero, resulting in a "natural spline." </div> 
    524505             
    525506           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_keep_mean.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_spl_keep_mean"> 
    103  
    104           <h2><a class="top" href="#container">top</a>spl_keep_mean </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>spl_keep_mean(<span class="result"><a href="#_spl_keep_mean_param_x">x</a>, <a href="#_spl_keep_mean_param_yin">yin</a>, <a href="#_spl_keep_mean_param_x2">x2</a></span>, <a href="#_spl_keep_mean_keyword_YP0">YP0</a>=<span class="result">YP0</span>, <a href="#_spl_keep_mean_keyword_YPN_1">YPN_1</a>=<span class="result">YPN_1</span>, <a href="#_spl_keep_mean_keyword_GE0">GE0</a>=<span class="result">GE0</span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME:spl_keep_mean 
    111  
    112  PURPOSE: 
     89      <div id="file_comments"> 
    11390 
    11491 Given the arrays X and Y, which tabulate a function (with the X[i] 
     
    12097 from monthly mean and keep the monthly mean of the computed daily 
    12198 data equa to the original values) 
    122  
    123  CATEGORY: 
    124  
    125  CALLING SEQUENCE: y2 =  spl_keep_mean(x, y, x2) 
    126  
    127  INPUTS: 
    128  
    129     x: An n-element (at least 2) input vector that specifies the 
     99</div> 
     100 
     101       
     102 
     103       
     104 
     105       
     106 
     107       
     108 
     109      <div id="routine_details"> 
     110         
     111 
     112        <div class="routine_details" id="_spl_keep_mean"> 
     113 
     114          <h2><a class="top" href="#container">top</a>spl_keep_mean </h2> 
     115         
     116          <p class="header"> 
     117            <span class="result">result = </span>spl_keep_mean(<span class="result"><a href="#_spl_keep_mean_param_x">x</a>, <a href="#_spl_keep_mean_param_yin">yin</a>, <a href="#_spl_keep_mean_param_x2">x2</a></span>, <a href="#_spl_keep_mean_keyword_YP0">YP0</a>=<span class="result">YP0</span>, <a href="#_spl_keep_mean_keyword_YPN_1">YPN_1</a>=<span class="result">YPN_1</span>, <a href="#_spl_keep_mean_keyword_GE0">GE0</a>=<span class="result">GE0</span>)</p> 
     118         
     119          <div class="comments"></div> 
     120 
     121          <h3>Return value</h3><div class="value">  
     122 
     123    y2: the meean value between two consecutive values of x2. This 
     124    array has one element less than y2. y2 has double precision. 
     125</div> 
     126 
     127           
     128            <h3>Parameters</h3> 
     129         
     130             
     131            <h4 id="_spl_keep_mean_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     132              <span class="attr">in</span> 
     133               
     134               
     135              <span class="attr">required</span> 
     136               
     137               
     138               
     139               
     140            </h4> 
     141         
     142          <div class="comments">  An n-element (at least 2) input vector that specifies the 
    130143    tabulate points in a strict ascending order. 
    131  
    132     y: an array with one element less than x. y[i] represents the 
     144</div> 
     145             
     146            <h4 id="_spl_keep_mean_param_yin">yin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     147              <span class="attr">in</span> 
     148               
     149               
     150              <span class="attr">required</span> 
     151               
     152               
     153               
     154               
     155            </h4> 
     156         
     157          <div class="comments">  an array with one element less than x. y[i] represents the 
    133158    mean value between x[i] and x[i+1]. if /GE0 is activated, y must 
    134159    have positive values. 
    135  
    136     x2: The input values for which the interpolated values are 
     160</div> 
     161             
     162            <h4 id="_spl_keep_mean_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     163              <span class="attr">in</span> 
     164               
     165               
     166              <span class="attr">required</span> 
     167               
     168               
     169               
     170               
     171            </h4> 
     172         
     173          <div class="comments">  The input values for which the interpolated values are 
    137174    desired. Its values must be strictly monotonically increasing.  
    138175 
    139  KEYWORD PARAMETERS: 
    140  
    141     /GE0: to force that y2 is always GE than 0. In that case, y must 
    142     also be GE than 0. 
    143  
    144     YP0: The first derivative of the interpolating function at the 
     176</div> 
     177             
     178 
     179           
     180 
     181           
     182 
     183            <h3>Keywords</h3> 
     184             
     185            <h4 id="_spl_keep_mean_keyword_YP0">YP0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193               
     194            </h4> 
     195         
     196            <div class="comments"> The first derivative of the interpolating function at the 
    145197    point X0. If YP0 is omitted, the second derivative at the 
    146198    boundary is set to zero, resulting in a "natural spline." 
    147  
    148     YPN_1: The first derivative of the interpolating function at the 
     199</div> 
     200             
     201            <h4 id="_spl_keep_mean_keyword_YPN_1">YPN_1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     202               
     203               
     204               
     205               
     206               
     207               
     208               
     209               
     210            </h4> 
     211         
     212            <div class="comments"> The first derivative of the interpolating function at the 
    149213    point Xn-1. If YPN_1 is omitted, the second derivative at the 
    150214    boundary is set to zero, resulting in a "natural spline."  
    151  
    152  OUTPUTS:  
    153  
    154     y2: the meean value between two consecutive values of x2. This 
    155     array has one element less than y2. y2 has double precision. 
    156  
    157  COMMON BLOCKS: none 
    158  
    159  SIDE EFFECTS: ? 
    160  
    161  RESTRICTIONS: 
    162    It might be possible that y2 has very small negative values 
    163    (amplitude smaller than 1.e-6)...  
    164  
    165  
    166  EXAMPLE: 
     215</div> 
     216             
     217            <h4 id="_spl_keep_mean_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     218               
     219               
     220               
     221               
     222               
     223               
     224               
     225               
     226            </h4> 
     227         
     228            <div class="comments"> to force that y2 is always GE than 0. In that case, y must 
     229    also be GE than 0. 
     230</div> 
     231             
     232           
     233 
     234          <h3>Examples</h3><div class="value">  y2 =  spl_keep_mean(x, y, x2) 
     235 
     236  
    167237 
    168238    12 monthly values of precipitations into daily values: 
     
    185255    print, total(y*(x[1:n1-1]-x[0:n1-2])) 
    186256    print, total(y2*(x2[1:n2-1]-x2[0:n2-2])) 
    187  
    188  MODIFICATION HISTORY:</div> 
    189  
    190            
    191  
    192            
    193             <h3>Parameters</h3> 
    194          
    195              
    196             <h4 id="_spl_keep_mean_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    197                
    198                
    199                
    200                
    201                
    202                
    203                
    204                
    205             </h4> 
    206          
    207           <div class="comments"></div> 
    208              
    209             <h4 id="_spl_keep_mean_param_yin">yin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    210                
    211                
    212                
    213                
    214                
    215                
    216                
    217                
    218             </h4> 
    219          
    220           <div class="comments"></div> 
    221              
    222             <h4 id="_spl_keep_mean_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    223                
    224                
    225                
    226                
    227                
    228                
    229                
    230                
    231             </h4> 
    232          
    233           <div class="comments"></div> 
    234              
    235  
    236            
    237  
    238            
    239  
    240             <h3>Keywords</h3> 
    241              
    242             <h4 id="_spl_keep_mean_keyword_YP0">YP0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    243                
    244                
    245                
    246                
    247                
    248                
    249                
    250                
    251             </h4> 
    252          
    253             <div class="comments"></div> 
    254              
    255             <h4 id="_spl_keep_mean_keyword_YPN_1">YPN_1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    256                
    257                
    258                
    259                
    260                
    261                
    262                
    263                
    264             </h4> 
    265          
    266             <div class="comments"></div> 
    267              
    268             <h4 id="_spl_keep_mean_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    269                
    270                
    271                
    272                
    273                
    274                
    275                
    276                
    277             </h4> 
    278          
    279             <div class="comments"></div> 
    280              
    281            
    282  
    283            
    284            
    285            
    286            
    287            
    288            
    289            
    290            
    291            
    292            
    293            
    294            
     257</div> 
     258          <h3>Version history</h3> 
     259           
     260           
     261          <h4>History</h4><div class="value"> 
     262  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005</div> 
     263           
     264           
     265          <h3>Known issues</h3> 
     266           
     267           
     268           
     269          <h4>Restrictions</h4><div class="value"> 
     270   It might be possible that y2 has very small negative values 
     271   (amplitude smaller than 1.e-6)...  
     272 
     273</div> 
    295274         
    296275           
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/square2quadrilateral.html

    r89 r101  
    7272<div id="secondary_navbar"> 
    7373 
    74 <a href="spl_keep_mean.html">&lt;&lt;prev file</a> | <a href="testinterp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="square2quadrilateral.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="spl_keep_mean.html">&lt;&lt;prev file</a> | <a href="testinterp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="square2quadrilateral.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
     
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_square2quadrilateral"> 
    103  
    104           <h2><a class="top" href="#container">top</a>square2quadrilateral </h2> 
    105          
    106           <p class="header"> 
    107             <span class="result">result = </span>square2quadrilateral(<span class="result"><a href="#_square2quadrilateral_param_x0in">x0in</a>, <a href="#_square2quadrilateral_param_y0in">y0in</a>, <a href="#_square2quadrilateral_param_x1in">x1in</a>, <a href="#_square2quadrilateral_param_y1in">y1in</a>, <a href="#_square2quadrilateral_param_x2in">x2in</a>, <a href="#_square2quadrilateral_param_y2in">y2in</a>, <a href="#_square2quadrilateral_param_x3in">x3in</a>, <a href="#_square2quadrilateral_param_y3in">y3in</a>, <a href="#_square2quadrilateral_param_xxin">xxin</a>, <a href="#_square2quadrilateral_param_yyin">yyin</a></span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME:square2quadrilateral 
    111  
    112  PURPOSE:warm (or map) a unit square onto an arbitrary quadrilateral 
     89      <div id="file_comments"> warm (or map) a unit square onto an arbitrary quadrilateral 
    11390 according to the 4-point correspondences: 
    11491       (0,0) -> (x0,y0) 
     
    11996 lines in all orientations and permit quadrilateral to quadrilateral 
    12097 mappings. see ref. bellow. 
    121  
    122  CATEGORY:image/grid manipulation 
    123  
    124  CALLING SEQUENCE: 
     98</div> 
     99 
     100       
     101 
     102       
     103 
     104       
     105 
     106       
     107      <div id="routine_summary">                 
     108        <h2>Routine summary</h2> 
     109         
     110        <dl> 
     111           
     112          <dt><p><a href="#_square2quadrilateral"><span class="result">result = </span>square2quadrilateral(<span class="result">x0in, y0in, x1in, y1in, x2in, y2in, x3in, y3in, xxin, yyin</span>)</a></p><dt> 
     113          <dd> </dd>     
     114           
     115          <dt><p><a href="#_square2quadrilateral"><span class="result">result = </span>square2quadrilateral(<span class="result">x0in, y0in, x1in, y1in, x2in, y2in, x3in, y3in, xxin, yyin</span>)</a></p><dt> 
     116          <dd></dd>      
     117                 
     118        </dl> 
     119      </div> 
     120       
     121 
     122      <div id="routine_details"> 
     123         
     124 
     125        <div class="routine_details" id="_square2quadrilateral"> 
     126 
     127          <h2><a class="top" href="#container">top</a>square2quadrilateral <span class="categories"> image, grid manipulation 
     128</span></h2> 
     129         
     130          <p class="header"> 
     131            <span class="result">result = </span>square2quadrilateral(<span class="result"><a href="#_square2quadrilateral_param_x0in">x0in</a>, <a href="#_square2quadrilateral_param_y0in">y0in</a>, <a href="#_square2quadrilateral_param_x1in">x1in</a>, <a href="#_square2quadrilateral_param_y1in">y1in</a>, <a href="#_square2quadrilateral_param_x2in">x2in</a>, <a href="#_square2quadrilateral_param_y2in">y2in</a>, <a href="#_square2quadrilateral_param_x3in">x3in</a>, <a href="#_square2quadrilateral_param_y3in">y3in</a>, <a href="#_square2quadrilateral_param_xxin">xxin</a>, <a href="#_square2quadrilateral_param_yyin">yyin</a></span>)</p> 
     132         
     133          <div class="comments"> 
     134</div> 
     135 
     136           
     137 
     138           
     139            <h3>Parameters</h3> 
     140         
     141             
     142            <h4 id="_square2quadrilateral_param_x0in">x0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     143               
     144               
     145               
     146               
     147               
     148               
     149               
     150               
     151            </h4> 
     152         
     153          <div class="comments"></div> 
     154             
     155            <h4 id="_square2quadrilateral_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     156               
     157               
     158               
     159               
     160               
     161               
     162               
     163               
     164            </h4> 
     165         
     166          <div class="comments"></div> 
     167             
     168            <h4 id="_square2quadrilateral_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     169               
     170               
     171               
     172               
     173               
     174               
     175               
     176               
     177            </h4> 
     178         
     179          <div class="comments"></div> 
     180             
     181            <h4 id="_square2quadrilateral_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     182               
     183               
     184               
     185               
     186               
     187               
     188               
     189               
     190            </h4> 
     191         
     192          <div class="comments"></div> 
     193             
     194            <h4 id="_square2quadrilateral_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     195               
     196               
     197               
     198               
     199               
     200               
     201               
     202               
     203            </h4> 
     204         
     205          <div class="comments"></div> 
     206             
     207            <h4 id="_square2quadrilateral_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     208               
     209               
     210               
     211               
     212               
     213               
     214               
     215               
     216            </h4> 
     217         
     218          <div class="comments"></div> 
     219             
     220            <h4 id="_square2quadrilateral_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     221               
     222               
     223               
     224               
     225               
     226               
     227               
     228               
     229            </h4> 
     230         
     231          <div class="comments"></div> 
     232             
     233            <h4 id="_square2quadrilateral_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     234               
     235               
     236               
     237               
     238               
     239               
     240               
     241               
     242            </h4> 
     243         
     244          <div class="comments"></div> 
     245             
     246            <h4 id="_square2quadrilateral_param_xxin">xxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     247               
     248               
     249               
     250               
     251               
     252               
     253               
     254               
     255            </h4> 
     256         
     257          <div class="comments"></div> 
     258             
     259            <h4 id="_square2quadrilateral_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     260               
     261               
     262               
     263               
     264               
     265               
     266               
     267               
     268            </h4> 
     269         
     270          <div class="comments"></div> 
     271             
     272 
     273           
     274 
     275           
     276 
     277          <h3>Examples</h3><div class="value">  
    125278 
    126279     res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3[,xin,yin]) 
    127   
    128  INPUTS: 
    129  
    130      x0,y0,x1,y1,x2,y2,x3,y3 the coordinates of the quadrilateral 
    131      (see above for correspondance with the unit square). Can be 
    132      scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
    133      given in the anticlockwise order. 
    134  
    135      xin,yin:the coordinates of the point(s) for which we want to do the 
    136      mapping. Can be scalar or array. 
    137  
    138  KEYWORD PARAMETERS: 
    139  
    140     /DOUBLE: use double precision to perform the computation  
    141  
    142  OUTPUTS: 
    143  
    144      (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
    145      point(s) after mapping.  
    146      If xin is a scalar, then n is equal to the number of elements of 
    147      x0. If xin is an array , then n is equal to the number of 
    148      elements of xin. 
    149      If xin and yin are omited, square2quadrilateral returns the 
    150      matrix A which is used for the inverse transformation.  
    151  
    152  COMMON BLOCKS:none 
    153  
    154  SIDE EFFECTS: 
    155  
    156  RESTRICTIONS: I think degenerated quadrilateral (e.g. flat of 
    157  twisted) is not work. This has to be tested. 
    158  
    159  EXAMPLE: 
    160  
    161  IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
    162  IDL> tracegrille, findgen(11)*.1, findgen(11)*.1,color=indgen(12)*20 
    163  IDL> xin = (findgen(11)*.1)#replicate(1, 11) 
    164  IDL> yin = replicate(1, 11)#(findgen(11)*.1) 
    165  IDL> out = square2quadrilateral(2,1,3,0,5,1,2,3, xin, yin) 
    166  IDL> tracegrille, reform(out[0,*],11,11), reform(out[1,*],11,11),color=indgen(12)*20 
    167  
    168  MODIFICATION HISTORY:</div> 
     280 </div> 
     281           
     282           
     283           
     284           
     285           
     286           
     287           
     288           
     289           
     290           
     291           
     292         
     293           
     294           
     295           
     296           
     297           
     298           
     299           
     300         
     301           
     302         
     303        </div> 
     304         
     305 
     306        <div class="routine_details" id="_square2quadrilateral"> 
     307 
     308          <h2><a class="top" href="#container">top</a>square2quadrilateral </h2> 
     309         
     310          <p class="header"> 
     311            <span class="result">result = </span>square2quadrilateral(<span class="result"><a href="#_square2quadrilateral_param_x0in">x0in</a>, <a href="#_square2quadrilateral_param_y0in">y0in</a>, <a href="#_square2quadrilateral_param_x1in">x1in</a>, <a href="#_square2quadrilateral_param_y1in">y1in</a>, <a href="#_square2quadrilateral_param_x2in">x2in</a>, <a href="#_square2quadrilateral_param_y2in">y2in</a>, <a href="#_square2quadrilateral_param_x3in">x3in</a>, <a href="#_square2quadrilateral_param_y3in">y3in</a>, <a href="#_square2quadrilateral_param_xxin">xxin</a>, <a href="#_square2quadrilateral_param_yyin">yyin</a></span>)</p> 
     312         
     313          <div class="comments"></div> 
    169314 
    170315           
Note: See TracChangeset for help on using the changeset viewer.