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>checkfield.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="checkfield.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?format=raw" title="Overview of library">Overview</a></td> |
---|
36 | |
---|
37 | |
---|
38 | |
---|
39 | <td >Directory</td> |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | <td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | <td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
52 | |
---|
53 | |
---|
54 | <td id="selected">File</td> |
---|
55 | |
---|
56 | |
---|
57 | <td >Source</td> |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | <td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
---|
62 | |
---|
63 | |
---|
64 | <td >Etc</td> |
---|
65 | |
---|
66 | <td id="flexible">Developer documentation</td> |
---|
67 | </tr> |
---|
68 | </table> |
---|
69 | |
---|
70 | </div> |
---|
71 | |
---|
72 | <div id="secondary_navbar"> |
---|
73 | |
---|
74 | <a href="barrecouleur.html"><<prev file</a> | <a href="checktypeminmax.html">next file >></a> <a href="checkfield.html" target="_TOP">view single page</a> | <a href="./../../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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?format=raw">ToBeReviewed/PLOTS/DIVERS/</a></h1> |
---|
82 | <h2 class="pro_file">checkfield.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"></div> |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | <div id="routine_summary"> |
---|
99 | <h2>Routine summary</h2> |
---|
100 | |
---|
101 | <dl> |
---|
102 | |
---|
103 | <dt><p><a href="#_err_1d"><span class="result">result = </span>err_1d(<span class="result">type, n1, name, n2</span>)</a></p><dt> |
---|
104 | <dd> NAME:checkfield PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le champ donne a bien une taille compatible avec le domaine et fait au besoin les moyennes pour ressortir en fin de fonction un tableau 2d si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'.</dd> |
---|
105 | |
---|
106 | <dt><p><a href="#_err_2d"><span class="result">result = </span>err_2d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> |
---|
107 | <dd></dd> |
---|
108 | |
---|
109 | <dt><p><a href="#_err_3d"><span class="result">result = </span>err_3d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> |
---|
110 | <dd></dd> |
---|
111 | |
---|
112 | <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> |
---|
113 | <dd></dd> |
---|
114 | |
---|
115 | </dl> |
---|
116 | </div> |
---|
117 | |
---|
118 | |
---|
119 | <div id="routine_details"> |
---|
120 | |
---|
121 | |
---|
122 | <div class="routine_details" id="_err_1d"> |
---|
123 | |
---|
124 | <h2><a class="top" href="#container">top</a>err_1d </h2> |
---|
125 | |
---|
126 | <p class="header"> |
---|
127 | <span class="result">result = </span>err_1d(<span class="result"><a href="#_err_1d_param_type">type</a>, <a href="#_err_1d_param_n1">n1</a>, <a href="#_err_1d_param_name">name</a>, <a href="#_err_1d_param_n2">n2</a></span>)</p> |
---|
128 | |
---|
129 | <div class="comments"> |
---|
130 | NAME:checkfield |
---|
131 | |
---|
132 | PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le |
---|
133 | champ donne a bien une taille compatible avec le domaine et fait au |
---|
134 | besoin les moyennes pour ressortir en fin de fonction un tableau 2d |
---|
135 | si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un |
---|
136 | tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'. |
---|
137 | |
---|
138 | CATEGORY:en entree de plt, pltz, pltt et plt1d |
---|
139 | |
---|
140 | CALLING SEQUENCE:res=checkfield(field, procedure) |
---|
141 | |
---|
142 | INPUTS: |
---|
143 | filed: un champ recomdant aux criteres de litchamp.pro, cf. |
---|
144 | IDL>xhelp,'litchamp' |
---|
145 | |
---|
146 | KEYWORD PARAMETERS: |
---|
147 | |
---|
148 | /WDEPTH: to specify that the field is at W depth instad of T |
---|
149 | depth (automatically activated if vargrid eq 'W') |
---|
150 | |
---|
151 | OUTPUTS: |
---|
152 | |
---|
153 | COMMON BLOCKS:common.pro |
---|
154 | |
---|
155 | SIDE EFFECTS: |
---|
156 | |
---|
157 | RESTRICTIONS: |
---|
158 | |
---|
159 | EXAMPLE: |
---|
160 | </div> |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | |
---|
165 | <h3>Parameters</h3> |
---|
166 | |
---|
167 | |
---|
168 | <h4 id="_err_1d_param_type">type |
---|
169 | |
---|
170 | |
---|
171 | |
---|
172 | |
---|
173 | |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | </h4> |
---|
178 | |
---|
179 | <div class="comments"></div> |
---|
180 | |
---|
181 | <h4 id="_err_1d_param_n1">n1 |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | </h4> |
---|
191 | |
---|
192 | <div class="comments"></div> |
---|
193 | |
---|
194 | <h4 id="_err_1d_param_name">name |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | </h4> |
---|
204 | |
---|
205 | <div class="comments"></div> |
---|
206 | |
---|
207 | <h4 id="_err_1d_param_n2">n2 |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | </h4> |
---|
217 | |
---|
218 | <div class="comments"></div> |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | |
---|
223 | |
---|
224 | |
---|
225 | |
---|
226 | |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | |
---|
236 | |
---|
237 | |
---|
238 | |
---|
239 | |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | </div> |
---|
249 | |
---|
250 | |
---|
251 | <div class="routine_details" id="_err_2d"> |
---|
252 | |
---|
253 | <h2><a class="top" href="#container">top</a>err_2d </h2> |
---|
254 | |
---|
255 | <p class="header"> |
---|
256 | <span class="result">result = </span>err_2d(<span class="result"><a href="#_err_2d_param_type">type</a>, <a href="#_err_2d_param_sz">sz</a>, <a href="#_err_2d_param_nx">nx</a>, <a href="#_err_2d_param_ny">ny</a>, <a href="#_err_2d_param_nz">nz</a></span>)</p> |
---|
257 | |
---|
258 | <div class="comments"></div> |
---|
259 | |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | <h3>Parameters</h3> |
---|
264 | |
---|
265 | |
---|
266 | <h4 id="_err_2d_param_type">type |
---|
267 | |
---|
268 | |
---|
269 | |
---|
270 | |
---|
271 | |
---|
272 | |
---|
273 | |
---|
274 | |
---|
275 | </h4> |
---|
276 | |
---|
277 | <div class="comments"></div> |
---|
278 | |
---|
279 | <h4 id="_err_2d_param_sz">sz |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | </h4> |
---|
289 | |
---|
290 | <div class="comments"></div> |
---|
291 | |
---|
292 | <h4 id="_err_2d_param_nx">nx |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | </h4> |
---|
302 | |
---|
303 | <div class="comments"></div> |
---|
304 | |
---|
305 | <h4 id="_err_2d_param_ny">ny |
---|
306 | |
---|
307 | |
---|
308 | |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | </h4> |
---|
315 | |
---|
316 | <div class="comments"></div> |
---|
317 | |
---|
318 | <h4 id="_err_2d_param_nz">nz |
---|
319 | |
---|
320 | |
---|
321 | |
---|
322 | |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | </h4> |
---|
328 | |
---|
329 | <div class="comments"></div> |
---|
330 | |
---|
331 | |
---|
332 | |
---|
333 | |
---|
334 | |
---|
335 | |
---|
336 | |
---|
337 | |
---|
338 | |
---|
339 | |
---|
340 | |
---|
341 | |
---|
342 | |
---|
343 | |
---|
344 | |
---|
345 | |
---|
346 | |
---|
347 | |
---|
348 | |
---|
349 | |
---|
350 | |
---|
351 | |
---|
352 | |
---|
353 | |
---|
354 | |
---|
355 | |
---|
356 | |
---|
357 | |
---|
358 | |
---|
359 | </div> |
---|
360 | |
---|
361 | |
---|
362 | <div class="routine_details" id="_err_3d"> |
---|
363 | |
---|
364 | <h2><a class="top" href="#container">top</a>err_3d </h2> |
---|
365 | |
---|
366 | <p class="header"> |
---|
367 | <span class="result">result = </span>err_3d(<span class="result"><a href="#_err_3d_param_type">type</a>, <a href="#_err_3d_param_sz">sz</a>, <a href="#_err_3d_param_nx">nx</a>, <a href="#_err_3d_param_ny">ny</a>, <a href="#_err_3d_param_nz">nz</a></span>)</p> |
---|
368 | |
---|
369 | <div class="comments"></div> |
---|
370 | |
---|
371 | |
---|
372 | |
---|
373 | |
---|
374 | <h3>Parameters</h3> |
---|
375 | |
---|
376 | |
---|
377 | <h4 id="_err_3d_param_type">type |
---|
378 | |
---|
379 | |
---|
380 | |
---|
381 | |
---|
382 | |
---|
383 | |
---|
384 | |
---|
385 | |
---|
386 | </h4> |
---|
387 | |
---|
388 | <div class="comments"></div> |
---|
389 | |
---|
390 | <h4 id="_err_3d_param_sz">sz |
---|
391 | |
---|
392 | |
---|
393 | |
---|
394 | |
---|
395 | |
---|
396 | |
---|
397 | |
---|
398 | |
---|
399 | </h4> |
---|
400 | |
---|
401 | <div class="comments"></div> |
---|
402 | |
---|
403 | <h4 id="_err_3d_param_nx">nx |
---|
404 | |
---|
405 | |
---|
406 | |
---|
407 | |
---|
408 | |
---|
409 | |
---|
410 | |
---|
411 | |
---|
412 | </h4> |
---|
413 | |
---|
414 | <div class="comments"></div> |
---|
415 | |
---|
416 | <h4 id="_err_3d_param_ny">ny |
---|
417 | |
---|
418 | |
---|
419 | |
---|
420 | |
---|
421 | |
---|
422 | |
---|
423 | |
---|
424 | |
---|
425 | </h4> |
---|
426 | |
---|
427 | <div class="comments"></div> |
---|
428 | |
---|
429 | <h4 id="_err_3d_param_nz">nz |
---|
430 | |
---|
431 | |
---|
432 | |
---|
433 | |
---|
434 | |
---|
435 | |
---|
436 | |
---|
437 | |
---|
438 | </h4> |
---|
439 | |
---|
440 | <div class="comments"></div> |
---|
441 | |
---|
442 | |
---|
443 | |
---|
444 | |
---|
445 | |
---|
446 | |
---|
447 | |
---|
448 | |
---|
449 | |
---|
450 | |
---|
451 | |
---|
452 | |
---|
453 | |
---|
454 | |
---|
455 | |
---|
456 | |
---|
457 | |
---|
458 | |
---|
459 | |
---|
460 | |
---|
461 | |
---|
462 | |
---|
463 | |
---|
464 | |
---|
465 | |
---|
466 | |
---|
467 | |
---|
468 | |
---|
469 | |
---|
470 | </div> |
---|
471 | |
---|
472 | |
---|
473 | <div class="routine_details" id="_checkfield"> |
---|
474 | |
---|
475 | <h2><a class="top" href="#container">top</a>checkfield </h2> |
---|
476 | |
---|
477 | <p class="header"> |
---|
478 | <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
---|
479 | |
---|
480 | <div class="comments"></div> |
---|
481 | |
---|
482 | |
---|
483 | |
---|
484 | |
---|
485 | <h3>Parameters</h3> |
---|
486 | |
---|
487 | |
---|
488 | <h4 id="_checkfield_param_field">field |
---|
489 | |
---|
490 | |
---|
491 | |
---|
492 | |
---|
493 | |
---|
494 | |
---|
495 | |
---|
496 | |
---|
497 | </h4> |
---|
498 | |
---|
499 | <div class="comments"></div> |
---|
500 | |
---|
501 | <h4 id="_checkfield_param_procedure">procedure |
---|
502 | |
---|
503 | |
---|
504 | |
---|
505 | |
---|
506 | |
---|
507 | |
---|
508 | |
---|
509 | |
---|
510 | </h4> |
---|
511 | |
---|
512 | <div class="comments"></div> |
---|
513 | |
---|
514 | |
---|
515 | |
---|
516 | |
---|
517 | |
---|
518 | |
---|
519 | <h3>Keywords</h3> |
---|
520 | |
---|
521 | <h4 id="_checkfield_keyword_TYPE">TYPE |
---|
522 | |
---|
523 | |
---|
524 | |
---|
525 | |
---|
526 | |
---|
527 | |
---|
528 | |
---|
529 | |
---|
530 | </h4> |
---|
531 | |
---|
532 | <div class="comments"></div> |
---|
533 | |
---|
534 | <h4 id="_checkfield_keyword_BOXZOOM">BOXZOOM |
---|
535 | |
---|
536 | |
---|
537 | |
---|
538 | |
---|
539 | |
---|
540 | |
---|
541 | |
---|
542 | |
---|
543 | </h4> |
---|
544 | |
---|
545 | <div class="comments"></div> |
---|
546 | |
---|
547 | <h4 id="_checkfield_keyword_DIREC">DIREC |
---|
548 | |
---|
549 | |
---|
550 | |
---|
551 | |
---|
552 | |
---|
553 | |
---|
554 | |
---|
555 | |
---|
556 | </h4> |
---|
557 | |
---|
558 | <div class="comments"></div> |
---|
559 | |
---|
560 | <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION |
---|
561 | |
---|
562 | |
---|
563 | |
---|
564 | |
---|
565 | |
---|
566 | |
---|
567 | |
---|
568 | |
---|
569 | </h4> |
---|
570 | |
---|
571 | <div class="comments"></div> |
---|
572 | |
---|
573 | <h4 id="_checkfield_keyword_VECTEUR">VECTEUR |
---|
574 | |
---|
575 | |
---|
576 | |
---|
577 | |
---|
578 | |
---|
579 | |
---|
580 | |
---|
581 | |
---|
582 | </h4> |
---|
583 | |
---|
584 | <div class="comments"></div> |
---|
585 | |
---|
586 | <h4 id="_checkfield_keyword_WDEPTH">WDEPTH |
---|
587 | |
---|
588 | |
---|
589 | |
---|
590 | |
---|
591 | |
---|
592 | |
---|
593 | |
---|
594 | |
---|
595 | </h4> |
---|
596 | |
---|
597 | <div class="comments"></div> |
---|
598 | |
---|
599 | <h4 id="_checkfield_keyword__EXTRA">_EXTRA |
---|
600 | |
---|
601 | |
---|
602 | |
---|
603 | |
---|
604 | |
---|
605 | |
---|
606 | |
---|
607 | |
---|
608 | </h4> |
---|
609 | |
---|
610 | <div class="comments"></div> |
---|
611 | |
---|
612 | |
---|
613 | |
---|
614 | |
---|
615 | |
---|
616 | |
---|
617 | |
---|
618 | |
---|
619 | |
---|
620 | |
---|
621 | |
---|
622 | |
---|
623 | |
---|
624 | |
---|
625 | |
---|
626 | |
---|
627 | |
---|
628 | |
---|
629 | |
---|
630 | |
---|
631 | |
---|
632 | |
---|
633 | |
---|
634 | |
---|
635 | |
---|
636 | |
---|
637 | </div> |
---|
638 | |
---|
639 | </div> |
---|
640 | |
---|
641 | |
---|
642 | |
---|
643 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
644 | |
---|
645 | </div> |
---|
646 | |
---|
647 | </body> |
---|
648 | </html> |
---|