Ignore:
Timestamp:
08/09/06 12:21:11 (18 years ago)
Author:
navarro
Message:

english and nicer header (3b)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri.html

    r138 r151  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
    699  
    700        
    701  
    702        
    703  
    704        
    705  
    706        
    707  
    708       <div id="routine_details"> 
    709          
    710  
    711         <div class="routine_details" id="_definetri"> 
    712  
    713           <h2><a class="top" href="#container">top</a>definetri </h2> 
    714          
    715           <p class="header"> 
    716             <span class="result">result = </span>definetri(<span class="result"><a href="#_definetri_param_nx">nx</a>, <a href="#_definetri_param_ny">ny</a>, <a href="#_definetri_param_downward">downward</a></span>)</p> 
    717          
    718           <div class="comments"> 
    719  NAME:definetri 
    720  
    721  PURPOSE:Define a triangulation array like TRIANGULATE.  
     698      <div id="file_comments"> 
     699 efine a triangulation array like TRIANGULATE.  
    722700         But in a VERY SIMPLE CASE: 
    723701 the points are regulary-gridded on nx*ny array. 
     
    746724 
    747725          *---*                        *---* 
    748           |  /|                        |\  | 
    749           | / |                        | \ | 
    750           |/  |                        |  \| 
     726          |  /|                        |  | 
     727          | / |                        | | 
     728          |/  |                        |  | 
    751729          *---*                        *---*   
    752730 
    753  
    754  CATEGORY: to understand how TRIANGULATE and TRIANGULATION work! 
    755  
    756  CALLING SEQUENCE:triangles=definetri(nx, ny [,downward]) 
    757   
    758  INPUTS: nx and ny are the array dimensions  
    759  
    760  OPTIONAL INPUTS: 
    761  
    762         downward: When downward is undefine all rectangles are cut 
    763         in using the upward diagonal. Downward is a vector which 
    764         contains the rectangles numbers which are cut in using the 
    765         downward diagonal. 
    766         The rectangle number is define by the index (in a nx*ny 
    767         vector) of the lower-left corner of the rectangle. 
    768  
    769  KEYWORD PARAMETERS: 
    770  
    771  OUTPUTS: 
    772         triangles is a 2d array and is dimensions are 3 and 
    773         2*(nx-1)*(ny-1) 
    774         triangles is define like in the TRIANGULATE procedure. 
    775          
    776  
    777  OPTIONAL OUTPUTS: 
    778  
    779  COMMON BLOCKS: 
    780  
    781  SIDE EFFECTS: 
    782  
    783  RESTRICTIONS: 
    784  
    785  PROCEDURE: 
    786  
    787  EXAMPLE: 
     731</div> 
     732 
     733       
     734 
     735       
     736 
     737       
     738 
     739       
     740 
     741      <div id="routine_details"> 
     742         
     743 
     744        <div class="routine_details" id="_definetri"> 
     745 
     746          <h2><a class="top" href="#container">top</a>definetri <span class="categories"> 
     747 utilities 
     748 </span></h2> 
     749         
     750          <p class="header"> 
     751            <span class="result">result = </span>definetri(<span class="result"><a href="#_definetri_param_nx">nx</a>, <a href="#_definetri_param_ny">ny</a>[, <a href="#_definetri_param_downward">downward</a>]</span>)</p> 
     752         
     753          <div class="comments"> 
     754</div> 
     755 
     756          <h3>Return value</h3><div class="preformat"> 
     757 triangles is a 2d array and is dimensions are 3 and 
     758 2*(nx-1)*(ny-1) 
     759 triangles is define like in the TRIANGULATE procedure. 
     760</div> 
     761 
     762           
     763            <h3>Parameters</h3> 
     764         
     765             
     766            <h4 id="_definetri_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     767              <span class="attr">in</span> 
     768               
     769               
     770              <span class="attr">required</span> 
     771               
     772               
     773               
     774               
     775            </h4> 
     776         
     777          <div class="comments"> 
     778 The x dimension array 
     779</div> 
     780             
     781            <h4 id="_definetri_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     782              <span class="attr">in</span> 
     783               
     784               
     785              <span class="attr">required</span> 
     786               
     787               
     788               
     789               
     790            </h4> 
     791         
     792          <div class="comments"> 
     793 The y dimension array 
     794</div> 
     795             
     796            <h4 id="_definetri_param_downward">downward&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     797              <span class="attr">in</span> 
     798               
     799              <span class="attr">optional</span> 
     800               
     801               
     802               
     803               
     804               
     805            </h4> 
     806         
     807          <div class="comments"> 
     808 When downward is undefine all rectangles are cut 
     809 in using the upward diagonal. Downward is a vector which 
     810 contains the rectangles numbers which are cut in using the 
     811 downward diagonal. 
     812 The rectangle number is define by the index (in a nx*ny 
     813 vector) of the lower-left corner of the rectangle. 
     814</div> 
     815             
     816 
     817           
     818 
     819           
     820 
     821          <h3>Examples</h3><div class="preformat"> 
    788822 
    789823 triangles=definetri(3,3,[1,3]) 
     
    791825 
    792826          *---*---* 
    793           |\  |  /| 
    794           | \ | / | 
    795           |  \|/  | 
     827          |  |  /| 
     828          | | / | 
     829          |  |/  | 
    796830          *---*---* 
    797           |  /|\  | 
    798           | / | \ | 
    799           |/  |  \| 
     831          |  /|  | 
     832          | / | | 
     833          |/  |  | 
    800834          *---*---* 
    801835 
    802836</div> 
    803  
    804            
    805  
    806            
    807             <h3>Parameters</h3> 
    808          
    809              
    810             <h4 id="_definetri_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    811                
    812                
    813                
    814                
    815                
    816                
    817                
    818                
    819             </h4> 
    820          
    821           <div class="comments"></div> 
    822              
    823             <h4 id="_definetri_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    824                
    825                
    826                
    827                
    828                
    829                
    830                
    831                
    832             </h4> 
    833          
    834           <div class="comments"></div> 
    835              
    836             <h4 id="_definetri_param_downward">downward&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    837                
    838                
    839                
    840                
    841                
    842                
    843                
    844                
    845             </h4> 
    846          
    847           <div class="comments"></div> 
    848              
    849  
    850            
    851  
    852            
    853  
    854            
    855            
    856            
    857            
    858            
     837          <h3>Version history</h3> 
     838           
     839          <h4>Version</h4><div class="preformat"> 
     840 $Id: definetri.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     841          <h4>History</h4><div class="preformat"></div> 
    859842           
    860843           
Note: See TracChangeset for help on using the changeset viewer.