source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/fitintobox.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 7.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>fitintobox.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="find.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="isadirectory.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>fitintobox.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 Check that the input array has size and dimensions
65 compatible with the domain that was defined with the previous call
66 of domdef.
67
68
69   
70
71     
72      <a name="#_fitintobox"></a>
73
74      <h2>fitintobox  <font size="-1" color="#006633"> 
75 Compatibility
76</font></h2>
77
78      <p><font face="Courier"><i>result = </i>fitintobox(<i><a href="#_fitintobox_keyword_field">field</a>[, <a href="#_fitintobox_keyword_nx">nx</a>][, <a href="#_fitintobox_keyword_ny">ny</a>][, <a href="#_fitintobox_keyword_nz">nz</a>][, <a href="#_fitintobox_keyword_firstx">firstx</a>][, <a href="#_fitintobox_keyword_firsty">firsty</a>][, <a href="#_fitintobox_keyword_firstz">firstz</a>][, <a href="#_fitintobox_keyword_lastx">lastx</a>][, <a href="#_fitintobox_keyword_lasty">lasty</a>][, <a href="#_fitintobox_keyword_lastz">lastz</a>]</i>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3> 
84 an array with dimensions matching the domain
85 or -1 if there is an error...
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_fitintobox_keyword_field"></a>
93    <h4>field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array or struct</i></font>
100     
101     
102    </h4>
103
104   
105 an array or a structure that can be read by the function               
106 litchamp.pro
107 
108   
109
110    <a name="#_fitintobox_keyword_nx"></a>
111    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114      <font size="-1" color="#006633">optional</font>
115     
116     
117     
118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
119     
120    </h4>
121
122   
123
124   
125
126    <a name="#_fitintobox_keyword_ny"></a>
127    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128      <font size="-1" color="#006633">in</font>
129     
130      <font size="-1" color="#006633">optional</font>
131     
132     
133     
134      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
135     
136    </h4>
137
138   
139
140   
141
142    <a name="#_fitintobox_keyword_nz"></a>
143    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144      <font size="-1" color="#006633">in</font>
145     
146      <font size="-1" color="#006633">optional</font>
147     
148     
149     
150      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
151     
152    </h4>
153
154   
155
156   
157
158    <a name="#_fitintobox_keyword_firstx"></a>
159    <h4>firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160      <font size="-1" color="#006633">in</font>
161     
162      <font size="-1" color="#006633">optional</font>
163     
164     
165     
166      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
167     
168    </h4>
169
170   
171
172   
173
174    <a name="#_fitintobox_keyword_firsty"></a>
175    <h4>firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176      <font size="-1" color="#006633">in</font>
177     
178      <font size="-1" color="#006633">optional</font>
179     
180     
181     
182      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
183     
184    </h4>
185
186   
187
188   
189
190    <a name="#_fitintobox_keyword_firstz"></a>
191    <h4>firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192      <font size="-1" color="#006633">in</font>
193     
194      <font size="-1" color="#006633">optional</font>
195     
196     
197     
198      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
199     
200    </h4>
201
202   
203
204   
205
206    <a name="#_fitintobox_keyword_lastx"></a>
207    <h4>lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208      <font size="-1" color="#006633">in</font>
209     
210      <font size="-1" color="#006633">optional</font>
211     
212     
213     
214      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
215     
216    </h4>
217
218   
219
220   
221
222    <a name="#_fitintobox_keyword_lasty"></a>
223    <h4>lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224      <font size="-1" color="#006633">in</font>
225     
226      <font size="-1" color="#006633">optional</font>
227     
228     
229     
230      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
231     
232    </h4>
233
234   
235
236   
237
238    <a name="#_fitintobox_keyword_lastz"></a>
239    <h4>lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240      <font size="-1" color="#006633">in</font>
241     
242      <font size="-1" color="#006633">optional</font>
243     
244     
245     
246      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>define by grille.pro</i></font>
247     
248    </h4>
249
250   
251
252   
253   
254
255   
256    <h3>Keywords</h3>
257
258   
259    <a name="#_fitintobox_keyword_WDEPTH"></a>
260    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
261     
262     
263     
264     
265     
266     
267     
268     
269    </h4>
270
271     
272 To specify that we are at W level
273
274   
275   
276
277    <h3>Examples</h3> 
278 IDL> help, fitintobox(findgen(jpi,jpj))
279 <Expression>    FLOAT     = Array[41, 3]
280 IDL> help, fitintobox(findgen(jpi,jpj,78))
281 Error:
282 the array dimensions [180,148,78] are incompatible
283 with the the domain dimensions
284 [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
285 <Expression>    INT       =       -1
286
287    <h3>Version history</h3>
288   
289    <h4>Version</h4> $Id: fitintobox.pro 157 2006-08-21 09:01:50Z navarro $
290    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
291          10 juin 2000.
292          June 2005: S. Masson rewrite all.
293
294   
295
296   
297   
298   
299   
300   
301
302    <h3>Other attributes</h3>
303   
304   
305    <h4>Uses routines</h4> cm_4mesh
306 cm_4cal
307
308   
309   
310   
311
312    <font size="-3"><p>&nbsp;</p></font>
313    <hr size="1" color="#CCCCCC"/>
314     
315
316   
317
318    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:56 2006.</font></p>
319
320  </body>
321</html>
Note: See TracBrowser for help on using the repository browser.