Context Navigation

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

Last change on this file since 157 was 157, checked in by navarro, 18 years ago
header improvements + xxx doc
File size: 25.3 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	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.snippet {
57	margin-left: 5%;
58	background: #F0F0F0;
59	border: 1px dashed #999999;
60	width: 43em;
61	padding: 0.5em 0.5em 0.5em 0.5em;
62	white-space: pre;
63	}
64
65	/* Navbar styles ------------------------------------------------------------- */
66
67	#navbar_title {
68	color: #000033;
69	background-color: #F0F0FF;
70	font-family: Arial, Helvetica, sans-serif;
71	padding: 20px 30px;
72	border-bottom: 1px solid #000033;
73	}
74
75	#navbar_title * {
76	margin: 0;
77	padding: 0;
78	}
79
80	#navbar_title h1 {
81	letter-spacing: 0.1em;
82	font-variant: small-caps;
83	font-size: 250%;
84	text-indent: -1em;
85	padding-left: 1em;
86	}
87
88	#navbar_title h2 {
89	font-size: 110%;
90	font-weight: normal;
91	color: #333399;
92	}
93
94	#main_navbar table {
95	width: 100%;
96	border-bottom: 1px solid #666699;
97	}
98
99	#main_navbar td {
100	background: #CCCCFF;
101	font-size: 80%;
102	font-weight: bold;
103	font-family: Arial, Helvetica, sans-serif;
104	border-top: 3px solid #CCCCFF;
105	border-bottom: 3px solid #CCCCFF;
106	padding-left: 6px;
107	padding-right: 6px;
108	margin: 0;
109	}
110
111	#main_navbar td#selected {
112	background: #CCCCFF;
113	font-size: 80%;
114	font-weight: bold;
115	font-family: Arial, Helvetica, sans-serif;
116	border-top: 3px solid #333399;
117	border-bottom: 3px solid #CCCCFF;
118	padding-left: 6px;
119	padding-right: 6px;
120	margin: 0;
121	}
122
123	#main_navbar td#flexible {
124	width: 100%;
125	text-align: right;
126	padding-right: 1em;
127	background: #CCCCFF;
128	font-size: 70%;
129	font-weight: normal;
130	font-family: Arial, Helvetica, sans-serif;
131	text-transform: uppercase;
132	border-top: 3px solid #CCCCFF;
133	border-bottom: 3px solid #CCCCFF;
134	}
135
136	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138	#main_navbar a:hover, #main_navbar a:focus {
139	color: #FFFF66;
140	background: #CCCCFF;
141	border-bottom: 1px none #606099;
142	border: 0;
143	}
144
145	#secondary_navbar {
146	font-size: 80%;
147	font-weight: normal;
148	font-family: Arial, Helvetica, sans-serif;
149	margin-top: 4px;
150	margin-left: 20px;
151	white-space: nowrap;
152	}
153
154
155	/* Tagline and footer styles ------------------------------------------------- */
156
157	div#tagline {
158	margin-top: 6px;
159	border-top: 1px dotted lightsteelblue;
160	padding-top: 6px;
161	font-size: 66%;
162	font-style: italic;
163	}
164
165	div#footer {
166	margin-top: 6px;
167	border-top: 1px dotted lightsteelblue;
168	padding-top: 6px;
169	font-size: 66%;
170	font-style: italic;
171	}
172
173	/* Basic data presenation styles -------------------------------------------- */
174
175	.index_letter {
176	font-size: 300%;
177	font-weight: bold;
178	color: #000066;
179	margin: 0.5em 0 0 -0.1em;
180	}
181
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.basic th {
217	background-color: #F0F0FF;
218	font-weight: bold;
219	text-align: left;
220	padding: 4px 1em 4px 4px;
221	border-bottom: 1px dotted #666699;
222	}
223
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
230	margin-bottom: 0.25em;
231	font-size: 80%;
232	}
233
234
235	/* Warnings styles ----------------------------------------------------------- */
236
237
238	#todo dl, #bugs dl {
239	margin: 0 0 0 1.5em;
240	font-size: 80%;
241	}
242
243	#todo dd, #bugs dd {
244	margin-left: 3em;
245	font-size: 100%;
246	}
247
248	#undoc table, #obsolete table, #statistics table {
249	width: 80%;
250	margin-left: 2em;
251	}
252
253	#undoc td, #obsolete td, #statistics td {
254	padding: 0 0 0 0;
255	font-size: 80%;
256	white-space: nowrap;
257	}
258
259	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261	#undoc td.docstat, #statistics td.stat {
262	width: 50%;
263	text-align: right;
264	}
265
266	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268	#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270	/* File + routine styles ----------------------------------------------------- */
271
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#sav_attr {
309	font-size: 90%;
310	margin: 1em;
311	padding: 1em 1em 1em 1em;
312	background: #F6F6F6;
313	border: 1px dotted #999999;
314	}
315
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#routine_summary p, div.routine_details p.header {
432	padding-top: 0.5em;
433	margin-left: 1.5em;
434	text-indent: -1.5em;
435	font-family: 'Courier New', monospace;
436	}
437
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.overview table {
481	empty-cells: show;
482	font-size: 90%;
483	margin: 1em 1em 1em 1em;
484	padding: 1em 0.5em 1em 0.5em;
485	background: #F6F6F6;
486	border: 1px dotted #999999;
487	}
488
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.overview td.dir {
494	width: 1%;
495	vertical-align: top;
496	text-align: right;
497	padding-right: 1em;
498	}
499
500
501	/* Navigation list styles for tree structures -------------------------------- */
502
503	#tree {
504	text-align: left;
505	font-size: 90%;
506	margin: 0.75em 0 0.75em 0;
507	padding: 0;
508	}
509
510	#tree ul {
511	text-align: left;
512	margin: 0;
513	padding: 0;
514	}
515
516	#tree li {
517	margin: 0 0 0 15px;
518	padding: 0;
519	list-style-type: none;
520	}
521
522	#tree .symbols {
523	float: left;
524	width: 12px;
525	height: 1em;
526	padding-left: 4px;
527	background-position: 0 100%;
528	background-repeat: no-repeat;
529	}
530
531	/* Search styles ------------------------------------------------------------- */
532
533	input.writein {
534	padding-left: 0.5em;
535	border: 1px solid #CCCCCC;
536	font-family: 'Courier New';
537	background: #FFFFF3;
538	}
539
540	#search form {
541	margin-left: 2em;
542	}
543
544	#search table {
545	margin: 1em 1em 0 2em;
546	padding: 1em 2em 1em 2em;
547	background: #F6F6F6;
548	border: 1px dotted #999999;
549	}
550
551	#search tr {
552	text-align: center;
553	}
554
555	#search td {
556	font-size: 80%;
557	text-align: left;
558	}
559
560	#search td * {
561	vertical-align: middle;
562	}
563
564	#search p {
565	font-size: 66%;
566	margin: 0 3em 2em 3em;
567	}
568
569	/* Help styles --------------------------------------------------------------- */
570
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.variables dd { margin-bottom: 0.5em; }
596
597	</style>
598	<style type="text/css" media="print">
599	#navbar_title {
600	background-color: #FFFFFF;
601	}
602
603	#main_navbar td {
604	background: #FFFFFF;
605	border-top: 0.25em solid #FFFFFF;
606	border-bottom: 0.25em solid #FFFFFF;
607	}
608
609	#main_navbar td#selected {
610	background: #FFFFFF;
611	border-top: 0.25em solid #333399;
612	border-bottom: 0.25em solid #FFFFFF;
613	}
614
615	#main_navbar td#flexible {
616	background: #FFFFFF;
617	border-top: 0.25em solid #FFFFFF;
618	border-bottom: 0.25em solid #FFFFFF;
619	}
620
621	#secondary_navbar {
622	display: none;
623	}
624
625	</style>
626
627
628	<script type="text/javascript">
629	function setTitle() {
630	parent.document.title="checkfield.pro (SAXO Documentation)";
631	}
632	</script>
633	</head>
634
635	<body onload="setTitle();">
636
637	<div id="navbar_title">
638	<h1>SAXO Documentation</h1>
639	</div>
640
641
642	<div id="main_navbar">
643
644	<table cellspacing="0">
645	<tr>
646
647	<td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
648
649
650
651	<td >Directory</td>
652
653
654
655	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656
657
658
659	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660
661
662
663	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
664
665
666	<td id="selected">File</td>
667
668
669	<td >Source</td>
670
671
672
673	<td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674
675
676	<td >Etc</td>
677
678	<td id="flexible">Developer documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<a href="barrecouleur.html?format=raw"><<prev file</a> \| <a href="checktypeminmax.html?format=raw">next file >></a>    <a href="checkfield.html?format=raw" target="_TOP">view single page</a> \| <a href="./../../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
687
688	</div>
689
690
691	<div id="container">
692
693	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/PLOTS/DIVERS/</a></h1>
694	<h2 class="pro_file">checkfield.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702
703
704
705
706
707
708
709
710
711	In input of plt, pltz, pltt and plt1d, it check that the field give
712	a size compatible with the domain and, if needed, average to give us
713	a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt'
714	, 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'.
715	</div>
716
717
718
719
720
721
722
723
724	<div id="routine_summary">
725	<h2>Routine summary</h2>
726
727	<dl>
728
729	<dt><p><a href="#_err_1d"><span class="result">result = </span>err_1d(<span class="result">type, n1[, name], n2</span>)</a></p><dt>
730	<dd></dd>
731
732	<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>
733	<dd></dd>
734
735	<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>
736	<dd></dd>
737
738	<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">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
739	<dd> </dd>
740
741	</dl>
742	</div>
743
744
745	<div id="routine_details">
746
747
748	<div class="routine_details" id="_err_1d">
749
750	<h2><a class="top" href="#container">top</a>err_1d <span class="categories">
751
752	</span></h2>
753
754	<p class="header">
755	<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>
756
757	<div class="comments"></div>
758
759	<h3>Return value</h3><div class="preformat">
760
761	</div>
762
763
764	<h3>Parameters</h3>
765
766
767	<h4 id="_err_1d_param_type">type
768	<span class="attr">in</span>
769
770
771	<span class="attr">required</span>
772
773
774
775
776	</h4>
777
778	<div class="comments">
779	A string of two characters specifying the type of plot we do
780	</div>
781
782	<h4 id="_err_1d_param_n1">n1
783	<span class="attr">in</span>
784
785
786	<span class="attr">required</span>
787
788
789
790
791	</h4>
792
793	<div class="comments">
794	Number of elements in the first dimension
795	</div>
796
797	<h4 id="_err_1d_param_name">name
798	<span class="attr">in</span>
799
800	<span class="attr">optional</span>
801
802
803
804
805
806	</h4>
807
808	<div class="comments">
809	It is a string giving the name of the file to be opened. If NAME
810	does not contain the separating character of directories ('/' under
811	unix for example), the file will be looked for in the current directory.
812	</div>
813
814	<h4 id="_err_1d_param_n2">n2
815	<span class="attr">in</span>
816
817
818	<span class="attr">required</span>
819
820
821
822
823	</h4>
824
825	<div class="comments">
826	Number of elements in the second dimension
827	</div>
828
829
830
831
832
833
834	<h3>Examples</h3><div class="preformat">
835
836	</div>
837	<h3>Version history</h3>
838
839	<h4>Version</h4><div class="preformat">
840	$Id$</div>
841	<h4>History</h4><div class="preformat">
842
843	</div>
844
845
846	<h3>Known issues</h3>
847
848
849
850	<h4>Restrictions</h4><div class="preformat">
851
852	</div>
853
854
855
856
857
858
859
860
861
862
863
864	</div>
865
866
867	<div class="routine_details" id="_err_2d">
868
869	<h2><a class="top" href="#container">top</a>err_2d <span class="categories">
870
871	</span></h2>
872
873	<p class="header">
874	<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>
875
876	<div class="comments"></div>
877
878	<h3>Return value</h3><div class="preformat">
879
880	</div>
881
882
883	<h3>Parameters</h3>
884
885
886	<h4 id="_err_2d_param_type">type
887	<span class="attr">in</span>
888
889
890	<span class="attr">required</span>
891
892
893
894
895	</h4>
896
897	<div class="comments">
898	A string of two characters specifying the type of plot we do
899	</div>
900
901	<h4 id="_err_2d_param_sz">sz
902	<span class="attr">in</span>
903
904	<span class="attr">optional</span>
905
906
907
908	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
909
910	</h4>
911
912	<div class="comments">
913	</div>
914
915	<h4 id="_err_2d_param_nx">nx
916	<span class="attr">in</span>
917
918	<span class="attr">optional</span>
919
920
921
922	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
923
924	</h4>
925
926	<div class="comments">
927	</div>
928
929	<h4 id="_err_2d_param_ny">ny
930	<span class="attr">in</span>
931
932	<span class="attr">optional</span>
933
934
935
936	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
937
938	</h4>
939
940	<div class="comments">
941	</div>
942
943	<h4 id="_err_2d_param_nz">nz
944
945
946
947
948
949
950
951
952	</h4>
953
954	<div class="comments">
955
956	</div>
957
958
959
960
961
962
963	<h3>Examples</h3><div class="preformat">
964
965	</div>
966	<h3>Version history</h3>
967
968	<h4>Version</h4><div class="preformat">
969	$Id$</div>
970	<h4>History</h4><div class="preformat">
971
972	</div>
973
974
975	<h3>Known issues</h3>
976
977
978
979	<h4>Restrictions</h4><div class="preformat">
980
981	</div>
982
983
984
985
986
987
988
989
990
991
992
993	</div>
994
995
996	<div class="routine_details" id="_err_3d">
997
998	<h2><a class="top" href="#container">top</a>err_3d <span class="categories">
999
1000	</span></h2>
1001
1002	<p class="header">
1003	<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>
1004
1005	<div class="comments"></div>
1006
1007	<h3>Return value</h3><div class="preformat">
1008
1009	</div>
1010
1011
1012	<h3>Parameters</h3>
1013
1014
1015	<h4 id="_err_3d_param_type">type
1016	<span class="attr">in</span>
1017
1018
1019	<span class="attr">required</span>
1020
1021
1022
1023
1024	</h4>
1025
1026	<div class="comments">
1027	A string of two characters specifying the type of plot we do
1028	</div>
1029
1030	<h4 id="_err_3d_param_sz">sz
1031	<span class="attr">in</span>
1032
1033	<span class="attr">optional</span>
1034
1035
1036
1037	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
1038
1039	</h4>
1040
1041	<div class="comments">
1042	</div>
1043
1044	<h4 id="_err_3d_param_nx">nx
1045	<span class="attr">in</span>
1046
1047	<span class="attr">optional</span>
1048
1049
1050
1051	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
1052
1053	</h4>
1054
1055	<div class="comments">
1056	</div>
1057
1058	<h4 id="_err_3d_param_ny">ny
1059	<span class="attr">in</span>
1060
1061	<span class="attr">optional</span>
1062
1063
1064
1065	<span class="attr">default:</span> <span class="value">defined by grille.pro</span>
1066
1067	</h4>
1068
1069	<div class="comments">
1070	</div>
1071
1072	<h4 id="_err_3d_param_nz">nz
1073
1074
1075
1076
1077
1078
1079
1080
1081	</h4>
1082
1083	<div class="comments">
1084
1085	</div>
1086
1087
1088
1089
1090
1091
1092	<h3>Examples</h3><div class="preformat">
1093
1094	</div>
1095	<h3>Version history</h3>
1096
1097	<h4>Version</h4><div class="preformat">
1098	$Id$</div>
1099	<h4>History</h4><div class="preformat">
1100
1101	</div>
1102
1103
1104	<h3>Known issues</h3>
1105
1106
1107
1108	<h4>Restrictions</h4><div class="preformat">
1109
1110	</div>
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122	</div>
1123
1124
1125	<div class="routine_details" id="_checkfield">
1126
1127	<h2><a class="top" href="#container">top</a>checkfield <span class="categories">
1128	Graphics
1129	</span></h2>
1130
1131	<p class="header">
1132	<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">BOXZOOM</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">VECTEUR</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>
1133
1134	<div class="comments">
1135	</div>
1136
1137
1138
1139
1140	<h3>Parameters</h3>
1141
1142
1143	<h4 id="_checkfield_param_field">field
1144	<span class="attr">in</span>
1145
1146
1147	<span class="attr">required</span>
1148
1149
1150
1151
1152	</h4>
1153
1154	<div class="comments">
1155	A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp'
1156	</div>
1157
1158	<h4 id="_checkfield_param_procedure">procedure
1159	<span class="attr">in</span>
1160
1161
1162	<span class="attr">required</span>
1163
1164
1165
1166
1167	</h4>
1168
1169	<div class="comments">
1170
1171	</div>
1172
1173
1174
1175
1176
1177
1178	<h3>Keywords</h3>
1179
1180	<h4 id="_checkfield_keyword_TYPE">TYPE
1181
1182
1183
1184
1185
1186
1187
1188
1189	</h4>
1190
1191	<div class="comments">
1192
1193	</div>
1194
1195	<h4 id="_checkfield_keyword_BOXZOOM">BOXZOOM
1196
1197
1198
1199
1200
1201
1202
1203
1204	</h4>
1205
1206	<div class="comments">
1207	Vector indicating the geographic zone on which we want to cut the map.
1208	If BOXZOOM has :
1209	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
1210	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
1211	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
1212	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
1213	6 elements: The extraction is made on Boxzoom
1214
1215	Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
1216	</div>
1217
1218	<h4 id="_checkfield_keyword_DIREC">DIREC
1219
1220
1221
1222
1223
1224
1225
1226
1227	</h4>
1228
1229	<div class="comments">
1230
1231	</div>
1232
1233	<h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION
1234
1235
1236
1237
1238
1239
1240
1241
1242	</h4>
1243
1244	<div class="comments">
1245
1246	</div>
1247
1248	<h4 id="_checkfield_keyword_VECTEUR">VECTEUR
1249
1250
1251
1252
1253
1254
1255
1256
1257	</h4>
1258
1259	<div class="comments"> is also appropriated.
1260	</div>
1261
1262	<h4 id="_checkfield_keyword_WDEPTH">WDEPTH
1263
1264
1265
1266
1267
1268
1269
1270
1271	</h4>
1272
1273	<div class="comments">
1274	to specify that the field is at W depth instad of T
1275	depth (automatically activated if vargrid eq 'W')
1276	</div>
1277
1278	<h4 id="_checkfield_keyword__EXTRA">_EXTRA
1279
1280
1281
1282
1283
1284
1285
1286
1287	</h4>
1288
1289	<div class="comments">
1290	used to pass your keywords
1291	</div>
1292
1293
1294
1295
1296	<h3>Version history</h3>
1297
1298	<h4>Version</h4><div class="preformat">
1299	$Id: checkfield.pro 142 2006-07-21 12:47:49Z navarro $
1300	</div>
1301	<h4>History</h4><div class="preformat">
1302	Sebastien Masson (smasson@lodyc.jussieu.fr)
1303	08/02/2000
1304	</div>
1305
1306
1307	<h3>Known issues</h3>
1308
1309
1310	<h4>Todo items</h4><div class="preformat"> seb: mettre les param
1311	</div>
1312
1313
1314	<h3>Other attributes</h3>
1315
1316
1317	<h4>Uses routines</h4><div class="preformat">
1318	common.pro
1319	</div>
1320
1321
1322
1323
1324
1325
1326	</div>
1327
1328	</div>
1329
1330
1331
1332	<div id="tagline">Produced by IDLdoc 2.0.</div>
1333
1334	</div>
1335
1336	</body>
1337	</html>

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

Download in other formats: