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

Last change on this file since 338 was 338, checked in by smasson, 16 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. If NAME
164 does not contain the separating character of directories ('/' under
165 unix for example), the file will be looked for in the current directory.
166
167   
168
169    <a name="#_err_1d_keyword_n2"></a>
170    <h4>n2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171      <font size="-1" color="#006633">in</font>
172     
173     
174      <font size="-1" color="#006633">required</font>
175     
176      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
177     
178     
179    </h4>
180
181   
182 Number of elements in the second dimension
183
184   
185   
186
187   
188
189    <h3>Examples</h3><pre>
190
191    </pre><h3>Version history</h3>
192   
193    <h4>Version</h4>
194 $Id: checkfield.pro 327 2007-12-13 16:22:35Z pinsard $
195
196    <h4>History</h4>
197
198   
199
200    <h3>Known issues</h3>
201   
202   
203   
204    <h4>Restrictions</h4>
205
206
207   
208   
209   
210   
211   
212   
213   
214
215    <font size="-3"><p>&nbsp;</p></font>
216    <hr size="1" color="#CCCCCC"/>
217     
218      <a name="#_err_2d"></a>
219
220      <h2>err_2d  <font size="-1" color="#006633">
221</font></h2>
222
223      <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>
224
225   
226
227
228    <h3>Return value</h3>
229
230
231   
232    <h3>Parameters</h3>
233   
234
235    <a name="#_err_2d_keyword_type"></a>
236    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237      <font size="-1" color="#006633">in</font>
238     
239     
240      <font size="-1" color="#006633">required</font>
241     
242      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
243     
244     
245    </h4>
246
247   
248 A string of two characters specifying the type of plot we do
249
250   
251
252    <a name="#_err_2d_keyword_sz"></a>
253    <h4>sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254      <font size="-1" color="#006633">in</font>
255     
256      <font size="-1" color="#006633">optional</font>
257     
258     
259     
260      <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>
261     
262    </h4>
263
264   
265
266   
267
268    <a name="#_err_2d_keyword_nx"></a>
269    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
270      <font size="-1" color="#006633">in</font>
271     
272      <font size="-1" color="#006633">optional</font>
273     
274     
275     
276      <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>
277     
278    </h4>
279
280   
281
282   
283
284    <a name="#_err_2d_keyword_ny"></a>
285    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
286      <font size="-1" color="#006633">in</font>
287     
288      <font size="-1" color="#006633">optional</font>
289     
290     
291     
292      <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>
293     
294    </h4>
295
296   
297
298   
299
300    <a name="#_err_2d_keyword_nz"></a>
301    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
302     
303     
304     
305     
306     
307     
308     
309     
310    </h4>
311
312   
313
314   
315   
316
317   
318
319    <h3>Examples</h3><pre>
320
321    </pre><h3>Version history</h3>
322   
323    <h4>Version</h4>
324 $Id: checkfield.pro 327 2007-12-13 16:22:35Z pinsard $
325
326    <h4>History</h4>
327
328   
329
330    <h3>Known issues</h3>
331   
332   
333   
334    <h4>Restrictions</h4>
335
336
337   
338   
339   
340   
341   
342   
343   
344
345    <font size="-3"><p>&nbsp;</p></font>
346    <hr size="1" color="#CCCCCC"/>
347     
348      <a name="#_err_3d"></a>
349
350      <h2>err_3d  <font size="-1" color="#006633">
351</font></h2>
352
353      <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>
354
355   
356
357
358    <h3>Return value</h3>
359
360
361   
362    <h3>Parameters</h3>
363   
364
365    <a name="#_err_3d_keyword_type"></a>
366    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
367      <font size="-1" color="#006633">in</font>
368     
369     
370      <font size="-1" color="#006633">required</font>
371     
372      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
373     
374     
375    </h4>
376
377   
378 A string of two characters specifying the type of plot we do
379
380   
381
382    <a name="#_err_3d_keyword_sz"></a>
383    <h4>sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
384      <font size="-1" color="#006633">in</font>
385     
386      <font size="-1" color="#006633">optional</font>
387     
388     
389     
390      <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>
391     
392    </h4>
393
394   
395
396   
397
398    <a name="#_err_3d_keyword_nx"></a>
399    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
400      <font size="-1" color="#006633">in</font>
401     
402      <font size="-1" color="#006633">optional</font>
403     
404     
405     
406      <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>
407     
408    </h4>
409
410   
411
412   
413
414    <a name="#_err_3d_keyword_ny"></a>
415    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
416      <font size="-1" color="#006633">in</font>
417     
418      <font size="-1" color="#006633">optional</font>
419     
420     
421     
422      <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>
423     
424    </h4>
425
426   
427
428   
429
430    <a name="#_err_3d_keyword_nz"></a>
431    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
432     
433     
434     
435     
436     
437     
438     
439     
440    </h4>
441
442   
443
444   
445   
446
447   
448
449    <h3>Examples</h3><pre>
450
451    </pre><h3>Version history</h3>
452   
453    <h4>Version</h4>
454 $Id: checkfield.pro 327 2007-12-13 16:22:35Z pinsard $
455
456    <h4>History</h4>
457
458   
459
460    <h3>Known issues</h3>
461   
462   
463   
464    <h4>Restrictions</h4>
465
466
467   
468   
469   
470   
471   
472   
473   
474
475    <font size="-3"><p>&nbsp;</p></font>
476    <hr size="1" color="#CCCCCC"/>
477     
478      <a name="#_checkfield"></a>
479
480      <h2>checkfield  <font size="-1" color="#006633">
481 Graphics
482</font></h2>
483
484      <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>
485
486   
487
488
489   
490
491   
492    <h3>Parameters</h3>
493   
494
495    <a name="#_checkfield_keyword_field"></a>
496    <h4>field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
497      <font size="-1" color="#006633">in</font>
498     
499     
500      <font size="-1" color="#006633">required</font>
501     
502      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>field</i></font>
503     
504     
505    </h4>
506
507   
508 It respect <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>'s criterions. See IDL>xhelp,'litchamp'
509
510   
511
512    <a name="#_checkfield_keyword_procedure"></a>
513    <h4>procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
514      <font size="-1" color="#006633">in</font>
515     
516     
517      <font size="-1" color="#006633">required</font>
518     
519     
520     
521     
522    </h4>
523
524   
525
526   
527   
528
529   
530    <h3>Keywords</h3>
531
532   
533    <a name="#_checkfield_keyword_TYPE"></a>
534    <h4>TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
535     
536     
537     
538     
539     
540     
541     
542     
543    </h4>
544
545   
546
547   
548    <a name="#_checkfield_keyword_BOXZOOM"></a>
549    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
550     
551     
552     
553     
554     
555      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
556     
557     
558    </h4>
559
560   
561 Vector indicating the geographic zone on which we want to cut the map.
562  If BOXZOOM has :
563 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
564 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
565 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
566 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
567 6 elements: The extraction is made on Boxzoom
568
569 Where lon1, lon2,lat1,lat2 are global variables defined at the last
570 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
571
572   
573    <a name="#_checkfield_keyword_DIREC"></a>
574    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
575     
576     
577     
578     
579     
580     
581     
582     
583    </h4>
584
585   
586
587   
588    <a name="#_checkfield_keyword_NOQUESTION"></a>
589    <h4>NOQUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
590     
591     
592     
593     
594     
595     
596     
597     
598    </h4>
599
600   
601
602   
603    <a name="#_checkfield_keyword_VECTEUR"></a>
604    <h4>VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
605     
606     
607     
608     
609     
610      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
611     
612     
613    </h4>
614
615     is also appropriated.
616
617   
618    <a name="#_checkfield_keyword_WDEPTH"></a>
619    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
620     
621     
622     
623     
624     
625     
626     
627     
628    </h4>
629
630   
631 to specify that the field is at W depth instead of T
632 depth (automatically activated if vargrid eq 'W')
633
634   
635    <a name="#_checkfield_keyword__EXTRA"></a>
636    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
637     
638     
639     
640     
641     
642     
643     
644     
645    </h4>
646
647   
648 Used to pass keywords
649
650   
651   
652
653   
654    </pre><h3>Version history</h3>
655   
656    <h4>Version</h4>
657 $Id: checkfield.pro 327 2007-12-13 16:22:35Z pinsard $
658
659    <h4>History</h4>
660 Sebastien Masson (smasson@lodyc.jussieu.fr)
661                      08/02/2000
662
663   
664
665    <h3>Known issues</h3>
666   
667   
668    <h4>Todo items</h4> seb: mettre les param
669
670   
671
672    <h3>Other attributes</h3>
673   
674   
675    <h4>Uses routines</h4>
676 common.pro
677
678   
679   
680   
681
682    <font size="-3"><p>&nbsp;</p></font>
683    <hr size="1" color="#CCCCCC"/>
684     
685
686   
687
688    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
689
690  </body>
691</html>
Note: See TracBrowser for help on using the repository browser.