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

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

update documentation
File size: 6.0 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>tracemask.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="tracemask.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//tracemask.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="tracecote.html">&lt;&lt;prev file</a> | <a href="triangule.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="tracemask.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">tracemask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Draw contours of a mask
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_tracemask">
105
106          <h2><a class="top" href="#container">top</a>tracemask <span class="categories">
107 Utilities
108</span></h2>
109       
110          <p class="header">
111            tracemask<span class="result">, <a href="#_tracemask_param_maskentree">maskentree</a>, <a href="#_tracemask_param_xin">xin</a>, <a href="#_tracemask_param_yin">yin</a></span>, <a href="#_tracemask_keyword_COAST_COLOR">COAST_COLOR</a>=<span class="result">COAST_COLOR</span>, <a href="#_tracemask_keyword_COAST_THICK">COAST_THICK</a>=<span class="result">COAST_THICK</span>, <a href="#_tracemask_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_tracemask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_tracemask_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134 2d array specifying the mask
135</div>
136           
137            <h4 id="_tracemask_param_xin">xin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments">
149 2d array specifying longitude coordinates.
150</div>
151           
152            <h4 id="_tracemask_param_yin">yin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155             
156              <span class="attr">required</span>
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments">
164 2d array specifying latitude coordinates.
165</div>
166           
167
168         
169
170         
171
172            <h3>Keywords</h3>
173           
174            <h4 id="_tracemask_keyword_COAST_COLOR">COAST_COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181              <span class="attr">default:</span> <span class="value">0</span>
182             
183            </h4>
184       
185            <div class="comments">
186 The color of the coastline.
187 Default is black (0).
188</div>
189           
190            <h4 id="_tracemask_keyword_COAST_THICK">COAST_THICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197              <span class="attr">default:</span> <span class="value">1</span>
198             
199            </h4>
200       
201            <div class="comments">
202 The thick of the trait to trace continents
203</div>
204           
205            <h4 id="_tracemask_keyword_OVERPLOT">OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211             
212             
213             
214            </h4>
215       
216            <div class="comments">
217 To do a plot over an other one.
218</div>
219           
220            <h4 id="_tracemask_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231            <div class="comments">
232 Used to pass keywords
233</div>
234           
235         
236
237         
238          <h3>Version history</h3>
239         
240          <h4>Version</h4><div class="preformat">
241 $Id: tracemask.pro 370 2008-08-07 07:59:15Z pinsard $
242</div>
243          <h4>History</h4><div class="preformat">
244 Sebastien Masson (smasson@lodyc.jussieu.fr)
245</div>
246         
247         
248         
249         
250         
251         
252         
253       
254          <h3>Other attributes</h3>
255         
256         
257          <h4>Uses routines</h4><div class="preformat">
258 <a href="../..//Obsolete/common.html">common</a>
259</div>
260         
261         
262         
263       
264          <h3>Statistics</h3>
265          <table class="statistics">
266            <tr><td>McCabe cyclic</td><td>          26</td></tr>
267            <tr><td>McCabe essential</td><td>           1</td></tr>
268            <tr><td>McCabe modular design</td><td>           1</td></tr>
269          </table>
270         
271       
272        </div>
273       
274      </div>
275
276     
277
278      <div id="tagline">Produced by IDLdoc 2.0.</div>
279
280    </div>
281
282  </body>
283</html>
Note: See TracBrowser for help on using the repository browser.