Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/Colors/colorbar.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: 11.4 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>colorbar.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="color24.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="getcolor.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">Colors/</font></h1>
58	<h2>colorbar.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	The purpose of this routine is to add a color bar to the current
65	graphics window.
66
67
68
69
70
71	<a name="#_colorbar"></a>
72
73	<h2>colorbar <font size="-1" color="#006633"> Graphics, Widget
74	</font></h2>
75
76	<p><font face="Courier">colorbar, <a href="#_colorbar_keyword_BOTTOM">BOTTOM</a>=<i>BOTTOM</i>, <a href="#_colorbar_keyword_CB_CHARSIZE">CB_CHARSIZE</a>=<i>CB_CHARSIZE</i>, <a href="#_colorbar_keyword_CB_CHARTHICK">CB_CHARTHICK</a>=<i>CB_CHARTHICK</i>, <a href="#_colorbar_keyword_CB_COLOR">CB_COLOR</a>=<i>CB_COLOR</i>, <a href="#_colorbar_keyword_DIVISIONS">DIVISIONS</a>=<i>DIVISIONS</i>, <a href="#_colorbar_keyword_DISCRETE">DISCRETE</a>=<i>DISCRETE</i>, <a href="#_colorbar_keyword_CB_LABEL">CB_LABEL</a>=<i>vector</i>, <a href="#_colorbar_keyword_FORMAT">FORMAT</a>=<i>FORMAT</i>, <a href="#_colorbar_keyword_POSITION">POSITION</a>=<i>POSITION</i>, <a href="#_colorbar_keyword_MAX">MAX</a>=<i>MAX</i>, <a href="#_colorbar_keyword_MIN">MIN</a>=<i>MIN</i>, <a href="#_colorbar_keyword_NCOLORS">NCOLORS</a>=<i>NCOLORS</i>, <a href="#_colorbar_keyword_PSCOLOR">PSCOLOR</a>=<i>PSCOLOR</i>, <a href="#_colorbar_keyword_CB_TITLE">CB_TITLE</a>=<i>CB_TITLE</i>, <a href="#_colorbar_keyword_VERTICAL">VERTICAL</a>=<i>VERTICAL</i>, <a href="#_colorbar_keyword_TOP">TOP</a>=<i>TOP</i>, <a href="#_colorbar_keyword_RIGHT">RIGHT</a>=<i>RIGHT</i>, <a href="#_colorbar_keyword_CB_LOG">CB_LOG</a>=<i>CB_LOG</i>, <a href="#_colorbar_keyword_NOTITLE">NOTITLE</a>=<i>NOTITLE</i>, <a href="#_colorbar_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78
79
80
81
82
83
84
85
86	<h3>Keywords</h3>
87
88
89	<a name="#_colorbar_keyword_BOTTOM"></a>
90	<h4>BOTTOM
91
92
93
94
95
96
97	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0B</i></font>
98
99	</h4>
100
101
102	The lowest color index of the colors to be loaded in the bar.
103
104
105	<a name="#_colorbar_keyword_CB_CHARSIZE"></a>
106	<h4>CB_CHARSIZE
107
108
109
110
111
112
113	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.0</i></font>
114
115	</h4>
116
117
118	The character size of the color bar annotations.
119
120
121	<a name="#_colorbar_keyword_CB_CHARTHICK"></a>
122	<h4>CB_CHARTHICK
123
124
125
126
127
128
129	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.0</i></font>
130
131	</h4>
132
133
134	The character thick of the color bar annotations.
135
136
137	<a name="#_colorbar_keyword_CB_COLOR"></a>
138	<h4>CB_COLOR
139
140
141
142
143
144
145	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>ncolors - 1 + bottom</i></font>
146
147	</h4>
148
149
150	The color index of the bar outline and characters.
151
152
153	<a name="#_colorbar_keyword_DIVISIONS"></a>
154	<h4>DIVISIONS
155
156
157
158
159
160
161	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>2</i></font>
162
163	</h4>
164
165
166	The number of divisions to divide the bar into.
167	There will be (divisions + 1) annotations.
168
169
170	<a name="#_colorbar_keyword_DISCRETE"></a>
171	<h4>DISCRETE
172
173
174
175
176
177
178
179
180	</h4>
181
182
183	Vector which contain color's indexes to trace in a color bar. Therefore
184	we obtain a discrete colorbar which contains only the specified colors
185	in the order they appear in the vector
186
187
188	<a name="#_colorbar_keyword_CB_LABEL"></a>
189	<h4>CB_LABEL
190
191
192
193
194
195	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
196
197
198	</h4>
199
200
201	A vector to specify sticks values of the color bar. It allows,
202	when we use DISCRETE, to have colors that don't increase by
203	increments in a regular way.
204
205
206	<a name="#_colorbar_keyword_FORMAT"></a>
207	<h4>FORMAT
208
209
210
211
212
213
214	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'(F6.2)'</i></font>
215
216	</h4>
217
218
219	The format of the bar annotations.
220
221
222	<a name="#_colorbar_keyword_POSITION"></a>
223	<h4>POSITION
224
225
226
227
228
229
230	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>see bellow</i></font>
231
232	</h4>
233
234
235	A four-element array of normalized coordinates in the same
236	form as the POSITION keyword on a plot. Default is
237	[0.88, 0.15, 0.95, 0.95] for a vertical bar and
238	[0.15, 0.88, 0.95, 0.95] for a horizontal bar.
239
240
241	<a name="#_colorbar_keyword_MAX"></a>
242	<h4>MAX
243
244
245
246
247
248
249	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>NCOLORS - 1</i></font>
250
251	</h4>
252
253
254	The maximum data value for the bar annotation.
255
256
257	<a name="#_colorbar_keyword_MIN"></a>
258	<h4>MIN
259
260
261
262
263
264
265	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
266
267	</h4>
268
269
270	The minimum data value for the bar annotation.
271
272
273	<a name="#_colorbar_keyword_NCOLORS"></a>
274	<h4>NCOLORS
275
276
277
278
279
280
281	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>!D.N_COLORS</i></font>
282
283	</h4>
284
285
286	This is the number of colors in the color bar.
287
288
289	<a name="#_colorbar_keyword_PSCOLOR"></a>
290	<h4>PSCOLOR
291
292
293
294
295
296
297
298
299	</h4>
300
301
302	This keyword is only applied if the output is being sent to
303	a Postscript file. It indicates that the Postscript device
304	is configured for color output. If this keyword is set, then
305	the annotation is drawn in the color specified by the COLOR
306	keyword. If the keyword is not set, the annotation is drawn
307	in the color specified by the !P.COLOR system variable
308	(usually this will be the color black). In general, this
309	gives better looking output on non-color or gray-scale
310	printers. If you are not specifically setting the annotation
311	color (with the COLOR keyword), it will probably
312	be better NOT to set this keyword either, even if you
313	are outputting to a color Postscript printer.
314
315
316	<a name="#_colorbar_keyword_CB_TITLE"></a>
317	<h4>CB_TITLE
318
319
320
321
322
323
324	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>''</i></font>
325
326	</h4>
327
328
329	This is title for the color bar.
330
331
332	<a name="#_colorbar_keyword_VERTICAL"></a>
333	<h4>VERTICAL
334
335
336
337
338
339
340	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0 -> horizontal color bar</i></font>
341
342	</h4>
343
344
345	Setting this keyword give a vertical color bar.
346
347
348	<a name="#_colorbar_keyword_TOP"></a>
349	<h4>TOP
350
351
352
353
354
355
356
357
358	</h4>
359
360
361	This puts the labels on top of the bar rather than under it.
362	The keyword only applies if a horizontal color bar is rendered.
363
364
365	<a name="#_colorbar_keyword_RIGHT"></a>
366	<h4>RIGHT
367
368
369
370
371
372
373
374
375	</h4>
376
377
378	This puts the labels on the right-hand side of a vertical
379	color bar. It applies only to vertical color bars.
380
381
382	<a name="#_colorbar_keyword_CB_LOG"></a>
383	<h4>CB_LOG
384
385
386
387
388
389
390
391
392	</h4>
393
394
395	to get logarithmic scale for the colorbar
396
397
398	<a name="#_colorbar_keyword_NOTITLE"></a>
399	<h4>NOTITLE
400
401
402
403
404
405
406
407
408	</h4>
409
410
411	Force to don't write title even if CB_TITLE is declared.
412
413
414	<a name="#_colorbar_keyword__EXTRA"></a>
415	<h4>_EXTRA
416
417
418
419
420
421
422
423
424	</h4>
425
426
427	pass any keyword to colorbar
428
429
430
431
432	<h3>Examples</h3>
433	To display a horizontal color bar above a contour plot, type:
434
435	IDL> LOADCT, 5, NCOLORS=100
436	IDL> CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
437	IDL> C_COLORS=INDGEN(25)*4, NLEVELS=25
438	IDL> COLORBAR, NCOLORS=100
439
440	<h3>Version history</h3>
441
442	<h4>Version</h4> $Id: colorbar.pro 157 2006-08-21 09:01:50Z navarro $
443
444	<h4>History</h4>
445	Written by: David Fanning, 10 JUNE 96.
446	10/27/96: Added the ability to send output to PostScript. DWF
447	11/04/96: Substantially rewritten to go to screen or PostScript
448	file without having to know much about the PostScript device
449	or even what the current graphics device is. DWF
450	01/27/97: Added the RIGHT and TOP keywords. Also modified the
451	way the TITLE keyword works. DWF
452	07/15/97: Fixed a problem some machines have with plots that have
453	no valid data range in them. DWF
454	03/03/98: Add DISCRETE keyword, sebastien masson (smasson@lodyc.jussieu.fr)
455
456
457
458	<h3>Known issues</h3>
459
460
461
462	<h4>Restrictions</h4>
463	The number of colors available on the display device (not the
464	Postscript device) is used unless the NCOLORS keyword is used.
465
466
467
468
469
470
471
472
473
474
475	<font size="-3"><p> </p></font>
476	<hr size="1" color="#CCCCCC"/>
477
478
479
480
481	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Tue Aug 29 14:49:06 2006.</font></p>
482
483	</body>
484	</html>

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

Download in other formats: