source: trunk/SRC/Documentation/idldoc_html_output/Colors/getcolor.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: 22.1 KB
Line 
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>getcolor.pro (SAXO Documentation)</title>
10
11   
12    <style type="text/css" media="all">
13     
14/* CSS for all files which appear in the "main" viewing area: overview,
15   directory overviews, warnings, index, search, pro files, source
16   code, help, and etc files. */
17
18/* Link styles --------------------------------------------------------------- */
19
20a { text-decoration: none; }
21
22a:link, a:visited { 
23  color: #660000; 
24  border-bottom: 1px dotted #C0C0F0;   
25}
26
27a:hover, a:focus { 
28  color: #993333; 
29  background: #FFFFCC; 
30  border-bottom: 1px dotted #303099; 
31}
32
33
34/* Main styles --------------------------------------------------------------- */
35p.preformat {
36  font-family: Courier;
37}
38
39body {
40  margin: 0;
41  padding: 0;
42  font-size: 10pt;
43  font-family: Verdana, Helvetica, Arial, sans-serif;
44  background-color: #FFFFFF;
45}
46
47p {
48  margin-top: 0.5em;
49  margin-bottom: 0;
50}
51
52#container { margin: 1em; }
53
54code.section { white-space: pre; }
55
56pre.snippet {
57  margin-left: 5%;
58  background: #F0F0F0;
59  border: 1px dashed #999999;
60  width: 43em;
61  padding: 0.5em 0.5em 0.5em 0.5em;
62  white-space: pre;
63}
64
65/* Navbar styles ------------------------------------------------------------- */
66
67#navbar_title {
68  color: #000033;
69  background-color: #F0F0FF;
70  font-family: Arial, Helvetica, sans-serif;
71  padding: 20px 30px;
72  border-bottom: 1px solid #000033;
73}
74
75#navbar_title * {
76  margin: 0;
77  padding: 0;
78}
79
80#navbar_title h1 {
81  letter-spacing: 0.1em;
82  font-variant: small-caps;
83  font-size: 250%;
84  text-indent: -1em;
85  padding-left: 1em; 
86}
87
88#navbar_title h2 {
89  font-size: 110%;
90  font-weight: normal;
91  color: #333399;
92}
93
94#main_navbar table {
95  width: 100%;
96  border-bottom: 1px solid #666699;
97}
98
99#main_navbar td {
100  background: #CCCCFF;
101  font-size: 80%;
102  font-weight: bold;
103  font-family: Arial, Helvetica, sans-serif;
104  border-top: 3px solid #CCCCFF;
105  border-bottom: 3px solid #CCCCFF;
106  padding-left: 6px;
107  padding-right: 6px;
108  margin: 0;
109}
110
111#main_navbar td#selected {
112  background: #CCCCFF;
113  font-size: 80%;
114  font-weight: bold;
115  font-family: Arial, Helvetica, sans-serif;
116  border-top: 3px solid #333399;
117  border-bottom: 3px solid #CCCCFF;
118  padding-left: 6px;
119  padding-right: 6px;
120  margin: 0;
121}
122
123#main_navbar td#flexible {
124  width: 100%;
125  text-align: right;
126  padding-right: 1em;
127  background: #CCCCFF;
128  font-size: 70%;
129  font-weight: normal;
130  font-family: Arial, Helvetica, sans-serif;
131  text-transform: uppercase;
132  border-top: 3px solid #CCCCFF;
133  border-bottom: 3px solid #CCCCFF;
134}
135
136#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138#main_navbar a:hover, #main_navbar a:focus {
139  color: #FFFF66;
140  background: #CCCCFF;
141  border-bottom: 1px none #606099; 
142  border: 0;
143}
144
145#secondary_navbar {
146  font-size: 80%;
147  font-weight: normal;
148  font-family: Arial, Helvetica, sans-serif;
149  margin-top: 4px;
150  margin-left: 20px;
151  white-space: nowrap;
152}
153
154
155/* Tagline and footer styles ------------------------------------------------- */
156
157div#tagline {
158  margin-top: 6px;
159  border-top: 1px dotted lightsteelblue;
160  padding-top: 6px;
161  font-size: 66%;
162  font-style: italic;
163}
164
165div#footer {
166  margin-top: 6px;
167  border-top: 1px dotted lightsteelblue;
168  padding-top: 6px;
169  font-size: 66%;
170  font-style: italic;
171}
172
173/* Basic data presenation styles -------------------------------------------- */
174
175.index_letter { 
176  font-size: 300%;
177  font-weight: bold;
178  color: #000066; 
179  margin: 0.5em 0 0 -0.1em;
180}
181
182h1, h2, h3, h4 {
183  font-weight: normal;
184  color: #3333CC;
185}
186
187h1 {
188  padding-top: 0.75em;
189  font-size: 160%;
190}
191
192h2 {
193  padding-top: 1em;
194  font-size: 120%;
195  }
196
197h3 {
198  padding-top: 0.75em;
199  margin-bottom: 0.25em;
200  font-size: 100%;
201}
202
203h4 {
204  padding: 0;
205  margin: 0.5em 0 0 0;
206  font-size: 80%;
207}
208
209table.basic {
210  empty-cells: show;
211  margin: 1.5em 1em 0 1em;
212  border: 1px dotted #CFCFFF;
213  font-size: 80%;
214}
215
216table.basic th {
217  background-color: #F0F0FF;
218  font-weight: bold;
219  text-align: left;
220  padding: 4px 1em 4px 4px;
221  border-bottom: 1px dotted #666699;
222}
223
224table.basic td {
225  vertical-align: top;
226  padding: 4px 1em 4px 4px;
227}
228
229dd {
230  margin-bottom: 0.25em;
231  font-size: 80%;
232}
233
234
235/* Warnings styles ----------------------------------------------------------- */
236
237
238#todo dl, #bugs dl { 
239  margin: 0 0 0 1.5em;
240  font-size: 80%;
241}
242
243#todo dd, #bugs dd { 
244  margin-left: 3em; 
245  font-size: 100%;
246}
247
248#undoc table, #obsolete table, #statistics table {
249  width: 80%;
250  margin-left: 2em;
251}
252
253#undoc td, #obsolete td, #statistics td { 
254  padding: 0 0 0 0;
255  font-size: 80%;
256  white-space: nowrap;
257}
258
259#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261#undoc td.docstat, #statistics td.stat { 
262  width: 50%;
263  text-align: right;
264}
265
266#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270/* File + routine styles ----------------------------------------------------- */
271
272h1.directory { 
273  padding: 1em 0 0 0;
274  margin: 0;
275  font-size: 66%;
276}
277
278h1.directory a { border-bottom: 0; }
279
280h2.pro_file { 
281  padding: 0;
282  margin: 0;
283  font-size: 140%;
284}
285
286div#file_attr {
287  padding: 0 1em 0 1em;
288  margin: 1em;
289  background: #F6F6F6;
290  border: 1px dotted #999999;
291}
292
293div#file_attr dt {
294  font-size: 80%;
295  font-weight: bold;
296}
297
298div#file_attr dd {
299  font-size: 80%;
300}
301
302div#class_diagram { 
303  padding: 1em 0 1em 0; 
304  white-space: pre;
305  font-family: 'Courier New';
306}
307
308table#sav_attr { 
309  font-size: 90%; 
310  margin: 1em; 
311  padding: 1em 1em 1em 1em;
312  background: #F6F6F6;
313  border: 1px dotted #999999;
314}
315
316table#sav_attr th { text-align: left; }
317
318table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324table.variables { 
325  font-family: 'Courier New', monospace; 
326  font-size: 80%; 
327  text-indent: -2em; 
328  padding-left: 2em; 
329}
330
331table.variables td.image { width: 64px; }
332
333div#file_comments { white-space: pre; 
334  margin: 2em;
335  font-size: 80%;
336}
337
338
339div.field_summary {
340  padding: 0 1em 0 1em;
341  margin: 1em;
342  background: #FFFFF0;
343  border: 1px dotted #C0C000;
344}
345
346div#routine_summary { 
347  padding: 0 1em 0 1em;
348  margin: 1em;
349  background: #F0F0FF;
350  border: 1px dotted #9999FF;
351}
352
353div.field_summary h2, div#routine_summary h2 { 
354  padding: 0.5em 0 0 0;
355  margin: 0;
356}
357
358div.field_summary table, div.field_summary p { 
359  margin: 1em 1em;
360}
361
362div.field_summary td.name { 
363  vertical-align: top;
364  padding-bottom: 0.25em;
365  color: #3333CC;
366}
367
368div.field_summary span.field_type { 
369  font-weight: normal;
370  font-size: 80%;
371  color: black;
372}
373
374div.field_summary td.comments { 
375  vertical-align: top;
376  padding-left: 2em;
377  font-size: 80%;
378}
379
380p.commaList { 
381  margin: 1em 1em 1em 1em;
382}
383
384span.warning { 
385  color: #CC6633;
386  font-weight: bold;
387  font-size: 66%;
388  text-transform: uppercase;
389}
390
391span.categories { 
392  color: #006633;
393  font-weight: bold;
394  font-size: 66%;
395  text-transform: uppercase;
396}
397
398span.undoc { 
399  color: #FF6633;
400  font-weight: bold;
401  font-size: 80%;
402  text-transform: uppercase;
403}
404
405span.attr { 
406  color: #006633;
407  font-weight: bold;
408  font-size: 80%;
409  text-transform: uppercase;
410}
411
412span.value { 
413  color: #006633;
414  font-weight: normal;
415  text-transform: none;
416}
417
418a.top { 
419  font-weight: bold;
420  font-size: 66%;
421  text-transform: uppercase;
422  float: right;
423}
424
425span.result { 
426  font-family: Verdana, Arial, Helvetica, sans-serif;
427  font-style: italic;
428  font-size: 80%;
429}
430
431div#routine_summary p, div.routine_details p.header { 
432  padding-top: 0.5em;
433  margin-left: 1.5em;
434  text-indent: -1.5em;
435  font-family: 'Courier New', monospace;
436}
437
438div.routine_details { 
439  padding: 0.5em 1em 0.5em 1em;
440  margin: 1em;
441  border: 1px dotted #CCCCCC;
442}
443
444div.routine_details h2 { 
445  padding-top: 0;
446  margin-top: 0;
447}
448
449div.routine_details div.value { 
450  margin: 0 1em 0 1em;
451  font-size: 80%;
452}
453
454div.routine_details div.comments { 
455  font-size: 80%;
456  margin: 0.75em 1em 1em 1em;
457}
458
459div.routine_details div.preformat { 
460  white-space: pre;
461}
462
463table.statistics { 
464  font-size: 80%;
465  margin-left: 1em;
466}
467
468table.statistics td { 
469  padding: 0 2em 0 0;
470}
471
472/* Overview styles ----------------------------------------------------------- */
473
474div.overview { 
475  width: 100%;
476  margin-top: 1em;
477  clear: both;
478}
479
480div.overview table {
481  empty-cells: show;
482  font-size: 90%;
483  margin: 1em 1em 1em 1em;
484  padding: 1em 0.5em 1em 0.5em;
485  background: #F6F6F6;
486  border: 1px dotted #999999;
487}
488
489div.overview td {
490  padding: 3px 1em 3px 1em;
491}
492
493div.overview td.dir {
494  width: 1%;
495  vertical-align: top;
496  text-align: right;
497  padding-right: 1em;
498}
499
500
501/* Navigation list styles for tree structures -------------------------------- */
502
503#tree {
504  text-align: left;
505  font-size: 90%;
506  margin: 0.75em 0 0.75em 0;
507  padding: 0;
508}
509
510#tree ul {
511  text-align: left;
512  margin: 0;
513  padding: 0;
514}
515
516#tree li {
517  margin: 0 0 0 15px;
518  padding: 0;
519  list-style-type: none;
520}
521
522#tree .symbols {
523  float: left;
524  width: 12px;
525  height: 1em;
526  padding-left: 4px;
527  background-position: 0 100%;
528  background-repeat: no-repeat;
529}
530
531/* Search styles ------------------------------------------------------------- */
532
533input.writein { 
534  padding-left: 0.5em;
535  border: 1px solid #CCCCCC;
536  font-family: 'Courier New';
537  background: #FFFFF3;
538}
539
540#search form { 
541  margin-left: 2em;
542}
543
544#search table { 
545  margin: 1em 1em 0 2em;
546  padding: 1em 2em 1em 2em;
547  background: #F6F6F6;
548  border: 1px dotted #999999;
549}
550
551#search tr { 
552  text-align: center;
553}
554
555#search td { 
556  font-size: 80%; 
557  text-align: left;
558}
559
560#search td * { 
561  vertical-align: middle;
562}
563
564#search p { 
565  font-size: 66%;
566  margin: 0 3em 2em 3em;
567}
568
569/* Help styles --------------------------------------------------------------- */
570
571div.toc { 
572  padding: 0 1em 0 1em;
573  margin: 1em;
574  background: #F0F0FF;
575  border: 1px dotted #9999FF; 
576  width: 19em;
577}
578
579div.right { 
580  float: right;
581  width: 22em;
582}
583
584ol.toc { 
585  list-style-type: upper-roman;
586}
587
588ol.toc ol { 
589  padding-left: 3em;
590  margin-left: 0;
591  list-style-type: lower-alpha;
592}
593
594dl.variables dt { font-size: 80%; }
595dl.variables dd { margin-bottom: 0.5em; }
596
597    </style>
598    <style type="text/css" media="print">
599      #navbar_title { 
600  background-color: #FFFFFF; 
601}
602
603#main_navbar td {
604  background: #FFFFFF;
605  border-top: 0.25em solid #FFFFFF;
606  border-bottom: 0.25em solid #FFFFFF;
607}
608
609#main_navbar td#selected {
610  background: #FFFFFF;
611  border-top: 0.25em solid #333399;
612  border-bottom: 0.25em solid #FFFFFF;
613}
614
615#main_navbar td#flexible {
616  background: #FFFFFF;
617  border-top: 0.25em solid #FFFFFF;
618  border-bottom: 0.25em solid #FFFFFF;
619}
620
621#secondary_navbar {
622  display: none;
623}
624
625    </style>
626   
627
628    <script type="text/javascript">
629      function setTitle() {
630        parent.document.title="getcolor.pro (SAXO Documentation)";
631      }
632    </script>
633  </head>
634
635  <body onload="setTitle();">
636
637    <div id="navbar_title">
638  <h1>SAXO Documentation</h1>
639</div>
640
641
642<div id="main_navbar">
643
644  <table cellspacing="0">
645    <tr>
646     
647      <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
648     
649
650     
651      <td >Directory</td>
652     
653
654     
655      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656     
657
658     
659      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660     
661
662     
663      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
664     
665
666      <td id="selected">File</td>
667
668     
669      <td >Source</td>
670     
671
672     
673      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674     
675
676      <td >Etc</td>
677
678      <td id="flexible">Developer&nbsp;documentation</td>
679    </tr>
680  </table>
681
682</div>
683
684<div id="secondary_navbar">
685
686<a href="colorbar.html?format=raw">&lt;&lt;prev file</a> | <a href="lct.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="getcolor.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
687
688</div>
689
690
691    <div id="container">
692
693      <h1 class="directory"><a href="directory-overview.html?format=raw">Colors/</a></h1>
694      <h2 class="pro_file">getcolor.pro</h2>
695
696      <div id="file_attr">
697        <dl>
698        </dl>
699      </div>
700
701      <div id="file_comments"> 
702 The original purpose of this function was to enable the
703 user to specify one of the 16 colors supported by the
704 McIDAS color map by name. Over time, however, the function
705 has become a general purpose function for handling and
706 supporting drawing colors in a device-independent way.
707 In particular, I have been looking for ways to write color
708 handling code that will work transparently on both 8-bit and
709 24-bit machines. On 24-bit machines, the code should work the
710 same where color decomposition is turned on or off.
711
712 (The 16 supported colors in GETCOLOR come from the McIDAS color
713 table offered on the IDL newsgroup by Liam Gumley.)
714</div>
715
716     
717
718     
719
720     
721
722     
723
724      <div id="routine_details">
725       
726
727        <div class="routine_details" id="_getcolor">
728
729          <h2><a class="top" href="#container">top</a>getcolor <span class="categories"> Graphics, Color
730</span></h2>
731       
732          <p class="header">
733            <span class="result">result = </span>getcolor(<span class="result">[<a href="#_getcolor_param_thisColor">thisColor</a>][, <a href="#_getcolor_param_index">index</a>]</span>, <a href="#_getcolor_keyword_TRUE">TRUE</a>=<span class="result">TRUE</span>, <a href="#_getcolor_keyword_NAMES">NAMES</a>=<span class="result">NAMES</span>, <a href="#_getcolor_keyword_LOAD">LOAD</a>=<span class="result">LOAD</span>, <a href="#_getcolor_keyword_START">START</a>=<span class="result">START</span>)</p>
734       
735          <div class="comments">
736</div>
737
738          <h3>Return value</h3><div class="preformat">
739 If no positional parameter is present, then the return value is either a 16-by-3
740 byte array containing the RGB values of all 16 colors or it is a 16-element
741 long integer array containing color values that can be decomposed into colors.
742 The 16-by-3 array is appropriate for loading color tables with the TVLCT command:
743
744           Device, Decomposed=0
745           colors = GetColor()
746           TVLCT, colors, 100
747
748 If  function is called with just this single input parameter,
749 the return value is either a 1-by-3 array containing the RGB values of
750 that particular color, or a 24-bit integer that can be "decomposed" into
751 that particular color, depending upon the state of the TRUE keyword and
752 upon whether color decomposition is turned on or off. The state of color
753 decomposition can ONLY be determined if the program is being run in
754 IDL 5.2 or higher.
755
756 If index parameter is passed, then the return value of the function is the
757 index number and not the color triple. (If color decomposition is turned
758 on AND the user specifies an index parameter, the color is loaded in the
759 color table at the proper index, but a 24-bit value is returned to the
760 user in IDL 5.2 and higher.)
761
762</div>
763
764         
765            <h3>Parameters</h3>
766       
767           
768            <h4 id="_getcolor_param_thisColor">thisColor&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
769              <span class="attr">in</span>
770             
771              <span class="attr">optional</span>
772             
773             
774             
775             
776             
777            </h4>
778       
779          <div class="comments"> 
780 A string with the "name" of the color. Valid names are:
781           black
782           magenta
783           cyan
784           yellow
785           green
786           red
787           blue
788           navy
789           gold
790           pink
791           aqua
792           orchid
793           gray
794           sky
795           beige
796           white
797
798 The color YELLOW is returned if the color name can't be resolved.
799 Case is unimportant.
800
801</div>
802           
803            <h4 id="_getcolor_param_index">index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
804              <span class="attr">in</span>
805             
806              <span class="attr">optional</span>
807             
808             
809             
810             
811             
812            </h4>
813       
814          <div class="comments"> 
815 The color table index where the specified color should be loaded.
816</div>
817           
818
819         
820
821         
822
823            <h3>Keywords</h3>
824           
825            <h4 id="_getcolor_keyword_TRUE">TRUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
826             
827             
828             
829             
830             
831             
832             
833             
834            </h4>
835       
836            <div class="comments"> 
837 If this keyword is set, the specified color triple is returned
838 as a 24-bit integer equivalent. The lowest 8 bits correspond to
839 the red value; the middle 8 bits to the green value; and the
840 highest 8 bits correspond to the blue value. In IDL 5.2 and higher,
841 if color decomposition is turned on, it is as though this keyword
842 were set.
843</div>
844           
845            <h4 id="_getcolor_keyword_NAMES">NAMES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
846             
847             
848             
849             
850             
851             
852             
853             
854            </h4>
855       
856            <div class="comments"> 
857 If this keyword is set, the return value of the function is
858 a 16-element string array containing the names of the colors.
859 These names would be appropriate, for example, in building
860 a list widget with the names of the colors. If the NAMES
861 keyword is set, the COLOR and INDEX parameters are ignored.
862
863 listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
864</div>
865           
866            <h4 id="_getcolor_keyword_LOAD">LOAD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
867             
868             
869             
870             
871             
872             
873             
874             
875            </h4>
876       
877            <div class="comments"> 
878 If this keyword is set, all 16 colors are automatically loaded
879 starting at the color index specified by the START keyword.
880 Note that setting this keyword means that the return value of the
881 function will be a structure, with each field of the structure
882 corresponding to a color name. The value of each field will be
883 an index number (set by the START keyword) corresponding to the
884 associated color, or a 24-bit long integer value that creates the
885 color on a true-color device. What you have as the field values is
886 determined by the TRUE keyword or whether color decomposition is on
887 or off in the absence of the TRUE keyword. It will either be a 1-by-3
888 byte array or a long integer value.
889</div>
890           
891            <h4 id="_getcolor_keyword_START">START&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
892             
893             
894             
895             
896             
897             
898              <span class="attr">default:</span> <span class="value">!D.TABLE_SIZE - 17</span>
899             
900            </h4>
901       
902            <div class="comments">
903 The starting color index number if the LOAD keyword is set. This keyword
904 value is ignored unless the LOAD keyword is also set. The keyword is also
905 ignored if the TRUE keyword is set or if color decomposition in on in
906 IDL 5.2 and higher.
907</div>
908           
909         
910
911          <h3>Examples</h3><div class="preformat"> 
912 To load a yellow color in color index 100 and plot in yellow, type:
913
914      IDL> yellow = GETCOLOR('yellow', 100)
915      IDL> PLOT, data, COLOR=yellow
916
917 or,
918
919      IDL> PLOT, data, COLOR=GETCOLOR('yellow', 100)
920
921 To do the same thing on a 24-bit color system with decomposed color on, type:
922
923      IDL> PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
924
925 or in IDL 5.2 and higher,
926
927      IDL> DEVICE, Decomposed=1
928      IDL> PLOT, data, COLOR=GETCOLOR('yellow')
929
930 To load all 16 colors into the current color table, starting at
931 color index 200, type:
932
933      IDL> TVLCT, GETCOLOR(), 200
934
935 To add the color names to a list widget:
936
937      IDL> listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
938
939 To load all 16 colors and have the color indices returned in a structure:
940
941      IDL> DEVICE, Decomposed=0
942      IDL> colors = GetColor(/Load, Start=1)
943      IDL> HELP, colors, /Structure
944      PLOT, data, COLOR=colors.yellow
945
946 To get the direct color values as 24-bit integers in color structure fields:
947
948      IDL> DEVICE, Decomposed=1
949      IDL> colors = GetColor(/Load)
950      IDL> PLOT, data, COLOR=colors.yellow
951
952 Note that the START keyword value is ignored if on a 24-bit device,
953 so it is possible to write completely device-independent code by
954 writing code like this:
955
956      IDL> colors = GetColor(/Load)
957      IDL> PLOT, data, Color=colors.yellow;           IDL> DEVICE, Decomposed=0
958      IDL> colors = GetColor(/Load, Start=1)
959      IDL> HELP, colors, /Structure
960      PLOT, data, COLOR=colors.yellow
961
962 To get the direct color values as 24-bit integers in color structure fields:
963
964      IDL> DEVICE, Decomposed=1
965      IDL> colors = GetColor(/Load)
966      IDL> PLOT, data, COLOR=colors.yellow
967
968 Note that the START keyword value is ignored if on a 24-bit device,
969 so it is possible to write completely device-independent code by
970 writing code like this:
971
972      IDL> colors = GetColor(/Load)
973      IDL> PLOT, data, Color=colors.yellow
974</div>
975          <h3>Version history</h3>
976         
977          <h4>Version</h4><div class="preformat"> $Id: getcolor.pro 137 2006-07-12 09:33:44Z smasson $</div>
978          <h4>History</h4><div class="preformat"> 
979 Written by: David Fanning, 10 February 96.
980 Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF
981 Added the McIDAS colors to the program. 24 Feb 99. DWF
982 Added the INDEX parameter to the program 8 Mar 99. DWF
983 Added the NAMES keyword at insistence of Martin Schultz. 10 Mar 99. DWF
984 Reordered the colors so black is first and white is last. 7 June 99. DWF
985 Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
986 Added LOAD AND START keywords. 7 June 99. DWF.
987</div>
988         
989         
990          <h3>Known issues</h3>
991         
992         
993         
994          <h4>Restrictions</h4><div class="preformat"> 
995 The TRUE keyword causes the START keyword to be ignored.
996 The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be
997 ignored.
998 The COLOR parameter is ignored if the LOAD keyword is used.
999 On systems where it is possible to tell the state of color decomposition
1000 (i.e., IDL 5.2 and higher), a 24-bit value (or values) is automatically
1001 returned if color decomposition is ON.
1002</div>
1003       
1004         
1005         
1006         
1007         
1008         
1009         
1010         
1011       
1012          <h3>Statistics</h3>
1013          <table class="statistics">
1014            <tr><td>McCabe cyclic</td><td>          30</td></tr>
1015            <tr><td>McCabe essential</td><td>           1</td></tr>
1016            <tr><td>McCabe modular design</td><td>           1</td></tr>
1017          </table>
1018         
1019       
1020        </div>
1021       
1022      </div>
1023
1024     
1025
1026      <div id="tagline">Produced by IDLdoc 2.0.</div>
1027
1028    </div>
1029
1030  </body>
1031</html>
Note: See TracBrowser for help on using the repository browser.