; docformat = 'rst' ; ; NAME: ; cgLoadCT ; ; PURPOSE: ; This is a drop-in replacement for the IDL-supplied program LOADCT. ; The same keywords used with LOADCT apply. In addition, a REVERSE keyword ; is supplied to reverse the color table vectors, and a CLIP keyword is ; supplied to be able to clip the normal LOADCT color table. This is ; extremely useful if you wish to use a reduced number of colors. All color ; table loading is handled silently. And Brewer color tables can be loaded. ; ;******************************************************************************************; ; ; ; Copyright (c) 2011, by Fanning Software Consulting, Inc. All rights reserved. ; ; ; ; Redistribution and use in source and binary forms, with or without ; ; modification, are permitted provided that the following conditions are met: ; ; ; ; * Redistributions of source code must retain the above copyright ; ; notice, this list of conditions and the following disclaimer. ; ; * Redistributions in binary form must reproduce the above copyright ; ; notice, this list of conditions and the following disclaimer in the ; ; documentation and/or other materials provided with the distribution. ; ; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ; ; contributors may be used to endorse or promote products derived from this ; ; software without specific prior written permission. ; ; ; ; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ; ; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ; ; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ; ; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ; ; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ; ; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ; ; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ; ; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ; ; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ; ; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ; ;******************************************************************************************; ; ;+ ; This is a drop-in replacement for the IDL-supplied program LOADCT. ; The same keywords used with LOADCT apply. In addition, a REVERSE keyword ; is supplied to reverse the color table vectors, and a CLIP keyword is ; supplied to be able to clip the normal LOADCT color table. This is ; extremely useful if you wish to use a reduced number of colors. All color ; table loading is handled silently. And Brewer color tables can be loaded. ; ; :Categories: ; Graphics ; ; :Params: ; table: in, optional, type=integer, default=0 ; Optional color table number to load. Integer from 0 to the number of ; tables in the color table file, minus 1. ; ; :Keywords: ; addcmd: in, optional, type=boolean, default=0 ; Set this keyword to add the command to the resizeable graphics window cgWindow. ; bottom: in, optional, type=integer, default=0 ; The lowest color table index. The colors in the color table start loading here. ; brewer: in, optional, type=boolean, default=0 ; Set this keyword if you wish to use the Brewer Colors, as implemented in the Coyote ; Library file, fsc_brewer.tbl. This program will look first in the $IDL_DIR/resource/colors ; directory for the color table file, and failing to find it there will look in the same ; directory that the source code of this program is located, then in the IDL path. ; Finally, if it still can't find the file, it will ask you to locate it. ; If you can't find it, the program will simply return without loading a color table. ; clip: in, optional, type=integer ; A one- or two-element integer array that indicates how to clip the original color ; table vectors. This is useful if you are restricting the number of colors, and do ; not wish to have black or white (the usual color table end members) in the ; loaded color table. CLIP[0] is the lower bound. (A scalar value of CLIP is treated as ; CLIP[0].) CLIP[1] is the upper bound. For example, to load a blue-temperature color bar ; with only blue colors, you might type this:: ; ; IDL> cgLoadCT, 1, CLIP=[110,240] ; IDL> CINDEX ; ; Or, alternatively, if you wanted to include white at the upper end of the color table:: ; ; IDL> cgLoadCT, 1, CLIP=110 ; IDL> CINDEX ; rgb_table: out, optional, type=btye ; If this keyword is set to a named variable, the color table is returned as an ; [NCOLORS,3] array and no colors are loaded in the display. ; filename: in, optional, type='string' ; The name of a color table file to open. By default colors1.tbl in the IDL ; resource directory. ; get_names: out, optional, type='string' ; If set to a named variable, the names of the color tables are returned ; and no colors are loaded in the display. Note that RGB_TABLE cannot be ; used concurrently with GET_NAMES. Use two separate calls if you want both. ; ncolors: in, optional, type=integer, default=256 ; The number of colors to be loaded into the color table. ; reverse: in, optional, type=boolean, default=0 ; If this keyword is set, the color table vectors are reversed. ; row: in, optional, type=boolean, default=0 ; Set this keyword to indicate you are getting the RGB_TABLE vectors ; for use in the IDL's object graphics routines. Whereas TVLCT expects color ; tables to be 256x3 (column vectors), the object graphics routines expect them ; to be 3x256 (row vectors). Setting this keyword will transpose the vectors ; before they are returned. ; silent: in, optional, type=boolean, default=1 ; This keyword is provided ONLY for compatibility with LOADCT. All color table ; manipulations are handled silently. ; window: in, optional, type=boolean, default=0 ; Set this keyword to add the command to an cgWindow application. ; winid: in, optional, type=integer ; The window index number of an cgWindow to receive the color vectors. ; If this parameter is absent, the color table vectors are sent to the ; current cgWindow. ; ; ; :Examples: ; Suppose you wanted to create a color table that displayed negative values with ; red-temperature values and positive values with blue-temperature values, and you ; would like the red-temperature values to be reversed in the color table (so dark ; colors adjoin in the color table and indicate values near zero). You could do this:: ; ; cgLoadCT, 0 ; cgLoadCT, 3, /REVERSE, CLIP=[32,240], BOTTOM=1, NCOLORS=10 ; cgLoadCT, 1, CLIP=[64, 245], BOTTOM=11, NCOLORS=10 ; cgColorbar, NCOLORS=20, BOTTOM=1, DIV=10, RANGE=[-10,10] ; ; Here is an example that shows the difference between LOADCT and cgLoadCT:: ; ; ERASE, COLOR=cgCOLOR('Charcoal) ; LoadCT, 5, NCOLORS=8 ; cgColorbar, NCOLORS=8, DIVISIONS=8, POSITION=[0.1, 0.65, 0.9, 0.75], XMINOR=0, XTICKLEN=1 ; cgLoadCT, 5, NCOLORS=8, CLIP=[16, 240] ; cgColorbar, NCOLORS=8, DIVISIONS=8, POSITION=[0.1, 0.35, 0.9, 0.45], XMINOR=0, XTICKLEN=1 ; ; :Author: ; FANNING SOFTWARE CONSULTING:: ; David W. Fanning ; 1645 Sheely Drive ; Fort Collins, CO 80526 USA ; Phone: 970-221-0438 ; E-mail: david@idlcoyote.com ; Coyote's Guide to IDL Programming: http://www.idlcoyote.com ; ; :History: ; Change History:: ; Written by David W. Fanning, 30 October 2007. ; Added ability to read Brewer Color Table file, if available, with BREWER keyword. 14 May 2008. DWF. ; Small change in the way the program looks for the Brewer file. 8 July 2008. DWF. ; Changed the way the program looks for the Brewer color table file. Now use ; the Coyote Library routine cgFindPathTo to look for the file. 29 June 2010. DWF. ; Renamed Colorbar procedure to cgColorbar to avoid conflict with IDL 8 Colorbar function. ; 26 September 2010. DWF. ; Added ROW keyword to transpose color table vectors for new graphics functions ; in IDL 8. 23 Nov 2010. DWF. ; Added WINDOW and WINID keywords. 26 January 2011. DWF. ; Added ADDCMD keyword. 29 Jan 2011. DWF. ; Program delevopment ended and code transferred to cgLoadCT as of 4 Feb 2011. DWF. ; Added missing ADDCMD keyword. 28 April 2011. DWF. ; Fixed a problem that occurred when the BOTTOM keyword was used in conjuntion with ; the WINDOW keyword, resulting in incorrect colors in cgWindow programs. 28 April 2011. DWF. ; Added CubeHelix color table from code written by James R. A. Davenport. 5 Nov 2012. DWF. ; Made sure NCOLORS default takes BOTTOM value into account. 18 June 2013. DWF. ; Changed the way the brewer color table is searched for. Speed-up over 300x. 27 Jan 2014. DWF. ; Added two additional color tables to the "Brewer" color table file, fsc_brewer.tbl: "sunset" and "cgrainbow". ; These color tables are especially formulated to assist people with color blindness. ; See `this reference `. 16 Jan 2015. DWF. ; ; :Copyright: ; Copyright (c) 2007-2015, Fanning Software Consulting, Inc. ;- PRO cgLoadCT, table, $ ADDCMD=addcmd, $ BREWER=brewer, $ BOTTOM=bottom, $ CLIP = clip, $ RGB_TABLE=color_table, $ FILENAME=file, $ GET_NAMES=get_names, $ NCOLORS=ncolors, $ REVERSE=reverse, $ ROW=row, $ SILENT=silent, $ WINDOW=window, $ WINID=winID COMMON colors, r_orig, g_orig, b_orig, r_curr, g_curr, b_curr Compile_Opt idl2 ; Error handling. Catch, theError IF theError NE 0 THEN BEGIN Catch, /CANCEL Help, LAST_MESSAGE=1, OUTPUT=traceback Help, Calls=callStack callingRoutine = (StrSplit(StrCompress(callStack[1])," ", /Extract))[0] Print,'' Print, 'Traceback Report from ' + StrUpCase(callingRoutine) + ':' Print, '' FOR j=0,N_Elements(traceback)-1 DO Print, " " + traceback[j] void = Dialog_Message(traceback[0], /Error, TITLE='Trapped Error') IF N_Elements(lun) NE 0 THEN Free_Lun, lun RETURN ENDIF ; Are you adding this command to an cgWindow command list? ; Should this be added to a resizeable graphics window? IF Keyword_Set(addcmd) AND ((!D.Flags AND 256) NE 0) THEN BEGIN windowIDs = cgQuery(COUNT=wincnt) IF N_Elements(winid) NE 0 THEN BEGIN IF (wincnt GT 0) THEN BEGIN index = Where(windowIDs EQ winID) IF index[0] NE -1 THEN cgSet, winid ENDIF ENDIF IF wincnt EQ 0 THEN cgWindow cgWindow, 'cgLoadCT', table, $ BREWER=brewer, $ BOTTOM=bottom, $ CLIP = clip, $ RGB_TABLE=color_table, $ FILE=file, $ GET_NAMES=get_names, $ NCOLORS=ncolors, $ REVERSE=reverse, $ ROW=row, $ SILENT=silent, $ WINID=winID, $ ADDCMD=1 RETURN ENDIF ; Check keywords and arguments. IF N_Elements(table) EQ 0 THEN table = 0 IF N_Elements(bottom) EQ 0 THEN bottom = 0 ELSE bottom = 0 > bottom < (!D.TABLE_SIZE-1) IF N_Elements(clip) EQ 0 THEN clip = [0,255] IF N_Elements(clip) EQ 1 THEN clip = [clip, 255] clip = 0 > clip < 255 IF N_Elements(file) EQ 0 THEN file = Filepath('colors1.tbl', SUBDIRECTORY=['resource', 'colors']) ; Try to locate the brewer file. IF Keyword_Set(brewer) THEN BEGIN brewerfilepath = Filepath( ROOT_DIR=cgSourceDir(), 'fsc_brewer.tbl') brewerFile = File_Search(brewerfilepath, Count=count) IF count EQ 0 THEN BEGIN Message, 'Cannot find the Brewer color table file "fsc_brewer.tbl."' + $ ' Using normal IDL color tables.', /INFORMATIONAL ENDIF ELSE file = brewerfile ENDIF ; Be sure !D.TABLE_SIZE is established. IF (!D.NAME EQ 'X') AND (!D.WINDOW EQ -1) THEN BEGIN Window, /Free, /Pixmap, XSIZE=10, YSIZE=10 WDelete, !D.WINDOW ENDIF IF N_Elements(ncolors) EQ 0 THEN ncolors = !D.TABLE_SIZE - bottom reverse = KEYWORD_SET(reverse) ; Open and read the color table files. OPENR, lun, file, /GET_LUN ntables = 0B READU, lun, ntables ; Make sure table number is within range. IF (table GE ntables) OR (table LT 0) THEN $ Message, 'Table number must be from 0 to ' + StrTrim(Fix(ntables)-1,2) + '.' ; Read the table names, if required, and return. IF Arg_Present(get_names) THEN BEGIN get_names = BytArr(32, ntables) Point_LUN, lun, ntables * 768L + 1 READU, lun, get_names FREE_LUN, LUN get_names = StrTrim(get_names, 2) RETURN ENDIF ; Read the color table. theTables = Assoc(lun, BytArr(256), 1) r = theTables[table*3] g = theTables[table*3+1] b = theTables[table*3+2] ; Close the file. FREE_LUN, lun ; Clip the colors. r = r[clip[0]:clip[1]] g = g[clip[0]:clip[1]] b = b[clip[0]:clip[1]] nclipcolors = (clip[1]-clip[0]) + 1 ; Interpolate to the number of colors asked for. IF ncolors NE nclipcolors THEN BEGIN p = (Lindgen(ncolors) * nclipcolors) / (ncolors-1) r = r[p] g = g[p] b = b[p] ENDIF ; Need to reverse the colors? IF reverse THEN BEGIN r = Reverse(r) g = Reverse(g) b = Reverse(b) ENDIF ; Load a color_table, if needed. Otherwise, load color vectors. IF Arg_Present(color_table) THEN BEGIN color_table = [[r], [g], [b]] IF Keyword_Set(row) THEN color_table = Transpose(color_table) ENDIF ELSE BEGIN r_orig = BYTSCL(Indgen(!D.TABLE_SIZE)) g_orig = r_orig b_orig = r_orig r_orig[bottom] = r g_orig[bottom] = g b_orig[bottom] = b r_curr = r_orig g_curr = g_orig b_curr = b_orig TVLCT, r, g, b, bottom ENDELSE ; If the WINDOW keyword is set, send these colors to a cgWindow object. IF Keyword_Set(window) THEN BEGIN ; Does a window object exist somewhere? DefSysV, '!FSC_WINDOW_LIST', EXISTS=exists IF exists THEN BEGIN theList = !FSC_WINDOW_LIST IF Obj_Valid(theList) THEN BEGIN structs = theList -> Get_Item(/ALL, /DEREFERENCE) IF Size(structs, /TNAME) EQ 'POINTER' THEN RETURN IF N_Elements(winID) EQ 0 THEN BEGIN winID = N_Elements(structs) - 1 ENDIF ELSE BEGIN index = Where(structs.wid[*] EQ winID, count) IF count GT 0 THEN winID = index[0] ELSE BEGIN Message, 'Cannot find an cgWindow with window index ' + StrTrim(winID, 2) + '.' ENDELSE ENDELSE thisWindowStruct = structs[winID] IF Obj_Valid(thisWindowStruct.windowObj) THEN BEGIN ; Get the RGB vectors from the current color table to load. ; This is necessary because the cgWindow object does not use ; the concept of loading its colors at the BOTTOM. So, if the ; BOTTOM keyword is used here, the cgWindow colors would be ; incorrect if we used the r,g,b vectors directly. TVLCT, rr, gg, bb, /GET thisWindowStruct.windowObj -> LoadColors, rr, gg, bb ENDIF RETURN ENDIF ENDIF ENDIF END