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