source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_c.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>triangule_c.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="triangule_c.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/TRIANGULATION//triangule_c.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="triangule.html">&lt;&lt;prev file</a> | <a href="triangule_e.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="triangule_c.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/TRIANGULATION/</a></h1>
82      <h2 class="pro_file">triangule_c.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Construct the triangulation array.
91
92 The idea is: construct a list of triangle which link points between them.
93 This is automatically done by the function TRIANGULATE
94  Here:
95 we consider the fact that points are disposed on a grid (regular or not,
96 but not unstructured, that is to say that points are written following a
97 rectangular matrix). A easy way to do triangles between all points is then:
98
99     for each point (i,j) of the matrix -except those of the last line and of
100     the last column- we call rectangle (i,j) the rectangle made of the four
101     points (i,j), (i+1,j), (i,j+1), (i+1,j+1). To trace all triangle, we just
102     have to trace the 2 triangles contained in rectangles (i,j)
103
104 We notice that each rectangle (i,j) have 2 diagonals (it is true... Make a
105 drawing to make sure!!), so there are two possible choice for each rectangle
106 we want to cut in 2 triangles...
107
108 It is thanks to this choice that we will be able to trace coast with right
109 angles. At each angle of coast remarkable by the existence of an unique land
110 point or of an unique ocean point on one of the four summit of a rectangle (i,j),
111 we have to cut the rectangle following the diagonal passing by this point.
112</div>
113
114     
115
116     
117
118     
119
120     
121
122      <div id="routine_details">
123       
124
125        <div class="routine_details" id="_triangule_c">
126
127          <h2><a class="top" href="#container">top</a>triangule_c <span class="categories">
128 Graphics
129</span></h2>
130       
131          <p class="header">
132            <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">array</span>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</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>
133       
134          <div class="comments">
135</div>
136
137          <h3>Return value</h3><div class="preformat">
138 res: tableau 2d (3,nbre de triangles).
139 Each line of res represent indexes of points constituting summits of a triangle.
140 See how we trace triangles in definetri.pro
141</div>
142
143         
144            <h3>Parameters</h3>
145       
146           
147            <h4 id="_triangule_c_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148              <span class="attr">in</span>
149             
150              <span class="attr">optional</span>
151             
152             
153              <span class="attr">type:</span> <span class="value">2d array</span>
154             
155             
156            </h4>
157       
158          <div class="comments">
159 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,
160 ...TRIANGULATION=triangule(mask)
161 If this argument is not specified, the function use tmask
162</div>
163           
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
171            <h4 id="_triangule_c_keyword_COINMONTE">COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177              <span class="attr">type:</span> <span class="value">array</span>
178             
179             
180            </h4>
181       
182            <div class="comments">
183 To obtain the array of "ascending land corner" to be treated with
184 completecointerre.pro in the variable array instead of make it pass by the global
185 variable twin_corners_up.
186</div>
187           
188            <h4 id="_triangule_c_keyword_COINDESCEND">COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190             
191             
192             
193             
194              <span class="attr">type:</span> <span class="value">array</span>
195             
196             
197            </h4>
198       
199            <div class="comments">
200 See COINMONTE
201</div>
202           
203            <h4 id="_triangule_c_keyword_BASIC">BASIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments">
215 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
216</div>
217           
218            <h4 id="_triangule_c_keyword_KEEP_CONT">KEEP_CONT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
229            <div class="comments">
230 To keep the triangulation even on the continents
231</div>
232           
233         
234
235         
236          <h3>Version history</h3>
237         
238          <h4>Version</h4><div class="preformat">
239 $Id: triangule_c.pro 370 2008-08-07 07:59:15Z pinsard $
240</div>
241          <h4>History</h4><div class="preformat">
242 Sebastien Masson (smasson@lodyc.jussieu.fr)
243                       26/4/1999
244</div>
245         
246         
247          <h3>Known issues</h3>
248         
249         
250          <h4>Todo items</h4><div class="preformat">
251 seb L.267->268 je ne pense pas que ce soit ce que tu voulais dire mais
252 c'est la traduction de ce qu'il y avait écrit. Correction si besoin.
253</div>
254          <h4>Restrictions</h4><div class="preformat">
255 Data whose we want to do the contour must be disposed in a matrix.
256 On the other hand, in the matrix, the points's arrangement can not be
257 irregular. If it is, use TRIANGULE.
258</div>
259       
260          <h3>Other attributes</h3>
261         
262         
263          <h4>Uses routines</h4><div class="preformat">
264 <a href="../..//Obsolete/common.html">common</a>
265 <a href="../..//Matrix/different.html">different</a>
266 <a href="../..//ToBeReviewed/TRIANGULATION/definetri.html">definetri</a>
267</div>
268         
269         
270         
271       
272          <h3>Statistics</h3>
273          <table class="statistics">
274            <tr><td>McCabe cyclic</td><td>          41</td></tr>
275            <tr><td>McCabe essential</td><td>           1</td></tr>
276            <tr><td>McCabe modular design</td><td>           1</td></tr>
277          </table>
278         
279       
280        </div>
281       
282      </div>
283
284     
285
286      <div id="tagline">Produced by IDLdoc 2.0.</div>
287
288    </div>
289
290  </body>
291</html>
Note: See TracBrowser for help on using the repository browser.