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

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

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