source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2index.html @ 249

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation
File size: 4.2 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>level2index.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="level2index.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//level2index.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="level2depth.html">&lt;&lt;prev file</a> | <a href="level2mask.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="level2index.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">level2index.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[234]89      <div id="file_comments">
90 We want, from a 3d matrix, to extract a 2d (x,y) array whose each element
91 has been extract from a level specified by the 2d level array (typically,
[142]92 we want to obtain the salinity along an isopycn we have repered by its level).
[234]93 level2index is a function who give, in function of level, a 2d indexes array
[142]94 which will allow to extract the 2d array from the 3d array...
95</div>
[89]96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_level2index">
109
[142]110          <h2><a class="top" href="#container">top</a>level2index <span class="categories">
[157]111 Without loop
[142]112</span></h2>
[89]113       
114          <p class="header">
115            <span class="result">result = </span>level2index(<span class="result"><a href="#_level2index_param_level">level</a></span>)</p>
116       
117          <div class="comments">
[142]118</div>
[89]119
[142]120          <h3>Return value</h3><div class="preformat">
121 a 2d indexes array
[89]122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_level2index_param_level">level&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]129              <span class="attr">in</span>
[89]130             
131             
[142]132              <span class="attr">required</span>
[89]133             
[163]134              <span class="attr">type:</span> <span class="value">2d array</span>
[89]135             
136             
137            </h4>
138       
[142]139          <div class="comments">
140 A 2d level array
141</div>
[89]142           
143
144         
145
146         
147
148         
[142]149          <h3>Version history</h3>
[89]150         
[142]151          <h4>Version</h4><div class="preformat">
[234]152 $Id: level2index.pro 231 2007-03-19 17:15:51Z pinsard $
[142]153</div>
[157]154          <h4>History</h4><div class="preformat">
155 Sebastien Masson (smasson@lodyc.jussieu.fr)
156                      24/11/1999
157</div>
[89]158         
159         
160         
161         
162         
163         
164         
165       
166         
167         
168         
169         
170         
171         
172         
173       
[163]174          <h3>Statistics</h3>
175          <table class="statistics">
176            <tr><td>McCabe cyclic</td><td>           1</td></tr>
177            <tr><td>McCabe essential</td><td>           1</td></tr>
178            <tr><td>McCabe modular design</td><td>           1</td></tr>
179          </table>
[89]180         
181       
182        </div>
183       
184      </div>
185
186     
187
188      <div id="tagline">Produced by IDLdoc 2.0.</div>
189
190    </div>
191
192  </body>
[249]193</html>
Note: See TracBrowser for help on using the repository browser.