source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2mask.html @ 402

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

update documentation
File size: 4.5 KB
RevLine 
[89]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>
[104]9    <title>depth2mask.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="depth2mask.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/CALCULS//depth2mask.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="depth2level.html">&lt;&lt;prev file</a> | <a href="determ2.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="depth2mask.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1>
[89]82      <h2 class="pro_file">depth2mask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[234]89      <div id="file_comments">
90 Allows to pass from a 2d depth sill array to a 3d array of mask
[142]91 with one of levels above the sill depth and 0s below.
92</div>
[89]93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_depth2mask">
106
[142]107          <h2><a class="top" href="#container">top</a>depth2mask <span class="categories">
108 Without loop
109</span></h2>
[89]110       
111          <p class="header">
[234]112            <span class="result">result = </span>depth2mask(<span class="result"><a href="#_depth2mask_param_tab">tab</a></span>, <a href="#_depth2mask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
[89]113       
114          <div class="comments">
[142]115</div>
[89]116
[142]117          <h3>Return value</h3><div class="preformat">
[234]118 It is a 3d array containing the mask associated to the 2d sill depth array
[89]119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_depth2mask_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
[163]131              <span class="attr">type:</span> <span class="value">3d array</span>
[89]132             
133             
134            </h4>
135       
[163]136          <div class="comments">
[290]137 2d sill depth array (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions)
[142]138</div>
[89]139           
140
141         
142
143         
144
145            <h3>Keywords</h3>
146           
[234]147            <h4 id="_depth2mask_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
[142]158            <div class="comments">
[234]159 Used to pass keywords
160</div>
[89]161           
162         
163
164         
[142]165          <h3>Version history</h3>
[89]166         
[142]167          <h4>Version</h4><div class="preformat">
[402]168 $Id: depth2mask.pro 370 2008-08-07 07:59:15Z pinsard $
[142]169</div>
[157]170          <h4>History</h4><div class="preformat">
171 Sebastien Masson (smasson@lodyc.jussieu.fr)
172                       17/6/1999
173</div>
[89]174         
175         
176         
177         
178         
179         
180         
181       
[142]182          <h3>Other attributes</h3>
[89]183         
184         
[142]185          <h4>Uses routines</h4><div class="preformat">
[402]186 <a href="../..//Obsolete/common.html">common</a>
[142]187</div>
[89]188         
189         
190         
191       
[163]192          <h3>Statistics</h3>
193          <table class="statistics">
194            <tr><td>McCabe cyclic</td><td>           3</td></tr>
195            <tr><td>McCabe essential</td><td>           1</td></tr>
196            <tr><td>McCabe modular design</td><td>           1</td></tr>
197          </table>
[89]198         
199       
200        </div>
201       
202      </div>
203
204     
205
206      <div id="tagline">Produced by IDLdoc 2.0.</div>
207
208    </div>
209
210  </body>
[249]211</html>
Note: See TracBrowser for help on using the repository browser.