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

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

update documentation
File size: 5.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>projectondepth.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="projectondepth.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//projectondepth.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
[321]74<a href="moyenne.html">&lt;&lt;prev file</a> | <a href="remplit.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="projectondepth.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">projectondepth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]89      <div id="file_comments">
90 Allows to project a 3d field following a depth array.
91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_projectondepth">
105
[142]106          <h2><a class="top" href="#container">top</a>projectondepth <span class="categories">
[157]107 Without loop
[142]108</span></h2>
[89]109       
110          <p class="header">
111            <span class="result">result = </span>projectondepth(<span class="result"><a href="#_projectondepth_param_arrayin">arrayin</a>, <a href="#_projectondepth_param_depthin">depthin</a></span>)</p>
112       
113          <div class="comments">
[142]114</div>
[89]115
[142]116          <h3>Return value</h3><div class="preformat">
[163]117 A 2d array which is the projection of the 3d array following depths indicated by depthin
[89]118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_projectondepth_param_arrayin">arrayin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125             
126             
127             
128             
129             
[163]130              <span class="attr">type:</span> <span class="value">3d array</span>
[89]131             
132             
133            </h4>
134       
[163]135          <div class="comments">
[142]136 It is a 3d array whose 3rd dimension must be equal to jpk
[234]137</div>
[89]138           
139            <h4 id="_projectondepth_param_depthin">depthin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140             
141             
142             
143             
144             
[163]145              <span class="attr">type:</span> <span class="value">2d array</span>
[89]146             
147             
148            </h4>
149       
[163]150          <div class="comments">
[142]151 It is a 2d array indicating for each point n, at which depth to project
[234]152</div>
[89]153           
154
155         
156
157         
158
[142]159          <h3>Examples</h3><div class="preformat">
[163]160 we build a possible depths array
[142]161   IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
[163]162 We build an array to project on these depths. For the test,
[234]163 we build a 3d array whose each vector following z is the depth.
[142]164   IDL> arraytest=replicate(1,jpi*jpj)#gdept
165   IDL> arraytest=reform(arraytest,jpi,jpj,jpk, /over)
166 We test the projection of the depth array on the depth...
167   IDL> plt, 1e6*(a-projectondepth(arraytest,a)),/nocontour
168   ->null field at 1e-6 pres
[234]169
170  verification projecting the temperature of 20°C for example...
[142]171</div>
172          <h3>Version history</h3>
[89]173         
[142]174          <h4>Version</h4><div class="preformat">
[402]175 $Id: projectondepth.pro 370 2008-08-07 07:59:15Z pinsard $
[142]176</div>
[157]177          <h4>History</h4><div class="preformat">
178 Sebastien Masson (smasson@lodyc.jussieu.fr)
179                      15/6/2000
180</div>
[89]181         
182         
[142]183          <h3>Known issues</h3>
[89]184         
185         
186         
[234]187          <h4>Restrictions</h4><div class="preformat">
[142]188 points at !values.f_nan impossible calculation. Land points masked at valmask.
189</div>
[89]190       
[142]191          <h3>Other attributes</h3>
[89]192         
193         
[142]194          <h4>Uses routines</h4><div class="preformat">
[402]195 <a href="../..//Obsolete/common.html">common</a>
[142]196</div>
[89]197         
198         
199         
200       
[163]201          <h3>Statistics</h3>
202          <table class="statistics">
203            <tr><td>McCabe cyclic</td><td>          17</td></tr>
204            <tr><td>McCabe essential</td><td>           1</td></tr>
205            <tr><td>McCabe modular design</td><td>           1</td></tr>
206          </table>
[89]207         
208       
209        </div>
210       
211      </div>
212
213     
214
215      <div id="tagline">Produced by IDLdoc 2.0.</div>
216
217    </div>
218
219  </body>
[249]220</html>
Note: See TracBrowser for help on using the repository browser.