source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/triangule_c.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>triangule_c.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="triangule.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="triangule_e.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/TRIANGULATION/</font></h1>
58    <h2>triangule_c.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Construct the triangulation array.
65
66 The idea is: construct a list of triangle which link points between them.
67 This is automatically done by the function TRIANGULATE
68  Here:
69 we consider the fact that points are disposed on a grid (regular or not,
70 but not unstructured, that is to say that points are written following a
71 rectangular matrix). A easy way to do triangles between all points is then:
72
73     for each point (i,j) of the matrix -except those of the last line and of
74     the last column- we call rectangle (i,j) the rectangle made of the four
75     points (i,j), (i+1,j), (i,j+1), (i+1,j+1). To trace all triangle, we just
76     have to trace the 2 triangles contained in rectangles (i,j)
77
78 We notice that each rectangle (i,j) have 2 diagonals (it is true... Make a
79 drawing to make sure!!), so there are two possible choice for each rectangle
80 we want to cut in 2 triangles...
81
82 It is thanks to this choice that we will be able to trace coast with right
83 angles. At each angle of coast remarkable by the existence of an unique land
84 point or of an unique ocean point on one of the four summit of a rectangle (i,j),
85 we have to cut the rectangle following the diagonal passing by this point.
86
87
88   
89
90     
91      <a name="#_triangule_c"></a>
92
93      <h2>triangule_c  <font size="-1" color="#006633">
94 Graphics
95</font></h2>
96
97      <p><font face="Courier"><i>result = </i>triangule_c(<i>[<a href="#_triangule_c_keyword_maskentree">maskentree</a>]</i>, <a href="#_triangule_c_keyword_COINMONTE">COINMONTE</a>=<i>array</i>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<i>array</i>, <a href="#_triangule_c_keyword_BASIC">BASIC</a>=<i>BASIC</i>, <a href="#_triangule_c_keyword_KEEP_CONT">KEEP_CONT</a>=<i>KEEP_CONT</i>)</font></p>
98
99   
100
101
102    <h3>Return value</h3>
103 res: tableau 2d (3,nbre de triangles).
104 Each line of res represent indexes of points constituting summits of a triangle.
105 See how we trace triangles in definetri.pro
106
107
108   
109    <h3>Parameters</h3>
110   
111
112    <a name="#_triangule_c_keyword_maskentree"></a>
113    <h4>maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114      <font size="-1" color="#006633">in</font>
115     
116      <font size="-1" color="#006633">optional</font>
117     
118     
119      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
120     
121     
122    </h4>
123
124   
125 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,
126 ...TRIANGULATION=triangule(mask)
127 If this argument is not specified, the function use tmask
128
129   
130   
131
132   
133    <h3>Keywords</h3>
134
135   
136    <a name="#_triangule_c_keyword_COINMONTE"></a>
137    <h4>COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138     
139     
140     
141     
142     
143      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
144     
145     
146    </h4>
147
148   
149 To obtain the array of "ascending land corner" to be treated with
150 completecointerre.pro in the variable array instead of make it pass by the global
151 variable twin_corners_up.
152
153   
154    <a name="#_triangule_c_keyword_COINDESCEND"></a>
155    <h4>COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156     
157     
158     
159     
160     
161      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
162     
163     
164    </h4>
165
166   
167 See COINMONTE
168
169   
170    <a name="#_triangule_c_keyword_BASIC"></a>
171    <h4>BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172     
173     
174     
175     
176     
177     
178     
179     
180    </h4>
181
182   
183 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
184
185   
186    <a name="#_triangule_c_keyword_KEEP_CONT"></a>
187    <h4>KEEP_CONT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
188     
189     
190     
191     
192     
193     
194     
195     
196    </h4>
197
198   
199 To keep the triangulation even on the continents
200
201   
202   
203
204   
205    </pre><h3>Version history</h3>
206   
207    <h4>Version</h4>
208 $Id: triangule_c.pro 327 2007-12-13 16:22:35Z pinsard $
209
210    <h4>History</h4>
211 Sebastien Masson (smasson@lodyc.jussieu.fr)
212                       26/4/1999
213
214   
215
216    <h3>Known issues</h3>
217   
218   
219    <h4>Todo items</h4>
220 seb L.267->268 je ne pense pas que ce soit ce que tu voulais dire mais
221 c'est la traduction de ce qu'il y avait écrit. Correction si besoin.
222
223    <h4>Restrictions</h4>
224 Data whose we want to do the contour must be disposed in a matrix.
225 On the other hand, in the matrix, the points's arrangement can not be
226 irregular. If it is, use TRIANGULE.
227
228
229    <h3>Other attributes</h3>
230   
231   
232    <h4>Uses routines</h4>
233 common.pro
234 different.pro
235 definetri.pro
236
237   
238   
239   
240
241    <font size="-3"><p>&nbsp;</p></font>
242    <hr size="1" color="#CCCCCC"/>
243     
244
245   
246
247    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
248
249  </body>
250</html>
Note: See TracBrowser for help on using the repository browser.