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