source: trunk/SRC/Documentation/idldoc_html_output/Utilities/fitintobox.html @ 338

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

update documentation
File size: 8.8 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>fitintobox.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="fitintobox.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="../../../Utilities//fitintobox.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="find.html">&lt;&lt;prev file</a> | <a href="isadirectory.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="fitintobox.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">Utilities/</a></h1>
82      <h2 class="pro_file">fitintobox.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Check that the input array has size and dimensions
91 compatible with the domain that was defined with the previous call
92 of <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_fitintobox">
107
108          <h2><a class="top" href="#container">top</a>fitintobox <span class="categories">
109 Compatibility
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>fitintobox(<span class="result"><a href="#_fitintobox_param_field">field</a>[, <a href="#_fitintobox_param_nx">nx</a>][, <a href="#_fitintobox_param_ny">ny</a>][, <a href="#_fitintobox_param_nz">nz</a>][, <a href="#_fitintobox_param_firstx">firstx</a>][, <a href="#_fitintobox_param_firsty">firsty</a>][, <a href="#_fitintobox_param_firstz">firstz</a>][, <a href="#_fitintobox_param_lastx">lastx</a>][, <a href="#_fitintobox_param_lasty">lasty</a>][, <a href="#_fitintobox_param_lastz">lastz</a>]</span>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>)</p>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 an array with dimensions matching the domain
120 or -1 if there is an error...
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_fitintobox_param_field">field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133              <span class="attr">type:</span> <span class="value">array or struct</span>
134             
135             
136            </h4>
137       
138          <div class="comments">
139 an array or a structure that can be read by the function
140 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>
141</div>
142           
143            <h4 id="_fitintobox_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146              <span class="attr">optional</span>
147             
148             
149             
150              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
151             
152            </h4>
153       
154          <div class="comments">
155</div>
156           
157            <h4 id="_fitintobox_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158              <span class="attr">in</span>
159             
160              <span class="attr">optional</span>
161             
162             
163             
164              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
165             
166            </h4>
167       
168          <div class="comments">
169</div>
170           
171            <h4 id="_fitintobox_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172              <span class="attr">in</span>
173             
174              <span class="attr">optional</span>
175             
176             
177             
178              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
179             
180            </h4>
181       
182          <div class="comments">
183</div>
184           
185            <h4 id="_fitintobox_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186              <span class="attr">in</span>
187             
188              <span class="attr">optional</span>
189             
190             
191             
192              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
193             
194            </h4>
195       
196          <div class="comments">
197</div>
198           
199            <h4 id="_fitintobox_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200              <span class="attr">in</span>
201             
202              <span class="attr">optional</span>
203             
204             
205             
206              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
207             
208            </h4>
209       
210          <div class="comments">
211</div>
212           
213            <h4 id="_fitintobox_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214              <span class="attr">in</span>
215             
216              <span class="attr">optional</span>
217             
218             
219             
220              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
221             
222            </h4>
223       
224          <div class="comments">
225</div>
226           
227            <h4 id="_fitintobox_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228              <span class="attr">in</span>
229             
230              <span class="attr">optional</span>
231             
232             
233             
234              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
235             
236            </h4>
237       
238          <div class="comments">
239</div>
240           
241            <h4 id="_fitintobox_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242              <span class="attr">in</span>
243             
244              <span class="attr">optional</span>
245             
246             
247             
248              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
249             
250            </h4>
251       
252          <div class="comments">
253</div>
254           
255            <h4 id="_fitintobox_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256              <span class="attr">in</span>
257             
258              <span class="attr">optional</span>
259             
260             
261             
262              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
263             
264            </h4>
265       
266          <div class="comments">
267</div>
268           
269
270         
271
272         
273
274            <h3>Keywords</h3>
275           
276            <h4 id="_fitintobox_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277             
278             
279             
280             
281             
282             
283             
284             
285            </h4>
286       
287            <div class="comments">
288 To specify that we are at W level
289</div>
290           
291         
292
293          <h3>Examples</h3><div class="preformat">
294 IDL> help, fitintobox(findgen(jpi,jpj))
295 <Expression>    FLOAT     = Array[41, 3]
296 IDL> help, fitintobox(findgen(jpi,jpj,78))
297 Error:
298 the array dimensions [180,148,78] are incompatible
299 with the domain dimensions
300 [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
301 <Expression>    INT       =       -1
302</div>
303          <h3>Version history</h3>
304         
305          <h4>Version</h4><div class="preformat">
306 $Id: fitintobox.pro 327 2007-12-13 16:22:35Z pinsard $
307</div>
308          <h4>History</h4><div class="preformat">
309 Sebastien Masson (smasson@lodyc.jussieu.fr)
310          10 juin 2000.
311          June 2005: S. Masson rewrite all.
312</div>
313         
314         
315         
316         
317         
318         
319         
320       
321          <h3>Other attributes</h3>
322         
323         
324          <h4>Uses routines</h4><div class="preformat">
325 cm_4mesh
326 cm_4cal
327</div>
328         
329         
330         
331       
332          <h3>Statistics</h3>
333          <table class="statistics">
334            <tr><td>McCabe cyclic</td><td>          66</td></tr>
335            <tr><td>McCabe essential</td><td>           1</td></tr>
336            <tr><td>McCabe modular design</td><td>           1</td></tr>
337          </table>
338         
339       
340        </div>
341       
342      </div>
343
344     
345
346      <div id="tagline">Produced by IDLdoc 2.0.</div>
347
348    </div>
349
350  </body>
351</html>
Note: See TracBrowser for help on using the repository browser.