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>tvplus.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="tvplus.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/DESSINE//tvplus.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="splot.html"><<prev file</a> | next file >> <a href="tvplus.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a> summary: fields | routine 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/DESSINE/</a></h1> |
---|
82 | <h2 class="pro_file">tvplus.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> |
---|
90 | Enhanced version of <a href="/Applications/itt/idl64/help/online_help/TVSCL.html">TVSCL</a> |
---|
91 | </div> |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | <div id="routine_details"> |
---|
102 | |
---|
103 | |
---|
104 | <div class="routine_details" id="_tvplus"> |
---|
105 | |
---|
106 | <h2><a class="top" href="#container">top</a>tvplus <span class="categories"> |
---|
107 | quick exploration of 2D arrays |
---|
108 | </span></h2> |
---|
109 | |
---|
110 | <p class="header"> |
---|
111 | tvplus<span class="result">, <a href="#_tvplus_param_z2d">z2d</a>[, <a href="#_tvplus_param_cellsize">cellsize</a>]</span>, <a href="#_tvplus_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_tvplus_keyword_C_MASK">C_MASK</a>=<span class="result">C_MASK</span>, <a href="#_tvplus_keyword_C_NAN">C_NAN</a>=<span class="result">C_NAN</span>, <a href="#_tvplus_keyword_WINDOW">WINDOW</a>=<span class="result">WINDOW</span>, <a href="#_tvplus_keyword_MIN">MIN</a>=<span class="result">MIN</span>, <a href="#_tvplus_keyword_MAX">MAX</a>=<span class="result">MAX</span>, <a href="#_tvplus_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_tvplus_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_tvplus_keyword_NOUSEINFOS">NOUSEINFOS</a>=<span class="result">NOUSEINFOS</span>, <a href="#_tvplus_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_tvplus_keyword_NOINTERP">NOINTERP</a>=<span class="result">NOINTERP</span>, <a href="#_tvplus_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
112 | |
---|
113 | <div class="comments"> |
---|
114 | </div> |
---|
115 | |
---|
116 | |
---|
117 | |
---|
118 | |
---|
119 | <h3>Parameters</h3> |
---|
120 | |
---|
121 | |
---|
122 | <h4 id="_tvplus_param_z2d">z2d |
---|
123 | <span class="attr">in</span> |
---|
124 | |
---|
125 | |
---|
126 | <span class="attr">required</span> |
---|
127 | |
---|
128 | |
---|
129 | |
---|
130 | |
---|
131 | </h4> |
---|
132 | |
---|
133 | <div class="comments"> |
---|
134 | 2D array to visualize |
---|
135 | </div> |
---|
136 | |
---|
137 | <h4 id="_tvplus_param_cellsize">cellsize |
---|
138 | <span class="attr">in</span> |
---|
139 | |
---|
140 | <span class="attr">optional</span> |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | |
---|
145 | |
---|
146 | </h4> |
---|
147 | |
---|
148 | <div class="comments"> |
---|
149 | This is the size (in pixel) of the square |
---|
150 | representing 1 array element. By default, this size is computed |
---|
151 | automatically in order that the size of the plotting window do |
---|
152 | not exceed the screen size. If the user specify a large value |
---|
153 | of cellsize that forces tvplus to create a window larger than |
---|
154 | the screen, a "scrolling window" will be displayed instead of a |
---|
155 | regular window. Unfortunately the nice functionalities of tvplus |
---|
156 | are not coded for "scrolling window" case... |
---|
157 | </div> |
---|
158 | |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | <h3>Keywords</h3> |
---|
165 | |
---|
166 | <h4 id="_tvplus_keyword_BOTTOM">BOTTOM |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | |
---|
171 | |
---|
172 | |
---|
173 | <span class="attr">default:</span> <span class="value">1</span> |
---|
174 | |
---|
175 | </h4> |
---|
176 | |
---|
177 | <div class="comments"> |
---|
178 | The lowest color index of the colors to be used |
---|
179 | </div> |
---|
180 | |
---|
181 | <h4 id="_tvplus_keyword_C_MASK">C_MASK |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | |
---|
188 | <span class="attr">default:</span> <span class="value">0</span> |
---|
189 | |
---|
190 | </h4> |
---|
191 | |
---|
192 | <div class="comments"> |
---|
193 | The color number that should be used for the mask values. |
---|
194 | </div> |
---|
195 | |
---|
196 | <h4 id="_tvplus_keyword_C_NAN">C_NAN |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | <span class="attr">default:</span> <span class="value">!d.n_colors < 255</span> |
---|
204 | |
---|
205 | </h4> |
---|
206 | |
---|
207 | <div class="comments"> |
---|
208 | The color number that should be used for the NaN values. |
---|
209 | </div> |
---|
210 | |
---|
211 | <h4 id="_tvplus_keyword_WINDOW">WINDOW |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | </h4> |
---|
221 | |
---|
222 | <div class="comments"> |
---|
223 | Number of the window used to display the array values. |
---|
224 | default is window number 0. |
---|
225 | </div> |
---|
226 | |
---|
227 | <h4 id="_tvplus_keyword_MIN">MIN |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | |
---|
236 | </h4> |
---|
237 | |
---|
238 | <div class="comments"> |
---|
239 | Scalar used to specify the min value to be drawn. |
---|
240 | </div> |
---|
241 | |
---|
242 | <h4 id="_tvplus_keyword_MAX">MAX |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | </h4> |
---|
252 | |
---|
253 | <div class="comments"> |
---|
254 | Scalar used to specify the max value to be drawn. |
---|
255 | </div> |
---|
256 | |
---|
257 | <h4 id="_tvplus_keyword_MASK">MASK |
---|
258 | |
---|
259 | |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | |
---|
265 | |
---|
266 | </h4> |
---|
267 | |
---|
268 | <div class="comments"> |
---|
269 | The mask value. Note that if abs(mask) < 1.e6, then the |
---|
270 | exact value of the mask is used to find the maskwd point. |
---|
271 | if abs(mask) > 1.e6, the test to find the masked value is ge |
---|
272 | abs(mask)/10. This is necessary to avoid the rounding errors |
---|
273 | </div> |
---|
274 | |
---|
275 | <h4 id="_tvplus_keyword_OFFSET">OFFSET |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | </h4> |
---|
285 | |
---|
286 | <div class="comments"> |
---|
287 | 2 elements vector used by tvplus itself when showing zoom. |
---|
288 | It is used to shift the ranges of xaxis and yaxis. |
---|
289 | For example: tvplus,sst[x1:x2,y1:y2],offset=[x1,y1] |
---|
290 | </div> |
---|
291 | |
---|
292 | <h4 id="_tvplus_keyword_NOUSEINFOS">NOUSEINFOS |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | </h4> |
---|
302 | |
---|
303 | <div class="comments"> |
---|
304 | Activate to suppress the printed message explaining how to use tvplus |
---|
305 | </div> |
---|
306 | |
---|
307 | <h4 id="_tvplus_keyword_NCOLORS">NCOLORS |
---|
308 | |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | <span class="attr">default:</span> <span class="value">(d.n_colors < 256) - 1 - bottom</span> |
---|
315 | |
---|
316 | </h4> |
---|
317 | |
---|
318 | <div class="comments"> |
---|
319 | number of colors to be used. |
---|
320 | </div> |
---|
321 | |
---|
322 | <h4 id="_tvplus_keyword_NOINTERP">NOINTERP |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | |
---|
328 | |
---|
329 | |
---|
330 | |
---|
331 | </h4> |
---|
332 | |
---|
333 | <div class="comments"> |
---|
334 | Used this keyword if you don't want that the values |
---|
335 | are interpolated from BOTTOM using NCOLORS colors. |
---|
336 | This can be for example useful when working on byte type arrays. |
---|
337 | </div> |
---|
338 | |
---|
339 | <h4 id="_tvplus_keyword__EXTRA">_EXTRA |
---|
340 | |
---|
341 | |
---|
342 | |
---|
343 | |
---|
344 | |
---|
345 | |
---|
346 | |
---|
347 | |
---|
348 | </h4> |
---|
349 | |
---|
350 | <div class="comments"> |
---|
351 | Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/TV.html">TV</a>, |
---|
352 | <a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a>, |
---|
353 | <a href="../../..//Colors/colorbar.html">colorbar</a> |
---|
354 | </div> |
---|
355 | |
---|
356 | |
---|
357 | |
---|
358 | <h3>Examples</h3><div class="preformat"> |
---|
359 | |
---|
360 | IDL> tvplus, dist(100) |
---|
361 | </div> |
---|
362 | <h3>Version history</h3> |
---|
363 | |
---|
364 | <h4>Version</h4><div class="preformat"> |
---|
365 | $Id: tvplus.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
366 | </div> |
---|
367 | <h4>History</h4><div class="preformat"> |
---|
368 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
369 | 18/12/98 |
---|
370 | Aug 2005: quick cleaning + english |
---|
371 | </div> |
---|
372 | |
---|
373 | |
---|
374 | <h3>Known issues</h3> |
---|
375 | |
---|
376 | |
---|
377 | |
---|
378 | <h4>Restrictions</h4><div class="preformat"> |
---|
379 | use your mouse to scan the array values... |
---|
380 | left button : mouse position and associated array value |
---|
381 | middle button: use it twice to define a zoom box |
---|
382 | right button : quit |
---|
383 | |
---|
384 | the nice functionalities of tvplus are not coded |
---|
385 | for "scrolling window" case... |
---|
386 | </div> |
---|
387 | |
---|
388 | |
---|
389 | |
---|
390 | |
---|
391 | |
---|
392 | |
---|
393 | |
---|
394 | |
---|
395 | |
---|
396 | <h3>Statistics</h3> |
---|
397 | <table class="statistics"> |
---|
398 | <tr><td>McCabe cyclic</td><td> 47</td></tr> |
---|
399 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
400 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
401 | </table> |
---|
402 | |
---|
403 | |
---|
404 | </div> |
---|
405 | |
---|
406 | </div> |
---|
407 | |
---|
408 | |
---|
409 | |
---|
410 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
411 | |
---|
412 | </div> |
---|
413 | |
---|
414 | </body> |
---|
415 | </html> |
---|