Ignore:
Timestamp:
06/12/06 16:49:30 (18 years ago)
Author:
pinsard
Message:

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

File:
1 edited

Legend:

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

    r104 r106  
    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 | <a href="#routine_summary">routine</a>&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 | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
     
    105105 
    106106       
    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        
    121107 
    122108      <div id="routine_details"> 
     
    134120</div> 
    135121 
    136            
     122          <h3>Return value</h3><div class="value"> 
     123 
     124     (2,n) array: the new coodinates (xout, yout) of the (xin,yin) 
     125     point(s) after mapping.  
     126     If xin is a scalar, then n is equal to the number of elements of 
     127     x0. If xin is an array , then n is equal to the number of 
     128     elements of xin. 
     129     If xin and yin are omited, square2quadrilateral returns the 
     130     matrix A which is used for the inverse transformation.  
     131 
     132</div> 
    137133 
    138134           
     
    141137             
    142138            <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> 
     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">  the coordinates of the quadrilateral 
     150     (see above for correspondance with the unit square). Can be 
     151     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     152     given in the anticlockwise order.</div> 
    154153             
    155154            <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> 
     155              <span class="attr">in</span> 
     156               
     157               
     158              <span class="attr">required</span> 
     159               
     160               
     161               
     162               
     163            </h4> 
     164         
     165          <div class="comments">  the coordinates of the quadrilateral 
     166     (see above for correspondance with the unit square). Can be 
     167     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     168     given in the anticlockwise order.</div> 
    167169             
    168170            <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> 
     171              <span class="attr">in</span> 
     172               
     173               
     174              <span class="attr">required</span> 
     175               
     176               
     177               
     178               
     179            </h4> 
     180         
     181          <div class="comments">  the coordinates of the quadrilateral 
     182     (see above for correspondance with the unit square). Can be 
     183     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     184     given in the anticlockwise order.</div> 
    180185             
    181186            <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> 
     187              <span class="attr">in</span> 
     188               
     189               
     190              <span class="attr">required</span> 
     191               
     192               
     193               
     194               
     195            </h4> 
     196         
     197          <div class="comments">  the coordinates of the quadrilateral 
     198     (see above for correspondance with the unit square). Can be 
     199     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     200     given in the anticlockwise order.</div> 
    193201             
    194202            <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> 
     203              <span class="attr">in</span> 
     204               
     205               
     206              <span class="attr">required</span> 
     207               
     208               
     209               
     210               
     211            </h4> 
     212         
     213          <div class="comments">  the coordinates of the quadrilateral 
     214     (see above for correspondance with the unit square). Can be 
     215     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     216     given in the anticlockwise order.</div> 
    206217             
    207218            <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              <span class="attr">in</span> 
     220               
     221               
     222              <span class="attr">required</span> 
     223               
     224               
     225               
     226               
     227            </h4> 
     228         
     229          <div class="comments">  the coordinates of the quadrilateral 
     230     (see above for correspondance with the unit square). Can be 
     231     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     232     given in the anticlockwise order.</div> 
    219233             
    220234            <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> 
     235              <span class="attr">in</span> 
     236               
     237               
     238              <span class="attr">required</span> 
     239               
     240               
     241               
     242               
     243            </h4> 
     244         
     245          <div class="comments">  the coordinates of the quadrilateral 
     246     (see above for correspondance with the unit square). Can be 
     247     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     248     given in the anticlockwise order.</div> 
    232249             
    233250            <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> 
     251              <span class="attr">in</span> 
     252               
     253               
     254              <span class="attr">required</span> 
     255               
     256               
     257               
     258               
     259            </h4> 
     260         
     261          <div class="comments">  the coordinates of the quadrilateral 
     262     (see above for correspondance with the unit square). Can be 
     263     scalar or array. (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are 
     264     given in the anticlockwise order. 
     265</div> 
    245266             
    246267            <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> 
     268              <span class="attr">in</span> 
     269               
     270               
     271              <span class="attr">required</span> 
     272               
     273               
     274               
     275               
     276            </h4> 
     277         
     278          <div class="comments"> the coordinates of the point(s) for which we want to do the 
     279     mapping. Can be scalar or array.</div> 
    258280             
    259281            <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> 
     282              <span class="attr">in</span> 
     283               
     284               
     285              <span class="attr">required</span> 
     286               
     287               
     288               
     289               
     290            </h4> 
     291         
     292          <div class="comments"> the coordinates of the point(s) for which we want to do the 
     293     mapping. Can be scalar or array. 
     294</div> 
    271295             
    272296 
     
    276300 
    277301          <h3>Examples</h3><div class="value">  
    278  
    279      res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3[,xin,yin]) 
    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> 
    314  
    315            
    316  
    317            
    318             <h3>Parameters</h3> 
    319          
    320              
    321             <h4 id="_square2quadrilateral_param_x0in">x0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    322                
    323                
    324                
    325                
    326                
    327                
    328                
    329                
    330             </h4> 
    331          
    332           <div class="comments"></div> 
    333              
    334             <h4 id="_square2quadrilateral_param_y0in">y0in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    335                
    336                
    337                
    338                
    339                
    340                
    341                
    342                
    343             </h4> 
    344          
    345           <div class="comments"></div> 
    346              
    347             <h4 id="_square2quadrilateral_param_x1in">x1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    348                
    349                
    350                
    351                
    352                
    353                
    354                
    355                
    356             </h4> 
    357          
    358           <div class="comments"></div> 
    359              
    360             <h4 id="_square2quadrilateral_param_y1in">y1in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    361                
    362                
    363                
    364                
    365                
    366                
    367                
    368                
    369             </h4> 
    370          
    371           <div class="comments"></div> 
    372              
    373             <h4 id="_square2quadrilateral_param_x2in">x2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    374                
    375                
    376                
    377                
    378                
    379                
    380                
    381                
    382             </h4> 
    383          
    384           <div class="comments"></div> 
    385              
    386             <h4 id="_square2quadrilateral_param_y2in">y2in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    387                
    388                
    389                
    390                
    391                
    392                
    393                
    394                
    395             </h4> 
    396          
    397           <div class="comments"></div> 
    398              
    399             <h4 id="_square2quadrilateral_param_x3in">x3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    400                
    401                
    402                
    403                
    404                
    405                
    406                
    407                
    408             </h4> 
    409          
    410           <div class="comments"></div> 
    411              
    412             <h4 id="_square2quadrilateral_param_y3in">y3in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    413                
    414                
    415                
    416                
    417                
    418                
    419                
    420                
    421             </h4> 
    422          
    423           <div class="comments"></div> 
    424              
    425             <h4 id="_square2quadrilateral_param_xxin">xxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    426                
    427                
    428                
    429                
    430                
    431                
    432                
    433                
    434             </h4> 
    435          
    436           <div class="comments"></div> 
    437              
    438             <h4 id="_square2quadrilateral_param_yyin">yyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    439                
    440                
    441                
    442                
    443                
    444                
    445                
    446                
    447             </h4> 
    448          
    449           <div class="comments"></div> 
    450              
    451  
    452            
    453  
    454            
    455  
    456            
    457            
    458            
    459            
    460            
    461            
    462            
    463            
    464            
    465            
    466            
    467            
     302 IDL>  res = square2quadrilateral(x0,y0,x1,y1,x2,y2,x3,y3[,xin,yin]) 
     303  
     304  
     305 
     306 IDL> splot,[0,5],[0,3],/nodata,xstyle=1,ystyle=1 
     307 IDL> tracegrille, findgen(11)*.1, findgen(11)*.1,color=indgen(12)*20 
     308 IDL> xin = (findgen(11)*.1)#replicate(1, 11) 
     309 IDL> yin = replicate(1, 11)#(findgen(11)*.1) 
     310 IDL> out = square2quadrilateral(2,1,3,0,5,1,2,3, xin, yin) 
     311 IDL> tracegrille, reform(out[0,*],11,11), reform(out[1,*],11,11),color=indgen(12)*20 
     312</div> 
     313          <h3>Version history</h3> 
     314           
     315           
     316          <h4>History</h4><div class="value"> 
     317      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     318      August 2003 
     319      Based on "Digital Image Warping" by G. Wolberg 
     320      IEEE Computer Society Press, Los Alamitos, California 
     321      Chapter 3, see p 52-56 
     322      </div> 
     323           
     324           
     325          <h3>Known issues</h3> 
     326           
     327           
     328           
     329          <h4>Restrictions</h4><div class="value"> I think degenerated quadrilateral (e.g. flat of 
     330 twisted) is not work. This has to be tested. 
     331</div> 
    468332         
    469333           
Note: See TracChangeset for help on using the changeset viewer.