source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DIVERS/determineminmax.html @ 187

Last change on this file since 187 was 187, checked in by pinsard, 18 years ago

introducing hyperlinks in idldoc outputs (2/2)

File size: 6.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>determineminmax.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="checktypeminmax.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="givewindowsize.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/DIVERS/</font></h1>
58    <h2>determineminmax.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Determine the min and the max of a mask array
65
66
67   
68
69     
70      <a name="#_determineminmax"></a>
71
72      <h2>determineminmax  <font size="-1" color="#006633"> 
73 Plotting
74</font></h2>
75
76      <p><font face="Courier">determineminmax<i>, <a href="#_determineminmax_keyword_tab">tab</a>, <a href="#_determineminmax_keyword_mask">mask</a>, <a href="#_determineminmax_keyword_vraimin">vraimin</a>, <a href="#_determineminmax_keyword_vraimax">vraimax</a>, <a href="#_determineminmax_keyword_glam">glam</a>, <a href="#_determineminmax_keyword_gphi">gphi</a></i>, <a href="#_determineminmax_keyword_MAXIN">MAXIN</a>=<i>scalar</i>, <a href="#_determineminmax_keyword_MININ">MININ</a>=<i>scalar</i>, <a href="#_determineminmax_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_determineminmax_keyword_usetri">usetri</a>=<i>usetri</i>, <a href="#_determineminmax_keyword_ZEROMIDDLE">ZEROMIDDLE</a>=<i>ZEROMIDDLE</i>, <a href="#_determineminmax_keyword__extra">_extra</a>=<i>_extra</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_determineminmax_keyword_tab"></a>
88    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99   
100 The array whose we determine the min and the max
101
102   
103
104    <a name="#_determineminmax_keyword_mask"></a>
105    <h4>mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111     
112     
113     
114    </h4>
115
116   
117 The mask array
118
119   
120
121    <a name="#_determineminmax_keyword_vraimin"></a>
122    <h4>vraimin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123     
124      <font size="-1" color="#006633">out</font>
125     
126     
127     
128     
129     
130     
131    </h4>
132
133   
134 The min of the array
135
136   
137
138    <a name="#_determineminmax_keyword_vraimax"></a>
139    <h4>vraimax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140     
141      <font size="-1" color="#006633">out</font>
142     
143     
144     
145     
146     
147     
148    </h4>
149
150   
151 The max of the array
152
153   
154
155    <a name="#_determineminmax_keyword_glam"></a>
156    <h4>glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157     
158     
159     
160     
161     
162     
163     
164     
165    </h4>
166
167   
168   
169
170    <a name="#_determineminmax_keyword_gphi"></a>
171    <h4>gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172     
173     
174     
175     
176     
177     
178     
179     
180    </h4>
181
182   
183   
184   
185
186   
187    <h3>Keywords</h3>
188
189   
190    <a name="#_determineminmax_keyword_MAXIN"></a>
191    <h4>MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192     
193     
194     
195     
196     
197      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
198     
199     
200    </h4>
201
202   
203 If it is not defined, it takes the value of VRAIMAX
204
205   
206    <a name="#_determineminmax_keyword_MININ"></a>
207    <h4>MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208     
209     
210     
211     
212     
213      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
214     
215     
216    </h4>
217
218   
219 If it is not defined, it takes the value of VRAIMIN
220
221   
222    <a name="#_determineminmax_keyword_INTERVALLE"></a>
223    <h4>INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224     
225     
226     
227     
228     
229     
230     
231     
232    </h4>
233
234   
235   
236    <a name="#_determineminmax_keyword_usetri"></a>
237    <h4>usetri&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238     
239     
240     
241     
242     
243     
244     
245     
246    </h4>
247
248   
249 To force using triangulation.
250 
251   
252    <a name="#_determineminmax_keyword_ZEROMIDDLE"></a>
253    <h4>ZEROMIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254     
255     
256     
257     
258     
259     
260     
261     
262    </h4>
263
264     
265 Force the middle of the colorbar to be equal
266 to 0 (force max=max(abs([min,max])) and min=-max)
267 
268   
269    <a name="#_determineminmax_keyword__extra"></a>
270    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271     
272     
273     
274     
275     
276     
277     
278     
279    </h4>
280
281   
282 used to pass your keywords
283
284   
285   
286
287   
288    <h3>Version history</h3>
289   
290    <h4>Version</h4>
291 $Id: determineminmax.pro 163 2006-08-29 12:59:46Z navarro $
292
293    <h4>History</h4>
294 Sebastien Masson (smasson@lodyc.jussieu.fr)
295                       11/12/98
296
297   
298
299    <h3>Known issues</h3>
300   
301   
302    <h4>Todo items</h4> seb: manque les param glam et gphi
303
304    <h4>Restrictions</h4>
305 Look if the field is constant on the sea
306
307
308    <h3>Other attributes</h3>
309   
310   
311    <h4>Uses routines</h4>
312 Common.pro
313
314   
315   
316   
317
318    <font size="-3"><p>&nbsp;</p></font>
319    <hr size="1" color="#CCCCCC"/>
320     
321
322   
323
324    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
325
326  </body>
327</html>
Note: See TracBrowser for help on using the repository browser.