Context Navigation

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

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

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

Download in other formats: