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