source: trunk/SRC/Documentation/idldoc_html_output/Grid/numbisland.html

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

update documentation
File size: 4.3 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>numbisland.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="numbisland.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="../../../Grid//numbisland.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="ncdf_meshroms.html">&lt;&lt;prev file</a> | <a href="restoreboxparam.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="numbisland.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">Grid/</a></h1>
82      <h2 class="pro_file">numbisland.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 recursive function.
91 for one given point on an island, check if its neighbors are on the same island
92
93
94 given a 2D land-sea mask, give a number to each island
95</div>
96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_numbisland">
109
110          <h2><a class="top" href="#container">top</a>numbisland <span class="categories">
111 Grid
112</span></h2>
113       
114          <p class="header">
115            <span class="result">result = </span>numbisland(<span class="result"><a href="#_numbisland_param_mskin">mskin</a></span>)</p>
116       
117          <div class="comments">
118</div>
119
120          <h3>Return value</h3><div class="preformat">
121 A 2d array with 0 on the ocean and a different number for each island
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_numbisland_param_mskin">mskin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134              <span class="attr">type:</span> <span class="value">2D array of 0 and 1</span>
135             
136             
137            </h4>
138       
139          <div class="comments">
140 land-sea mask with 0 on the land and 1 on the ocean
141</div>
142           
143
144         
145
146         
147
148          <h3>Examples</h3><div class="preformat">
149   IDL> a = numbisland(tmask[*,*,0])
150</div>
151          <h3>Version history</h3>
152         
153          <h4>Version</h4><div class="preformat">
154 $Id: numbisland.pro 325 2007-12-06 10:04:53Z pinsard $
155</div>
156          <h4>History</h4><div class="preformat">
157  Jan 2006: sebastien masson (smasson@locean-ipsl.upmc.fr)
158</div>
159         
160         
161          <h3>Known issues</h3>
162         
163         
164         
165          <h4>Restrictions</h4><div class="preformat">
166    - mask must be periodic along the x direction.
167    - Periodicity along y direction is not taken into account
168    - must have less than ~32700 islands;
169</div>
170       
171         
172         
173         
174         
175         
176         
177         
178       
179          <h3>Statistics</h3>
180          <table class="statistics">
181            <tr><td>McCabe cyclic</td><td>           4</td></tr>
182            <tr><td>McCabe essential</td><td>           1</td></tr>
183            <tr><td>McCabe modular design</td><td>           1</td></tr>
184          </table>
185         
186       
187        </div>
188       
189      </div>
190
191     
192
193      <div id="tagline">Produced by IDLdoc 2.0.</div>
194
195    </div>
196
197  </body>
198</html>
Note: See TracBrowser for help on using the repository browser.