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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 7.8 KB
RevLine 
[89]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>
[104]9    <title>determineminmax.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="determineminmax.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../../ToBeReviewed/PLOTS/DIVERS//determineminmax.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="checktypeminmax.html">&lt;&lt;prev file</a> | <a href="givewindowsize.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="determineminmax.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/DIVERS/</a></h1>
[89]82      <h2 class="pro_file">determineminmax.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]89      <div id="file_comments">
90 Determine the min and the max of a mask array
91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_determineminmax">
105
[234]106          <h2><a class="top" href="#container">top</a>determineminmax <span class="categories">
[157]107 Plotting
[142]108</span></h2>
[89]109       
110          <p class="header">
[290]111            determineminmax<span class="result">, <a href="#_determineminmax_param_tab">tab</a>, <a href="#_determineminmax_param_mask">mask</a>, <a href="#_determineminmax_param_vraimin">vraimin</a>, <a href="#_determineminmax_param_vraimax">vraimax</a>, <a href="#_determineminmax_param_glam">glam</a>, <a href="#_determineminmax_param_gphi">gphi</a></span>, <a href="#_determineminmax_keyword_MAXIN">MAXIN</a>=<span class="result">scalar</span>, <a href="#_determineminmax_keyword_MININ">MININ</a>=<span class="result">scalar</span>, <a href="#_determineminmax_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_determineminmax_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_determineminmax_keyword_ZEROMIDDLE">ZEROMIDDLE</a>=<span class="result">ZEROMIDDLE</span>, <a href="#_determineminmax_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
[89]112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_determineminmax_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]123              <span class="attr">in</span>
[89]124             
125             
[142]126              <span class="attr">required</span>
[89]127             
128             
129             
130             
131            </h4>
132       
[142]133          <div class="comments">
134 The array whose we determine the min and the max
135</div>
[89]136           
137            <h4 id="_determineminmax_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]138              <span class="attr">in</span>
[89]139             
140             
[142]141              <span class="attr">required</span>
[89]142             
143             
144             
145             
146            </h4>
147       
[142]148          <div class="comments">
[234]149 The mask array
[142]150</div>
[89]151           
152            <h4 id="_determineminmax_param_vraimin">vraimin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153             
[142]154              <span class="attr">out</span>
[89]155             
156             
157             
158             
159             
160             
161            </h4>
162       
[142]163          <div class="comments">
164 The min of the array
165</div>
[89]166           
167            <h4 id="_determineminmax_param_vraimax">vraimax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
[142]169              <span class="attr">out</span>
[89]170             
171             
172             
173             
174             
175             
176            </h4>
177       
[142]178          <div class="comments">
179 The max of the array
180</div>
[89]181           
182            <h4 id="_determineminmax_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189             
190             
191            </h4>
192       
193          <div class="comments"></div>
194           
195            <h4 id="_determineminmax_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206          <div class="comments"></div>
207           
208
209         
210
211         
212
213            <h3>Keywords</h3>
214           
215            <h4 id="_determineminmax_keyword_MAXIN">MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
[163]221              <span class="attr">type:</span> <span class="value">scalar</span>
[89]222             
223             
224            </h4>
225       
[163]226            <div class="comments">
227 If it is not defined, it takes the value of VRAIMAX
[142]228</div>
[89]229           
230            <h4 id="_determineminmax_keyword_MININ">MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231             
232             
233             
234             
235             
[163]236              <span class="attr">type:</span> <span class="value">scalar</span>
[89]237             
238             
239            </h4>
240       
[163]241            <div class="comments">
242 If it is not defined, it takes the value of VRAIMIN
[142]243</div>
[89]244           
245            <h4 id="_determineminmax_keyword_INTERVALLE">INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246             
247             
248             
249             
250             
251             
252             
253             
254            </h4>
255       
256            <div class="comments"></div>
257           
[290]258            <h4 id="_determineminmax_keyword_USETRI">USETRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]259             
260             
261             
262             
263             
264             
265             
266             
267            </h4>
268       
[142]269            <div class="comments">
270 To force using triangulation.
[234]271</div>
[89]272           
273            <h4 id="_determineminmax_keyword_ZEROMIDDLE">ZEROMIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274             
275             
276             
277             
278             
279             
280             
281             
282            </h4>
283       
[234]284            <div class="comments">
[142]285 Force the middle of the colorbar to be equal
286 to 0 (force max=max(abs([min,max])) and min=-max)
[234]287</div>
[89]288           
[234]289            <h4 id="_determineminmax_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]290             
291             
292             
293             
294             
295             
296             
297             
298            </h4>
299       
[142]300            <div class="comments">
[234]301 Used to pass keywords
[142]302</div>
[89]303           
304         
305
306         
[142]307          <h3>Version history</h3>
[89]308         
[142]309          <h4>Version</h4><div class="preformat">
[402]310 $Id: determineminmax.pro 378 2008-08-12 12:35:46Z pinsard $
[142]311</div>
[157]312          <h4>History</h4><div class="preformat">
313 Sebastien Masson (smasson@lodyc.jussieu.fr)
314                       11/12/98
315</div>
[89]316         
317         
[142]318          <h3>Known issues</h3>
[89]319         
320         
[402]321          <h4>Todo items</h4><div class="preformat">
322 seb: manque les param glam et gphi
[142]323</div>
324          <h4>Restrictions</h4><div class="preformat">
325 Look if the field is constant on the sea
326</div>
[89]327       
[142]328          <h3>Other attributes</h3>
[89]329         
330         
[142]331          <h4>Uses routines</h4><div class="preformat">
[402]332 <a href="../../..//Obsolete/common.html">common</a>
[142]333</div>
[89]334         
335         
336         
337       
[163]338          <h3>Statistics</h3>
339          <table class="statistics">
340            <tr><td>McCabe cyclic</td><td>          13</td></tr>
341            <tr><td>McCabe essential</td><td>           1</td></tr>
342            <tr><td>McCabe modular design</td><td>           1</td></tr>
343          </table>
[89]344         
345       
346        </div>
347       
348      </div>
349
350     
351
352      <div id="tagline">Produced by IDLdoc 2.0.</div>
353
354    </div>
355
356  </body>
[249]357</html>
Note: See TracBrowser for help on using the repository browser.