source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/numbisland.html @ 338

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

update documentation

File size: 3.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>numbisland.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="ncdf_meshroms.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="restoreboxparam.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Grid/</font></h1>
58    <h2>numbisland.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 recursive function.
65 for one given point on an island, check if its neighbors are on the same island
66
67
68 given a 2D land-sea mask, give a number to each island
69
70
71   
72
73     
74      <a name="#_numbisland"></a>
75
76      <h2>numbisland  <font size="-1" color="#006633">
77 Grid
78</font></h2>
79
80      <p><font face="Courier"><i>result = </i>numbisland(<i><a href="#_numbisland_keyword_mskin">mskin</a></i>)</font></p>
81
82   
83
84
85    <h3>Return value</h3>
86 A 2d array with 0 on the ocean and a different number for each island
87
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_numbisland_keyword_mskin"></a>
94    <h4>mskin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95      <font size="-1" color="#006633">in</font>
96     
97     
98      <font size="-1" color="#006633">required</font>
99     
100      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D array of 0 and 1</i></font>
101     
102     
103    </h4>
104
105   
106 land-sea mask with 0 on the land and 1 on the ocean
107
108   
109   
110
111   
112
113    <h3>Examples</h3><pre>
114   IDL> a = numbisland(tmask[*,*,0])
115
116    </pre><h3>Version history</h3>
117   
118    <h4>Version</h4>
119 $Id: numbisland.pro 325 2007-12-06 10:04:53Z pinsard $
120
121    <h4>History</h4>
122  Jan 2006: sebastien masson (smasson@locean-ipsl.upmc.fr)
123
124   
125
126    <h3>Known issues</h3>
127   
128   
129   
130    <h4>Restrictions</h4>
131    - mask must be periodic along the x direction.
132    - Periodicity along y direction is not taken into account
133    - must have less than ~32700 islands;
134
135
136   
137   
138   
139   
140   
141   
142   
143
144    <font size="-3"><p>&nbsp;</p></font>
145    <hr size="1" color="#CCCCCC"/>
146     
147
148   
149
150    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
151
152  </body>
153</html>
Note: See TracBrowser for help on using the repository browser.