Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/checkfield.html @ 363

Last change on this file since 363 was 363, checked in by smasson, 16 years ago
update documentation
File size: 17.4 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: