Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/tvplus.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 8.2 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>tvplus.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="splot.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=""><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/PLOTS/DESSINE/</font></h1>
58	<h2>tvplus.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Enhanced version of <a href="/Applications/itt/idl64/help/online_help/TVSCL.html">TVSCL</a>
65
66
67
68
69
70	<a name="#_tvplus"></a>
71
72	<h2>tvplus <font size="-1" color="#006633">
73	quick exploration of 2D arrays
74	</font></h2>
75
76	<p><font face="Courier">tvplus<i>, <a href="#_tvplus_keyword_z2d">z2d</a>[, <a href="#_tvplus_keyword_cellsize">cellsize</a>]</i>, <a href="#_tvplus_keyword_BOTTOM">BOTTOM</a>=<i>BOTTOM</i>, <a href="#_tvplus_keyword_C_MASK">C_MASK</a>=<i>C_MASK</i>, <a href="#_tvplus_keyword_C_NAN">C_NAN</a>=<i>C_NAN</i>, <a href="#_tvplus_keyword_WINDOW">WINDOW</a>=<i>WINDOW</i>, <a href="#_tvplus_keyword_MIN">MIN</a>=<i>MIN</i>, <a href="#_tvplus_keyword_MAX">MAX</a>=<i>MAX</i>, <a href="#_tvplus_keyword_MASK">MASK</a>=<i>MASK</i>, <a href="#_tvplus_keyword_OFFSET">OFFSET</a>=<i>OFFSET</i>, <a href="#_tvplus_keyword_NOUSEINFOS">NOUSEINFOS</a>=<i>NOUSEINFOS</i>, <a href="#_tvplus_keyword_NCOLORS">NCOLORS</a>=<i>NCOLORS</i>, <a href="#_tvplus_keyword_NOINTERP">NOINTERP</a>=<i>NOINTERP</i>, <a href="#_tvplus_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="#_tvplus_keyword_z2d"></a>
88	<h4>z2d
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	2D array to visualize
101
102
103
104	<a name="#_tvplus_keyword_cellsize"></a>
105	<h4>cellsize
106	<font size="-1" color="#006633">in</font>
107
108	<font size="-1" color="#006633">optional</font>
109
110
111
112
113
114	</h4>
115
116
117	This is the size (in pixel) of the square
118	representing 1 array element. By default, this size is computed
119	automatically in order that the size of the plotting window do
120	not exceed the screen size. If the user specify a large value
121	of cellsize that forces tvplus to create a window larger than
122	the screen, a "scrolling window" will be displayed instead of a
123	regular window. Unfortunately the nice functionalities of tvplus
124	are not coded for "scrolling window" case...
125
126
127
128
129
130	<h3>Keywords</h3>
131
132
133	<a name="#_tvplus_keyword_BOTTOM"></a>
134	<h4>BOTTOM
135
136
137
138
139
140
141	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
142
143	</h4>
144
145
146	The lowest color index of the colors to be used
147
148
149	<a name="#_tvplus_keyword_C_MASK"></a>
150	<h4>C_MASK
151
152
153
154
155
156
157	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
158
159	</h4>
160
161
162	The color number that should be used for the mask values.
163
164
165	<a name="#_tvplus_keyword_C_NAN"></a>
166	<h4>C_NAN
167
168
169
170
171
172
173	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>!d.n_colors < 255</i></font>
174
175	</h4>
176
177
178	The color number that should be used for the NaN values.
179
180
181	<a name="#_tvplus_keyword_WINDOW"></a>
182	<h4>WINDOW
183
184
185
186
187
188
189
190
191	</h4>
192
193
194	Number of the window used to display the array values.
195	default is window number 0.
196
197
198	<a name="#_tvplus_keyword_MIN"></a>
199	<h4>MIN
200
201
202
203
204
205
206
207
208	</h4>
209
210
211	Scalar used to specify the min value to be drawn.
212
213
214	<a name="#_tvplus_keyword_MAX"></a>
215	<h4>MAX
216
217
218
219
220
221
222
223
224	</h4>
225
226
227	Scalar used to specify the max value to be drawn.
228
229
230	<a name="#_tvplus_keyword_MASK"></a>
231	<h4>MASK
232
233
234
235
236
237
238
239
240	</h4>
241
242
243	The mask value. Note that if abs(mask) < 1.e6, then the
244	exact value of the mask is used to find the maskwd point.
245	if abs(mask) > 1.e6, the test to find the masked value is ge
246	abs(mask)/10. This is necessary to avoid the rounding errors
247
248
249	<a name="#_tvplus_keyword_OFFSET"></a>
250	<h4>OFFSET
251
252
253
254
255
256
257
258
259	</h4>
260
261
262	2 elements vector used by tvplus itself when showing zoom.
263	It is used to shift the ranges of xaxis and yaxis.
264	For example: tvplus,sst[x1:x2,y1:y2],offset=[x1,y1]
265
266
267	<a name="#_tvplus_keyword_NOUSEINFOS"></a>
268	<h4>NOUSEINFOS
269
270
271
272
273
274
275
276
277	</h4>
278
279
280	Activate to suppress the printed message explaining how to use tvplus
281
282
283	<a name="#_tvplus_keyword_NCOLORS"></a>
284	<h4>NCOLORS
285
286
287
288
289
290
291	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>(d.n_colors < 256) - 1 - bottom</i></font>
292
293	</h4>
294
295
296	number of colors to be used.
297
298
299	<a name="#_tvplus_keyword_NOINTERP"></a>
300	<h4>NOINTERP
301
302
303
304
305
306
307
308
309	</h4>
310
311
312	Used this keyword if you don't want that the values
313	are interpolated from BOTTOM using NCOLORS colors.
314	This can be for example useful when working on byte type arrays.
315
316
317	<a name="#_tvplus_keyword__EXTRA"></a>
318	<h4>_EXTRA
319
320
321
322
323
324
325
326
327	</h4>
328
329
330	Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/TV.html">TV</a>,
331	<a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a>,
332	<a href="../../..//Colors/colorbar.html">colorbar</a>
333
334
335
336
337	<h3>Examples</h3><pre>
338	IDL> tvplus, dist(100)
339
340	</pre><h3>Version history</h3>
341
342	<h4>Version</h4>
343	$Id: tvplus.pro 327 2007-12-13 16:22:35Z pinsard $
344
345	<h4>History</h4>
346	Sebastien Masson (smasson@lodyc.jussieu.fr)
347	18/12/98
348	Aug 2005: quick cleaning + english
349
350
351
352	<h3>Known issues</h3>
353
354
355
356	<h4>Restrictions</h4>
357	use your mouse to scan the array values...
358	left button : mouse position and associated array value
359	middle button: use it twice to define a zoom box
360	right button : quit
361
362	the nice functionalities of tvplus are not coded
363	for "scrolling window" case...
364
365
366
367
368
369
370
371
372
373
374	<font size="-3"><p> </p></font>
375	<hr size="1" color="#CCCCCC"/>
376
377
378
379
380	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
381
382	</body>
383	</html>

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

Download in other formats: