source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DIVERS/checkfield.html @ 402

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

update documentation
File size: 14.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>checkfield.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="barrecouleur.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="checktypeminmax.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/DIVERS/</font></h1>
58    <h2>checkfield.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70 In input of <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>, <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltz.html">pltz</a>, <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltt.html">pltt</a> and <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt1d.html">plt1d</a>, it check that the field give
71 a size compatible with the domain and, if needed, average to give us
72 a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt'
73 , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'.
74
75
76   
77    <h2>Routine summary</h2>
78
79    <dl>
80     
81      <dt><a href="#_err_1d"><i>result = </i>err_1d(<i>type, n1[, name], n2</i>)</a><dt>
82      <dd><font size="-1"> </font></dd>
83     
84      <dt><a href="#_err_2d"><i>result = </i>err_2d(<i>type[, sz][, nx][, ny], nz</i>)</a><dt>
85      <dd><font size="-1"> </font></dd>
86     
87      <dt><a href="#_err_3d"><i>result = </i>err_3d(<i>type[, sz][, nx][, ny], nz</i>)</a><dt>
88      <dd><font size="-1"> </font></dd>
89     
90      <dt><a href="#_checkfield"><i>result = </i>checkfield(<i>field, procedure</i>, TYPE=<i>TYPE</i>, BOXZOOM=<i>vector</i>, DIREC=<i>DIREC</i>, NOQUESTION=<i>NOQUESTION</i>, VECTEUR=<i>vector</i>, WDEPTH=<i>WDEPTH</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
91      <dd><font size="-1"> </font></dd>
92     
93    </dl>
94
95    <p>&nbsp;</p>
96   
97
98     
99      <a name="#_err_1d"></a>
100
101      <h2>err_1d  <font size="-1" color="#006633">
102</font></h2>
103
104      <p><font face="Courier"><i>result = </i>err_1d(<i><a href="#_err_1d_keyword_type">type</a>, <a href="#_err_1d_keyword_n1">n1</a>[, <a href="#_err_1d_keyword_name">name</a>], <a href="#_err_1d_keyword_n2">n2</a></i>)</font></p>
105
106   
107
108
109    <h3>Return value</h3>
110
111
112   
113    <h3>Parameters</h3>
114   
115
116    <a name="#_err_1d_keyword_type"></a>
117    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
118      <font size="-1" color="#006633">in</font>
119     
120     
121      <font size="-1" color="#006633">required</font>
122     
123      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
124     
125     
126    </h4>
127
128   
129 A string of two characters specifying the type of plot we do
130
131   
132
133    <a name="#_err_1d_keyword_n1"></a>
134    <h4>n1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135      <font size="-1" color="#006633">in</font>
136     
137     
138      <font size="-1" color="#006633">required</font>
139     
140      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
141     
142     
143    </h4>
144
145   
146 Number of elements in the first dimension
147
148   
149
150    <a name="#_err_1d_keyword_name"></a>
151    <h4>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152      <font size="-1" color="#006633">in</font>
153     
154      <font size="-1" color="#006633">optional</font>
155     
156     
157      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
158     
159     
160    </h4>
161
162   
163 It gives the name of the file to be opened.
164
165 If NAME
166 does not contain the separating character of directories ('/' under
167 unix for example), the file will be looked for in the current directory.
168
169   
170
171    <a name="#_err_1d_keyword_n2"></a>
172    <h4>n2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173      <font size="-1" color="#006633">in</font>
174     
175     
176      <font size="-1" color="#006633">required</font>
177     
178      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
179     
180     
181    </h4>
182
183   
184 Number of elements in the second dimension
185
186   
187   
188
189   
190
191    <h3>Examples</h3><pre>
192
193    </pre><h3>Version history</h3>
194   
195    <h4>Version</h4>
196 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
197
198    <h4>History</h4>
199
200   
201
202    <h3>Known issues</h3>
203   
204   
205   
206    <h4>Restrictions</h4>
207
208
209   
210   
211   
212   
213   
214   
215   
216
217    <font size="-3"><p>&nbsp;</p></font>
218    <hr size="1" color="#CCCCCC"/>
219     
220      <a name="#_err_2d"></a>
221
222      <h2>err_2d  <font size="-1" color="#006633">
223</font></h2>
224
225      <p><font face="Courier"><i>result = </i>err_2d(<i><a href="#_err_2d_keyword_type">type</a>[, <a href="#_err_2d_keyword_sz">sz</a>][, <a href="#_err_2d_keyword_nx">nx</a>][, <a href="#_err_2d_keyword_ny">ny</a>], <a href="#_err_2d_keyword_nz">nz</a></i>)</font></p>
226
227   
228
229
230    <h3>Return value</h3>
231
232
233   
234    <h3>Parameters</h3>
235   
236
237    <a name="#_err_2d_keyword_type"></a>
238    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239      <font size="-1" color="#006633">in</font>
240     
241     
242      <font size="-1" color="#006633">required</font>
243     
244      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
245     
246     
247    </h4>
248
249   
250 A string of two characters specifying the type of plot we do
251
252   
253
254    <a name="#_err_2d_keyword_sz"></a>
255    <h4>sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256      <font size="-1" color="#006633">in</font>
257     
258      <font size="-1" color="#006633">optional</font>
259     
260     
261     
262      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
263     
264    </h4>
265
266   
267
268   
269
270    <a name="#_err_2d_keyword_nx"></a>
271    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
272      <font size="-1" color="#006633">in</font>
273     
274      <font size="-1" color="#006633">optional</font>
275     
276     
277     
278      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
279     
280    </h4>
281
282   
283
284   
285
286    <a name="#_err_2d_keyword_ny"></a>
287    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
288      <font size="-1" color="#006633">in</font>
289     
290      <font size="-1" color="#006633">optional</font>
291     
292     
293     
294      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
295     
296    </h4>
297
298   
299
300   
301
302    <a name="#_err_2d_keyword_nz"></a>
303    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
304     
305     
306     
307     
308     
309     
310     
311     
312    </h4>
313
314   
315
316   
317   
318
319   
320
321    <h3>Examples</h3><pre>
322
323    </pre><h3>Version history</h3>
324   
325    <h4>Version</h4>
326 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
327
328    <h4>History</h4>
329
330   
331
332    <h3>Known issues</h3>
333   
334   
335   
336    <h4>Restrictions</h4>
337
338
339   
340   
341   
342   
343   
344   
345   
346
347    <font size="-3"><p>&nbsp;</p></font>
348    <hr size="1" color="#CCCCCC"/>
349     
350      <a name="#_err_3d"></a>
351
352      <h2>err_3d  <font size="-1" color="#006633">
353</font></h2>
354
355      <p><font face="Courier"><i>result = </i>err_3d(<i><a href="#_err_3d_keyword_type">type</a>[, <a href="#_err_3d_keyword_sz">sz</a>][, <a href="#_err_3d_keyword_nx">nx</a>][, <a href="#_err_3d_keyword_ny">ny</a>], <a href="#_err_3d_keyword_nz">nz</a></i>)</font></p>
356
357   
358
359
360    <h3>Return value</h3>
361
362
363   
364    <h3>Parameters</h3>
365   
366
367    <a name="#_err_3d_keyword_type"></a>
368    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
369      <font size="-1" color="#006633">in</font>
370     
371     
372      <font size="-1" color="#006633">required</font>
373     
374      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
375     
376     
377    </h4>
378
379   
380 A string of two characters specifying the type of plot we do
381
382   
383
384    <a name="#_err_3d_keyword_sz"></a>
385    <h4>sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
386      <font size="-1" color="#006633">in</font>
387     
388      <font size="-1" color="#006633">optional</font>
389     
390     
391     
392      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
393     
394    </h4>
395
396   
397
398   
399
400    <a name="#_err_3d_keyword_nx"></a>
401    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402      <font size="-1" color="#006633">in</font>
403     
404      <font size="-1" color="#006633">optional</font>
405     
406     
407     
408      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
409     
410    </h4>
411
412   
413
414   
415
416    <a name="#_err_3d_keyword_ny"></a>
417    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
418      <font size="-1" color="#006633">in</font>
419     
420      <font size="-1" color="#006633">optional</font>
421     
422     
423     
424      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></i></font>
425     
426    </h4>
427
428   
429
430   
431
432    <a name="#_err_3d_keyword_nz"></a>
433    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
434     
435     
436     
437     
438     
439     
440     
441     
442    </h4>
443
444   
445
446   
447   
448
449   
450
451    <h3>Examples</h3><pre>
452
453    </pre><h3>Version history</h3>
454   
455    <h4>Version</h4>
456 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
457
458    <h4>History</h4>
459
460   
461
462    <h3>Known issues</h3>
463   
464   
465   
466    <h4>Restrictions</h4>
467
468
469   
470   
471   
472   
473   
474   
475   
476
477    <font size="-3"><p>&nbsp;</p></font>
478    <hr size="1" color="#CCCCCC"/>
479     
480      <a name="#_checkfield"></a>
481
482      <h2>checkfield  <font size="-1" color="#006633">
483 Graphics
484</font></h2>
485
486      <p><font face="Courier"><i>result = </i>checkfield(<i><a href="#_checkfield_keyword_field">field</a>, <a href="#_checkfield_keyword_procedure">procedure</a></i>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<i>TYPE</i>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<i>vector</i>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<i>NOQUESTION</i>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<i>vector</i>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
487
488   
489
490
491   
492
493   
494    <h3>Parameters</h3>
495   
496
497    <a name="#_checkfield_keyword_field"></a>
498    <h4>field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
499      <font size="-1" color="#006633">in</font>
500     
501     
502      <font size="-1" color="#006633">required</font>
503     
504      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>field</i></font>
505     
506     
507    </h4>
508
509   
510 It respect <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>'s criterions.
511
512   
513
514    <a name="#_checkfield_keyword_procedure"></a>
515    <h4>procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
516      <font size="-1" color="#006633">in</font>
517     
518     
519      <font size="-1" color="#006633">required</font>
520     
521     
522     
523     
524    </h4>
525
526   
527
528   
529   
530
531   
532    <h3>Keywords</h3>
533
534   
535    <a name="#_checkfield_keyword_TYPE"></a>
536    <h4>TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
537     
538     
539     
540     
541     
542     
543     
544     
545    </h4>
546
547   
548
549   
550    <a name="#_checkfield_keyword_BOXZOOM"></a>
551    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
552     
553     
554     
555     
556     
557      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
558     
559     
560    </h4>
561
562   
563 Vector indicating the geographic zone on which we want to cut the map.
564
565  If BOXZOOM has :
566 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
567 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
568 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
569 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
570 6 elements: The extraction is made on Boxzoom
571
572 Where lon1, lon2,lat1,lat2 are global variables defined at the last
573 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
574
575   
576    <a name="#_checkfield_keyword_DIREC"></a>
577    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
578     
579     
580     
581     
582     
583     
584     
585     
586    </h4>
587
588   
589
590   
591    <a name="#_checkfield_keyword_NOQUESTION"></a>
592    <h4>NOQUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
593     
594     
595     
596     
597     
598     
599     
600     
601    </h4>
602
603   
604
605   
606    <a name="#_checkfield_keyword_VECTEUR"></a>
607    <h4>VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
608     
609     
610     
611     
612     
613      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
614     
615     
616    </h4>
617
618     is also appropriated.
619
620   
621    <a name="#_checkfield_keyword_WDEPTH"></a>
622    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
623     
624     
625     
626     
627     
628     
629     
630     
631    </h4>
632
633   
634 to specify that the field is at W depth instead of T
635 depth (automatically activated if vargrid eq 'W')
636
637   
638    <a name="#_checkfield_keyword__EXTRA"></a>
639    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
640     
641     
642     
643     
644     
645     
646     
647     
648    </h4>
649
650   
651 Used to pass keywords
652
653   
654   
655
656   
657    </pre><h3>Version history</h3>
658   
659    <h4>Version</h4>
660 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
661
662    <h4>History</h4>
663 Sebastien Masson (smasson@lodyc.jussieu.fr)
664                      08/02/2000
665
666   
667
668    <h3>Known issues</h3>
669   
670   
671    <h4>Todo items</h4> seb: mettre les param
672
673   
674
675    <h3>Other attributes</h3>
676   
677   
678    <h4>Uses routines</h4>
679 <a href="../../..//Obsolete/common.html">common</a>
680
681   
682   
683   
684
685    <font size="-3"><p>&nbsp;</p></font>
686    <hr size="1" color="#CCCCCC"/>
687     
688
689   
690
691    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
692
693  </body>
694</html>
Note: See TracBrowser for help on using the repository browser.