Context Navigation

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

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

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

Download in other formats: