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

Last change on this file since 402 was 402, checked in by smasson, 15 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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="barrecouleur.html">&lt;&lt;prev file</a> | <a href="checktypeminmax.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="checkfield.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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.
194
195 If NAME
196 does not contain the separating character of directories ('/' under
197 unix for example), the file will be looked for in the current directory.
198</div>
199           
200            <h4 id="_err_1d_param_n2">n2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201              <span class="attr">in</span>
202             
203             
204              <span class="attr">required</span>
205             
206              <span class="attr">type:</span> <span class="value">integer</span>
207             
208             
209            </h4>
210       
211          <div class="comments">
212 Number of elements in the second dimension
213</div>
214           
215
216         
217
218         
219
220          <h3>Examples</h3><div class="preformat">
221</div>
222          <h3>Version history</h3>
223         
224          <h4>Version</h4><div class="preformat">
225 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
226</div>
227          <h4>History</h4><div class="preformat">
228</div>
229         
230         
231          <h3>Known issues</h3>
232         
233         
234         
235          <h4>Restrictions</h4><div class="preformat">
236</div>
237       
238         
239         
240         
241         
242         
243         
244         
245       
246          <h3>Statistics</h3>
247          <table class="statistics">
248            <tr><td>McCabe cyclic</td><td>           1</td></tr>
249            <tr><td>McCabe essential</td><td>           1</td></tr>
250            <tr><td>McCabe modular design</td><td>           1</td></tr>
251          </table>
252         
253       
254        </div>
255       
256
257        <div class="routine_details" id="_err_2d">
258
259          <h2><a class="top" href="#container">top</a>err_2d <span class="categories">
260</span></h2>
261       
262          <p class="header">
263            <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>
264       
265          <div class="comments">
266</div>
267
268          <h3>Return value</h3><div class="preformat">
269</div>
270
271         
272            <h3>Parameters</h3>
273       
274           
275            <h4 id="_err_2d_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
276              <span class="attr">in</span>
277             
278             
279              <span class="attr">required</span>
280             
281              <span class="attr">type:</span> <span class="value">string</span>
282             
283             
284            </h4>
285       
286          <div class="comments">
287 A string of two characters specifying the type of plot we do
288</div>
289           
290            <h4 id="_err_2d_param_sz">sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291              <span class="attr">in</span>
292             
293              <span class="attr">optional</span>
294             
295             
296             
297              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
298             
299            </h4>
300       
301          <div class="comments">
302</div>
303           
304            <h4 id="_err_2d_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
305              <span class="attr">in</span>
306             
307              <span class="attr">optional</span>
308             
309             
310             
311              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
312             
313            </h4>
314       
315          <div class="comments">
316</div>
317           
318            <h4 id="_err_2d_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
319              <span class="attr">in</span>
320             
321              <span class="attr">optional</span>
322             
323             
324             
325              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
326             
327            </h4>
328       
329          <div class="comments">
330</div>
331           
332            <h4 id="_err_2d_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333             
334             
335             
336             
337             
338             
339             
340             
341            </h4>
342       
343          <div class="comments">
344</div>
345           
346
347         
348
349         
350
351          <h3>Examples</h3><div class="preformat">
352</div>
353          <h3>Version history</h3>
354         
355          <h4>Version</h4><div class="preformat">
356 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
357</div>
358          <h4>History</h4><div class="preformat">
359</div>
360         
361         
362          <h3>Known issues</h3>
363         
364         
365         
366          <h4>Restrictions</h4><div class="preformat">
367</div>
368       
369         
370         
371         
372         
373         
374         
375         
376       
377          <h3>Statistics</h3>
378          <table class="statistics">
379            <tr><td>McCabe cyclic</td><td>           1</td></tr>
380            <tr><td>McCabe essential</td><td>           1</td></tr>
381            <tr><td>McCabe modular design</td><td>           1</td></tr>
382          </table>
383         
384       
385        </div>
386       
387
388        <div class="routine_details" id="_err_3d">
389
390          <h2><a class="top" href="#container">top</a>err_3d <span class="categories">
391</span></h2>
392       
393          <p class="header">
394            <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>
395       
396          <div class="comments">
397</div>
398
399          <h3>Return value</h3><div class="preformat">
400</div>
401
402         
403            <h3>Parameters</h3>
404       
405           
406            <h4 id="_err_3d_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
407              <span class="attr">in</span>
408             
409             
410              <span class="attr">required</span>
411             
412              <span class="attr">type:</span> <span class="value">string</span>
413             
414             
415            </h4>
416       
417          <div class="comments">
418 A string of two characters specifying the type of plot we do
419</div>
420           
421            <h4 id="_err_3d_param_sz">sz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
422              <span class="attr">in</span>
423             
424              <span class="attr">optional</span>
425             
426             
427             
428              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
429             
430            </h4>
431       
432          <div class="comments">
433</div>
434           
435            <h4 id="_err_3d_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436              <span class="attr">in</span>
437             
438              <span class="attr">optional</span>
439             
440             
441             
442              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
443             
444            </h4>
445       
446          <div class="comments">
447</div>
448           
449            <h4 id="_err_3d_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
450              <span class="attr">in</span>
451             
452              <span class="attr">optional</span>
453             
454             
455             
456              <span class="attr">default:</span> <span class="value">defined by <a href="../../..//ToBeReviewed/GRILLE/grille.html">grille</a></span>
457             
458            </h4>
459       
460          <div class="comments">
461</div>
462           
463            <h4 id="_err_3d_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
464             
465             
466             
467             
468             
469             
470             
471             
472            </h4>
473       
474          <div class="comments">
475</div>
476           
477
478         
479
480         
481
482          <h3>Examples</h3><div class="preformat">
483</div>
484          <h3>Version history</h3>
485         
486          <h4>Version</h4><div class="preformat">
487 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
488</div>
489          <h4>History</h4><div class="preformat">
490</div>
491         
492         
493          <h3>Known issues</h3>
494         
495         
496         
497          <h4>Restrictions</h4><div class="preformat">
498</div>
499       
500         
501         
502         
503         
504         
505         
506         
507       
508          <h3>Statistics</h3>
509          <table class="statistics">
510            <tr><td>McCabe cyclic</td><td>           1</td></tr>
511            <tr><td>McCabe essential</td><td>           1</td></tr>
512            <tr><td>McCabe modular design</td><td>           1</td></tr>
513          </table>
514         
515       
516        </div>
517       
518
519        <div class="routine_details" id="_checkfield">
520
521          <h2><a class="top" href="#container">top</a>checkfield <span class="categories">
522 Graphics
523</span></h2>
524       
525          <p class="header">
526            <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>
527       
528          <div class="comments">
529</div>
530
531         
532
533         
534            <h3>Parameters</h3>
535       
536           
537            <h4 id="_checkfield_param_field">field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
538              <span class="attr">in</span>
539             
540             
541              <span class="attr">required</span>
542             
543              <span class="attr">type:</span> <span class="value">field</span>
544             
545             
546            </h4>
547       
548          <div class="comments">
549 It respect <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>'s criterions.
550</div>
551           
552            <h4 id="_checkfield_param_procedure">procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
553              <span class="attr">in</span>
554             
555             
556              <span class="attr">required</span>
557             
558             
559             
560             
561            </h4>
562       
563          <div class="comments">
564</div>
565           
566
567         
568
569         
570
571            <h3>Keywords</h3>
572           
573            <h4 id="_checkfield_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
574             
575             
576             
577             
578             
579             
580             
581             
582            </h4>
583       
584            <div class="comments">
585</div>
586           
587            <h4 id="_checkfield_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
588             
589             
590             
591             
592             
593              <span class="attr">type:</span> <span class="value">vector</span>
594             
595             
596            </h4>
597       
598            <div class="comments">
599 Vector indicating the geographic zone on which we want to cut the map.
600
601  If BOXZOOM has :
602 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
603 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
604 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
605 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
606 6 elements: The extraction is made on Boxzoom
607
608 Where lon1, lon2,lat1,lat2 are global variables defined at the last
609 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
610</div>
611           
612            <h4 id="_checkfield_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
613             
614             
615             
616             
617             
618             
619             
620             
621            </h4>
622       
623            <div class="comments">
624</div>
625           
626            <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
627             
628             
629             
630             
631             
632             
633             
634             
635            </h4>
636       
637            <div class="comments">
638</div>
639           
640            <h4 id="_checkfield_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
641             
642             
643             
644             
645             
646              <span class="attr">type:</span> <span class="value">vector</span>
647             
648             
649            </h4>
650       
651            <div class="comments"> is also appropriated.
652</div>
653           
654            <h4 id="_checkfield_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
655             
656             
657             
658             
659             
660             
661             
662             
663            </h4>
664       
665            <div class="comments">
666 to specify that the field is at W depth instead of T
667 depth (automatically activated if vargrid eq 'W')
668</div>
669           
670            <h4 id="_checkfield_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
671             
672             
673             
674             
675             
676             
677             
678             
679            </h4>
680       
681            <div class="comments">
682 Used to pass keywords
683</div>
684           
685         
686
687         
688          <h3>Version history</h3>
689         
690          <h4>Version</h4><div class="preformat">
691 $Id: checkfield.pro 378 2008-08-12 12:35:46Z pinsard $
692</div>
693          <h4>History</h4><div class="preformat">
694 Sebastien Masson (smasson@lodyc.jussieu.fr)
695                      08/02/2000
696</div>
697         
698         
699          <h3>Known issues</h3>
700         
701         
702          <h4>Todo items</h4><div class="preformat"> seb: mettre les param
703</div>
704         
705       
706          <h3>Other attributes</h3>
707         
708         
709          <h4>Uses routines</h4><div class="preformat">
710 <a href="../../..//Obsolete/common.html">common</a>
711</div>
712         
713         
714         
715       
716          <h3>Statistics</h3>
717          <table class="statistics">
718            <tr><td>McCabe cyclic</td><td>         121</td></tr>
719            <tr><td>McCabe essential</td><td>           1</td></tr>
720            <tr><td>McCabe modular design</td><td>           1</td></tr>
721          </table>
722         
723       
724        </div>
725       
726      </div>
727
728     
729
730      <div id="tagline">Produced by IDLdoc 2.0.</div>
731
732    </div>
733
734  </body>
735</html>
Note: See TracBrowser for help on using the repository browser.