Changeset 151 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_c.html

Timestamp:

08/09/06 12:21:11 (18 years ago)

Author:

navarro

Message:

english and nicer header (3b)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_c.html (modified) (8 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_c.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Construct the triangulation array.
+
+ The idea is: construct a list of triangle which link points between them. 
+ This is automatically done by the function TRIANGULATE
+  Here:
+ we consider the fact that points are disposed on a grid (regular or not, 
+ but not unstructured, that is to say that points are written following a 
+ rectangular matrix). A easy way to do triangles between all points is then: 
+
+     for each point (i,j) of the matrix -exept those of the last line and of
+     the last column- we call rectangle (i,j) the rectangle made of the four
+     points (i,j), (i+1,j), (i,j+1), (i+1,j+1). To trace all triangle, we just
+     have to trace the 2 triangles contained in rectangles (i,j)
+
+ We notice that each rectangle (i,j) have 2 diagonals (it is true... Make a
+ drawing to make sure!!), so there are two possible choice for each rectangle
+ we want to cut in 2 triangles...
+ 
+ It is thanks to this choice that we will be able to trace coast with right
+ angles. At each angle of coast remarkable by the existence of an unique land
+ point or of an unique ocean point on one of the four summit of a rectangle (i,j),
+ we have to cut the rectangle following the diagonal passing by this point.
+ </div>
 
       
@@ -711 +734 @@
         <div class="routine_details" id="_triangule_c">
 
-          <h2><a class="top" href="#container">top</a>triangule_c </h2>
+          <h2><a class="top" href="#container">top</a>triangule_c <span class="categories">
+ graphic
+</span></h2>
         
           <p class="header">
-            <span class="result">result = </span>triangule_c(<span class="result"><a href="#_triangule_c_param_maskentree">maskentree</a></span>, <a href="#_triangule_c_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_c_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_c_keyword_KEEP_CONT">KEEP_CONT</a>=<span class="result">KEEP_CONT</span>)</p>
+            <span class="result">result = </span>triangule_c(<span class="result">[<a href="#_triangule_c_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_c_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_c_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_c_keyword_KEEP_CONT">KEEP_CONT</a>=<span class="result">KEEP_CONT</span>)</p>
         
           <div class="comments">
- NAME:triangule_c
-
- PURPOSE:construit le tableau de triangulation.
-
- L''idee est de
- construire une liste de triangles qui relient les points entre
- eux. Ceci est fait automatiquement avec la fonction TRIANGULATE.
-  ICI:
- on tient compte du fait que les points sont disposes sur une grille
- (reguliere ou pas, mais pas destructuree, cad que les points sont
- ecrits suivant une matrice rectangulaire). Un moyen tres simple de
- faire des triangles entre tous les points est alors:
-
-     pour chaque point (i,j) de la matrice -sauf ceux de la derniere
-     ligne et de la derniere colonne- on on appelle le rectangle
-     (i,j) le rectangle forme par les 4 points (i,j), (i+1,j),
-     (i,j+1), (i+1,j+1). Pour tracer tous les triangles, il suffit de
-     tracer les 2 triangles contenus ds les rectangles (i,j)
-
- au passage on remarque que chaque rectangle (i,j) possede 2 diagonales (si
- si faites un dessin c''est vrai), il y a donc 2 choix possibles pour
- chaque rectangles qd on veut le couper en 2 triangles...
- 
- C''est grace a ce choix que l''on va pouvoir tracer les cotes avec
- des angles droits. A chaque angle de cote remarquable par
- l''existance d''un unique point terre ou d''un unique point mer sur
- les 4 cotes d''un rectangle (i,j), il faut couper le rectangle
- suivant la diagonale qui qui passe par le point singulier.
- 
- CATEGORY:pour faire de beaux graphiques masques
-
- CALLING SEQUENCE:res=triangule([mask])
-
- INPUTS:optionnel:mask c''est le tableau 2d qui sevira a masquer le
- champ que l''on tracera apres avec CONTOUR,
- ...TRIANGULATION=triangule(mask)
- si cet argument n''est pas specifie, la function utilise tmask.
-
- KEYWORD PARAMETERS:
-
-       /BASIC: specifie que le masque est sur une grille basice
-       (utiliser pour la triangulation ds les coupes verticales et
-       des hovmoellers)
-
-       /KEEP_CONT: to keep the triangulation even on the continents
-
-       COINMONTE=tableau, pour obtenir le tableau de "coins de terre
-       montant" a traiter avec completecointerre.pro ds la variable
-       tableau plutot que de la faire passer par la variable globale
-       twin_corners_up.
-
-       COINDESCEND=tableau cf COINMONTE
-
- OUTPUTS:
-       res: tableau 2d (3,nbre de triangles).
-    chaque ligne de res represente les indices des points
-    constituants les sommets d''un triangle.
-    cf. comment on trace les triangles ds dessinetri.pro
-
- COMMON BLOCKS:
-        common.pro different.pro definetri.pro
-
- SIDE EFFECTS:
-
- RESTRICTIONS:les donnees dont un veut ensuite faire le contour
- doivent etre disposees dans une matrice. Par contre dans la matrice,
- la disposition des points peut ne pas etre irreguliere. Si les
- donnees sont disposees completement de facon irreguliere, utiliser
- TRIANGULE.
-
- EXAMPLE:
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ res: tableau 2d (3,nbre de triangles).
+ Each line of res represent indexes of points constituing summits of a triangle. 
+ See how we trace triangles in definetri.pro
+</div>
 
           
@@ -797 +755 @@
             
             <h4 id="_triangule_c_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
+              <span class="attr">in</span>
+              
+              <span class="attr">optional</span>
               
               
@@ -807 +765 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ It is a 2d array which will serve to mask the field we will trace after with CONTOUR, 
+ ...TRIANGULATION=triangule(mask)
+ If this argument is not specified, the function use tmask
+</div>
             
 
@@ -827 +789 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ It is an array. To obtain the array of "ascending land corner" to be treated with 
+ completecointerre.pro in the variable array instead of make it pass by the global 
+ variable twin_corners_up.
+</div>
             
             <h4 id="_triangule_c_keyword_COINDESCEND">COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -840 +806 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ It is an array. See COINMONTE
+</div>
             
             <h4 id="_triangule_c_keyword_BASIC">BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -853 +821 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
+</div>
             
             <h4 id="_triangule_c_keyword_KEEP_CONT">KEEP_CONT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -866 +836 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ To keep the triangulation even on the continents
+</div>
             
           
 
           
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id: triangule_c.pro 150 2006-08-09 10:12:54Z navarro $
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          <h4>Todo items</h4><div class="preformat">
+ seb L.267->268 je ne pense pas que ce soit ce que tu voulais dire mais 
+ c'est la traduction de ce qu'il y avait écrit. Correction si besoin.</div>
+          <h4>Restrictions</h4><div class="preformat">
+ Datas whose we want to do the contour must be disposed in a matrix. 
+ On the other hand, in the matrix, the points's arrangement can not be 
+ irregular. If it is, use TRIANGULE.
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+ different.pro
+ definetri.pro
+</div>