Extended IDL Help

colorbar.pro

At APS this program is installed in the /usr/local/epics/extensions/idllib directory for EPICS R3.14. This is a utility routine for generating the colorbar on a plot device.

List of Routines


Routine Descriptions

COLORBAR

[List of Routines]
 NAME:
       COLORBAR

 PURPOSE:
       This routine provides the user with the flexibility of specifying 
       the size and the place of the colorbar to be drawn on the plot. 

 CALLING SEQUENCE:

       COLORBAR, Zrange [,Width] [,Height] [,X=x] [,Y=y] [,Wid=wid]

 INPUTS:
       Zrange: [Zmin,Zmax] specifies the minimum and maximum value of
               data corresponding to the first and last entry of color 
               table.

 OPTIONAL INPUTS:
       Width:  specify the width of the color bar, default to 20 pixels
       Height: specify the height of the color bar, default to 320 pixels
	
 KEYWORD PARAMETERS:
       X:      specify X location of the lower left corner of the color bar,
               default to 70 pixels from right boundary for X device
       Y:      specify Y location of the lower left corner of the color bar,
               default to 100 pixels from bottom boundary for X device
       Wid:    specify the destination window the color bar to be drawn,
               default to current plot device 
       Ncap:   specify the number of value labels
       Format: specify the color bar label format
       PSfact: specify the PS color bar scaling factor, default is 30
       Reverse: use black color for color bar text color
       Ncolors: specify the number of colors used from the table
       OFF:    specify offset value for colorbar
       LOG:    specify linear or log scale used

 OUTPUTS:
       None.

 RESTRICTION:
       The Width, Height are absolute pixel numbers respect to the actual
       plot device. The location X, and Y pixels respect to the plot device
       origin.

 EXAMPLE:
       Example 1 - Place a colorbar at the default location 70,100 pixels from 
       the lower right corner of the plot area

		colorbar,[min(z),max(z)]	

       Example 2 - Place a colorbar at the location 10,100 pixels from 
       the lower left corner of the plot area

		colorbar,[min(z),max(z)],X=10,Y=100	

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha, April 9, 1999
       xx-xx-xxxx  xxx	Comment

(See colorbar.pro)