source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/projectondepth.html @ 338

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

update documentation

File size: 3.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>projectondepth.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="moyenne.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="remplit.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>projectondepth.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Allows to project a 3d field following a depth array.
65
66
67   
68
69     
70      <a name="#_projectondepth"></a>
71
72      <h2>projectondepth  <font size="-1" color="#006633">
73 Without loop
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>projectondepth(<i><a href="#_projectondepth_keyword_arrayin">arrayin</a>, <a href="#_projectondepth_keyword_depthin">depthin</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 A 2d array which is the projection of the 3d array following depths indicated by depthin
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_projectondepth_keyword_arrayin"></a>
90    <h4>arrayin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91     
92     
93     
94     
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3d array</i></font>
97     
98     
99    </h4>
100
101   
102 It is a 3d array whose 3rd dimension must be equal to jpk
103
104   
105
106    <a name="#_projectondepth_keyword_depthin"></a>
107    <h4>depthin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108     
109     
110     
111     
112     
113      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
114     
115     
116    </h4>
117
118   
119 It is a 2d array indicating for each point n, at which depth to project
120
121   
122   
123
124   
125
126    <h3>Examples</h3><pre>
127 we build a possible depths array
128   IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
129 We build an array to project on these depths. For the test,
130 we build a 3d array whose each vector following z is the depth.
131   IDL> arraytest=replicate(1,jpi*jpj)#gdept
132   IDL> arraytest=reform(arraytest,jpi,jpj,jpk, /over)
133 We test the projection of the depth array on the depth...
134   IDL> plt, 1e6*(a-projectondepth(arraytest,a)),/nocontour
135   ->null field at 1e-6 pres
136
137  verification projecting the temperature of 20°C for example...
138
139    </pre><h3>Version history</h3>
140   
141    <h4>Version</h4>
142 $Id: projectondepth.pro 325 2007-12-06 10:04:53Z pinsard $
143
144    <h4>History</h4>
145 Sebastien Masson (smasson@lodyc.jussieu.fr)
146                      15/6/2000
147
148   
149
150    <h3>Known issues</h3>
151   
152   
153   
154    <h4>Restrictions</h4>
155 points at !values.f_nan impossible calculation. Land points masked at valmask.
156
157
158    <h3>Other attributes</h3>
159   
160   
161    <h4>Uses routines</h4>
162 common.pro
163
164   
165   
166   
167
168    <font size="-3"><p>&nbsp;</p></font>
169    <hr size="1" color="#CCCCCC"/>
170     
171
172   
173
174    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
175
176  </body>
177</html>
Note: See TracBrowser for help on using the repository browser.