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>colorbar.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="colorbar.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?format=raw" title="Overview of library">Overview</a></td> |
---|
36 | |
---|
37 | |
---|
38 | |
---|
39 | <td >Directory</td> |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
52 | |
---|
53 | |
---|
54 | <td id="selected">File</td> |
---|
55 | |
---|
56 | |
---|
57 | <td >Source</td> |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | <td><a href="./../../idldoc-help.html?format=raw" 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="color24.html"><<prev file</a> | <a href="getcolor.html">next file >></a> <a href="colorbar.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/COULEURS/</a></h1> |
---|
82 | <h2 class="pro_file">colorbar.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"></div> |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | <div id="routine_details"> |
---|
100 | |
---|
101 | |
---|
102 | <div class="routine_details" id="_COLORBAR"> |
---|
103 | |
---|
104 | <h2><a class="top" href="#container">top</a>COLORBAR </h2> |
---|
105 | |
---|
106 | <p class="header"> |
---|
107 | COLORBAR, <a href="#_COLORBAR_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_COLORBAR_keyword_CB_CHARSIZE">CB_CHARSIZE</a>=<span class="result">CB_CHARSIZE</span>, <a href="#_COLORBAR_keyword_CB_CHARTHICK">CB_CHARTHICK</a>=<span class="result">CB_CHARTHICK</span>, <a href="#_COLORBAR_keyword_CB_COLOR">CB_COLOR</a>=<span class="result">CB_COLOR</span>, <a href="#_COLORBAR_keyword_DIVISIONS">DIVISIONS</a>=<span class="result">DIVISIONS</span>, <a href="#_COLORBAR_keyword_DISCRET">DISCRET</a>=<span class="result">DISCRET</span>, <a href="#_COLORBAR_keyword_CB_LABEL">CB_LABEL</a>=<span class="result">CB_LABEL</span>, <a href="#_COLORBAR_keyword_FORMAT">FORMAT</a>=<span class="result">FORMAT</span>, <a href="#_COLORBAR_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span>, <a href="#_COLORBAR_keyword_MAX">MAX</a>=<span class="result">MAX</span>, <a href="#_COLORBAR_keyword_MIN">MIN</a>=<span class="result">MIN</span>, <a href="#_COLORBAR_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_COLORBAR_keyword_PSCOLOR">PSCOLOR</a>=<span class="result">PSCOLOR</span>, <a href="#_COLORBAR_keyword_CB_TITLE">CB_TITLE</a>=<span class="result">CB_TITLE</span>, <a href="#_COLORBAR_keyword_VERTICAL">VERTICAL</a>=<span class="result">VERTICAL</span>, <a href="#_COLORBAR_keyword_TOP">TOP</a>=<span class="result">TOP</span>, <a href="#_COLORBAR_keyword_RIGHT">RIGHT</a>=<span class="result">RIGHT</span>, <a href="#_COLORBAR_keyword_CB_LOG">CB_LOG</a>=<span class="result">CB_LOG</span>, <a href="#_COLORBAR_keyword__extra">_extra</a>=<span class="result">_extra</span></p> |
---|
108 | |
---|
109 | <div class="comments"> |
---|
110 | NAME: |
---|
111 | COLORBAR |
---|
112 | |
---|
113 | PURPOSE: |
---|
114 | The purpose of this routine is to add a color bar to the current |
---|
115 | graphics window. |
---|
116 | |
---|
117 | CATEGORY: |
---|
118 | Graphics, Widgets. |
---|
119 | |
---|
120 | CALLING SEQUENCE: |
---|
121 | COLORBAR |
---|
122 | |
---|
123 | INPUTS: |
---|
124 | None. |
---|
125 | |
---|
126 | KEYWORD PARAMETERS: |
---|
127 | |
---|
128 | BOTTOM: The lowest color index of the colors to be loaded in |
---|
129 | the bar. |
---|
130 | |
---|
131 | CB_CHARSIZE: The character size of the color bar annotations. Default is 1.0. |
---|
132 | |
---|
133 | CB_CHARTICK: The character thick of the color bar annotations. Default is 1.0. |
---|
134 | |
---|
135 | CB_COLOR: The color index of the bar outline and characters. Default |
---|
136 | is ncolors - 1 + bottom. |
---|
137 | |
---|
138 | CB_LOG: to get logarithmic scale for the colorbar |
---|
139 | |
---|
140 | CB_TITLE: This is title for the color bar. The default is to have |
---|
141 | no title. |
---|
142 | |
---|
143 | DISCRET: Vecteur contenant les incices des couleurs a tracer en barre |
---|
144 | de couleur. On obtient ainsi une barre de couleur discrete ne comportant que |
---|
145 | les couleurs specifiees ds l'ordre ou elles apparaissent ds le vecteur. |
---|
146 | |
---|
147 | DIVISIONS: The number of divisions to divide the bar into. There will |
---|
148 | be (divisions + 1) annotations. The default is 2. |
---|
149 | |
---|
150 | FORMAT: The format of the bar annotations. Default is '(F6.2)'. |
---|
151 | |
---|
152 | CB_LABEL: C''est un vecteur qui specifie la valeur des sticks |
---|
153 | presents dans la barre de couleur. Il permet qd on utilise |
---|
154 | DISCRET d''avoir des couleurs qui ne s''incrementent pas de |
---|
155 | facon regulieres. |
---|
156 | |
---|
157 | MAX: The maximum data value for the bar annotation. Default is |
---|
158 | NCOLORS-1. |
---|
159 | |
---|
160 | MIN: The minimum data value for the bar annotation. Default is 0. |
---|
161 | |
---|
162 | NCOLORS: This is the number of colors in the color bar. |
---|
163 | |
---|
164 | NOTITLE: oblige a ne pas mettre de titre meme si cb_title est declare |
---|
165 | |
---|
166 | POSITION: A four-element array of normalized coordinates in the same |
---|
167 | form as the POSITION keyword on a plot. Default is |
---|
168 | [0.88, 0.15, 0.95, 0.95] for a vertical bar and |
---|
169 | [0.15, 0.88, 0.95, 0.95] for a horizontal bar. |
---|
170 | |
---|
171 | PSCOLOR: This keyword is only applied if the output is being sent to |
---|
172 | a PostScript file. It indicates that the PostScript device |
---|
173 | is configured for color output. If this keyword is set, then |
---|
174 | the annotation is drawn in the color specified by the COLOR |
---|
175 | keyword. If the keyword is not set, the annotation is drawn |
---|
176 | in the color specified by the !P.COLOR system variable |
---|
177 | (usually this will be the color black). In general, this |
---|
178 | gives better looking output on non-color or gray-scale |
---|
179 | printers. If you are not specifically setting the annotation |
---|
180 | color (with the COLOR keyword), it will probably |
---|
181 | be better NOT to set this keyword either, even if you |
---|
182 | are outputting to a color PostScript printer. |
---|
183 | |
---|
184 | RIGHT: This puts the labels on the right-hand side of a vertical |
---|
185 | color bar. It applies only to vertical color bars. |
---|
186 | |
---|
187 | TOP: This puts the labels on top of the bar rather than under it. |
---|
188 | The keyword only applies if a horizontal color bar is rendered. |
---|
189 | |
---|
190 | VERTICAL: Setting this keyword give a vertical color bar. The default |
---|
191 | is a horizontal color bar. |
---|
192 | |
---|
193 | COMMON BLOCKS: |
---|
194 | None. |
---|
195 | |
---|
196 | SIDE EFFECTS: |
---|
197 | Color bar is drawn in the current graphics window. |
---|
198 | |
---|
199 | RESTRICTIONS: |
---|
200 | The number of colors available on the display device (not the |
---|
201 | PostScript device) is used unless the NCOLORS keyword is used. |
---|
202 | |
---|
203 | EXAMPLE: |
---|
204 | To display a horizontal color bar above a contour plot, type: |
---|
205 | |
---|
206 | LOADCT, 5, NCOLORS=100 |
---|
207 | CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $ |
---|
208 | C_COLORS=INDGEN(25)*4, NLEVELS=25 |
---|
209 | COLORBAR, NCOLORS=100 |
---|
210 | |
---|
211 | MODIFICATION HISTORY: |
---|
212 | Written by: David Fanning, 10 JUNE 96. |
---|
213 | 10/27/96: Added the ability to send output to PostScript. DWF |
---|
214 | 11/4/96: Substantially rewritten to go to screen or PostScript |
---|
215 | file without having to know much about the PostScript device |
---|
216 | or even what the current graphics device is. DWF |
---|
217 | 1/27/97: Added the RIGHT and TOP keywords. Also modified the |
---|
218 | way the TITLE keyword works. DWF |
---|
219 | 7/15/97: Fixed a problem some machines have with plots that have |
---|
220 | no valid data range in them. DWF |
---|
221 | 3/3/98: ajout du keyword discret par</div> |
---|
222 | |
---|
223 | |
---|
224 | |
---|
225 | |
---|
226 | |
---|
227 | |
---|
228 | |
---|
229 | <h3>Keywords</h3> |
---|
230 | |
---|
231 | <h4 id="_COLORBAR_keyword_BOTTOM">BOTTOM |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | |
---|
236 | |
---|
237 | |
---|
238 | |
---|
239 | |
---|
240 | </h4> |
---|
241 | |
---|
242 | <div class="comments"></div> |
---|
243 | |
---|
244 | <h4 id="_COLORBAR_keyword_CB_CHARSIZE">CB_CHARSIZE |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | </h4> |
---|
254 | |
---|
255 | <div class="comments"></div> |
---|
256 | |
---|
257 | <h4 id="_COLORBAR_keyword_CB_CHARTHICK">CB_CHARTHICK |
---|
258 | |
---|
259 | |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | |
---|
265 | |
---|
266 | </h4> |
---|
267 | |
---|
268 | <div class="comments"></div> |
---|
269 | |
---|
270 | <h4 id="_COLORBAR_keyword_CB_COLOR">CB_COLOR |
---|
271 | |
---|
272 | |
---|
273 | |
---|
274 | |
---|
275 | |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | </h4> |
---|
280 | |
---|
281 | <div class="comments"></div> |
---|
282 | |
---|
283 | <h4 id="_COLORBAR_keyword_DIVISIONS">DIVISIONS |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | |
---|
290 | |
---|
291 | |
---|
292 | </h4> |
---|
293 | |
---|
294 | <div class="comments"></div> |
---|
295 | |
---|
296 | <h4 id="_COLORBAR_keyword_DISCRET">DISCRET |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | |
---|
302 | |
---|
303 | |
---|
304 | |
---|
305 | </h4> |
---|
306 | |
---|
307 | <div class="comments"></div> |
---|
308 | |
---|
309 | <h4 id="_COLORBAR_keyword_CB_LABEL">CB_LABEL |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | |
---|
317 | |
---|
318 | </h4> |
---|
319 | |
---|
320 | <div class="comments"></div> |
---|
321 | |
---|
322 | <h4 id="_COLORBAR_keyword_FORMAT">FORMAT |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | |
---|
328 | |
---|
329 | |
---|
330 | |
---|
331 | </h4> |
---|
332 | |
---|
333 | <div class="comments"></div> |
---|
334 | |
---|
335 | <h4 id="_COLORBAR_keyword_POSITION">POSITION |
---|
336 | |
---|
337 | |
---|
338 | |
---|
339 | |
---|
340 | |
---|
341 | |
---|
342 | |
---|
343 | |
---|
344 | </h4> |
---|
345 | |
---|
346 | <div class="comments"></div> |
---|
347 | |
---|
348 | <h4 id="_COLORBAR_keyword_MAX">MAX |
---|
349 | |
---|
350 | |
---|
351 | |
---|
352 | |
---|
353 | |
---|
354 | |
---|
355 | |
---|
356 | |
---|
357 | </h4> |
---|
358 | |
---|
359 | <div class="comments"></div> |
---|
360 | |
---|
361 | <h4 id="_COLORBAR_keyword_MIN">MIN |
---|
362 | |
---|
363 | |
---|
364 | |
---|
365 | |
---|
366 | |
---|
367 | |
---|
368 | |
---|
369 | |
---|
370 | </h4> |
---|
371 | |
---|
372 | <div class="comments"></div> |
---|
373 | |
---|
374 | <h4 id="_COLORBAR_keyword_NCOLORS">NCOLORS |
---|
375 | |
---|
376 | |
---|
377 | |
---|
378 | |
---|
379 | |
---|
380 | |
---|
381 | |
---|
382 | |
---|
383 | </h4> |
---|
384 | |
---|
385 | <div class="comments"></div> |
---|
386 | |
---|
387 | <h4 id="_COLORBAR_keyword_PSCOLOR">PSCOLOR |
---|
388 | |
---|
389 | |
---|
390 | |
---|
391 | |
---|
392 | |
---|
393 | |
---|
394 | |
---|
395 | |
---|
396 | </h4> |
---|
397 | |
---|
398 | <div class="comments"></div> |
---|
399 | |
---|
400 | <h4 id="_COLORBAR_keyword_CB_TITLE">CB_TITLE |
---|
401 | |
---|
402 | |
---|
403 | |
---|
404 | |
---|
405 | |
---|
406 | |
---|
407 | |
---|
408 | |
---|
409 | </h4> |
---|
410 | |
---|
411 | <div class="comments"></div> |
---|
412 | |
---|
413 | <h4 id="_COLORBAR_keyword_VERTICAL">VERTICAL |
---|
414 | |
---|
415 | |
---|
416 | |
---|
417 | |
---|
418 | |
---|
419 | |
---|
420 | |
---|
421 | |
---|
422 | </h4> |
---|
423 | |
---|
424 | <div class="comments"></div> |
---|
425 | |
---|
426 | <h4 id="_COLORBAR_keyword_TOP">TOP |
---|
427 | |
---|
428 | |
---|
429 | |
---|
430 | |
---|
431 | |
---|
432 | |
---|
433 | |
---|
434 | |
---|
435 | </h4> |
---|
436 | |
---|
437 | <div class="comments"></div> |
---|
438 | |
---|
439 | <h4 id="_COLORBAR_keyword_RIGHT">RIGHT |
---|
440 | |
---|
441 | |
---|
442 | |
---|
443 | |
---|
444 | |
---|
445 | |
---|
446 | |
---|
447 | |
---|
448 | </h4> |
---|
449 | |
---|
450 | <div class="comments"></div> |
---|
451 | |
---|
452 | <h4 id="_COLORBAR_keyword_CB_LOG">CB_LOG |
---|
453 | |
---|
454 | |
---|
455 | |
---|
456 | |
---|
457 | |
---|
458 | |
---|
459 | |
---|
460 | |
---|
461 | </h4> |
---|
462 | |
---|
463 | <div class="comments"></div> |
---|
464 | |
---|
465 | <h4 id="_COLORBAR_keyword__extra">_extra |
---|
466 | |
---|
467 | |
---|
468 | |
---|
469 | |
---|
470 | |
---|
471 | |
---|
472 | |
---|
473 | |
---|
474 | </h4> |
---|
475 | |
---|
476 | <div class="comments"></div> |
---|
477 | |
---|
478 | |
---|
479 | |
---|
480 | |
---|
481 | |
---|
482 | |
---|
483 | |
---|
484 | |
---|
485 | |
---|
486 | |
---|
487 | |
---|
488 | |
---|
489 | |
---|
490 | |
---|
491 | |
---|
492 | |
---|
493 | |
---|
494 | |
---|
495 | |
---|
496 | |
---|
497 | |
---|
498 | |
---|
499 | |
---|
500 | |
---|
501 | |
---|
502 | |
---|
503 | </div> |
---|
504 | |
---|
505 | </div> |
---|
506 | |
---|
507 | |
---|
508 | |
---|
509 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
510 | |
---|
511 | </div> |
---|
512 | |
---|
513 | </body> |
---|
514 | </html> |
---|