source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/tracemask.html

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

update documentation
File size: 4.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>tracemask.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="tracecote.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.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>tracemask.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Draw contours of a mask
65
66
67   
68
69     
70      <a name="#_tracemask"></a>
71
72      <h2>tracemask  <font size="-1" color="#006633">
73 Utilities
74</font></h2>
75
76      <p><font face="Courier">tracemask<i>, <a href="#_tracemask_keyword_maskentree">maskentree</a>, <a href="#_tracemask_keyword_xin">xin</a>, <a href="#_tracemask_keyword_yin">yin</a></i>, <a href="#_tracemask_keyword_COAST_COLOR">COAST_COLOR</a>=<i>COAST_COLOR</i>, <a href="#_tracemask_keyword_COAST_THICK">COAST_THICK</a>=<i>COAST_THICK</i>, <a href="#_tracemask_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_tracemask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_tracemask_keyword_maskentree"></a>
88    <h4>maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99   
100 2d array specifying the mask
101
102   
103
104    <a name="#_tracemask_keyword_xin"></a>
105    <h4>xin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111     
112     
113     
114    </h4>
115
116   
117 2d array specifying longitude coordinates.
118
119   
120
121    <a name="#_tracemask_keyword_yin"></a>
122    <h4>yin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123      <font size="-1" color="#006633">in</font>
124     
125     
126      <font size="-1" color="#006633">required</font>
127     
128     
129     
130     
131    </h4>
132
133   
134 2d array specifying latitude coordinates.
135
136   
137   
138
139   
140    <h3>Keywords</h3>
141
142   
143    <a name="#_tracemask_keyword_COAST_COLOR"></a>
144    <h4>COAST_COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150     
151      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
152     
153    </h4>
154
155   
156 The color of the coastline.
157 Default is black (0).
158
159   
160    <a name="#_tracemask_keyword_COAST_THICK"></a>
161    <h4>COAST_THICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162     
163     
164     
165     
166     
167     
168      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
169     
170    </h4>
171
172   
173 The thick of the trait to trace continents
174
175   
176    <a name="#_tracemask_keyword_OVERPLOT"></a>
177    <h4>OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178     
179     
180     
181     
182     
183     
184     
185     
186    </h4>
187
188   
189 To do a plot over an other one.
190
191   
192    <a name="#_tracemask_keyword__EXTRA"></a>
193    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199     
200     
201     
202    </h4>
203
204   
205 Used to pass keywords
206
207   
208   
209
210   
211    </pre><h3>Version history</h3>
212   
213    <h4>Version</h4>
214 $Id: tracemask.pro 370 2008-08-07 07:59:15Z pinsard $
215
216    <h4>History</h4>
217 Sebastien Masson (smasson@lodyc.jussieu.fr)
218
219   
220
221   
222   
223   
224   
225   
226
227    <h3>Other attributes</h3>
228   
229   
230    <h4>Uses routines</h4>
231 <a href="../..//Obsolete/common.html">common</a>
232
233   
234   
235   
236
237    <font size="-3"><p>&nbsp;</p></font>
238    <hr size="1" color="#CCCCCC"/>
239     
240
241   
242
243    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
244
245  </body>
246</html>
Note: See TracBrowser for help on using the repository browser.