Seadisp Color Bar Function: Program-level Documentation

Seadisp Color Bar Function (cbar)

Description:Add a color bar to a display window. If the window is subsequently output as a PNG or postscript file, then this color bar willl automatically be included (unless explicitly excluded).

[Interactive Mode][Command Mode]

Command Mode:

Usage: cbar, fbuf=fbuf, incr=incr, vals=vals, ann=ann, format=format, orient=orient, fonttype=fonttype, fontname=fontname, charsize=charsize, charthick=charthick, /ON, /OFF

Arguments/Keywords:

fbuf Window number. If omitted, then current window number is used.

incr Specify desired color bar increment in data units.

vals Specify an array of data values at which points to annotate the color bar.

ann Specify a string array of annotation values to use at the data value locations specified in vals. If omitted, the annotation values will be the data values listed in vals using the format specified in format.

format The format to use for annotating the color bar (The default depends on the data type displayed):

floating-point: F8.2

1-byte integer: I3

2-byte integer: I6

orient Specify the orientation of the color bar. The default depends on the aspect ratio of the output image. By default, the color bar will always be placed along the longest edge of the image.

'V' = Vertical

'H' = Horizontal

Color bar Font The default font is the default hardware font selected for your widget font or specified by environment variable $SDSWFONT.

fonttype Specify vector font or hardware font:

0 = Hardware font (default)

-1 = Vector font

fontname Specify font name for either vector or hardware font type.

charsize Specify character size for vector font only. (default is 1.0)

charthick Specify character thickness for vector font only. (default is 1)

on Turn on color bar (Default)

off Turn off color bar (this would be primarily used for demos)

Interactive Mode:

Description: The Color Bar Setup Widget provides the capability of displaying a data reference bar alongside the display window image. Basic color bar functions can be activated from the Display Window Widget by selecting:

Functions->Color Bar->On : Turn on color bar with defaults found in the setup.
Functions->Color Bar->Off : Turn off the color bar.
Functions->Color Bar->Setup : Bring up the color bar default setup widget.
Setups->Color Bar : Bring up the color bar default setup widget.

For all input items below, hitting return after modifying a field entry will cause all other affected fields to recalculate and will automatically redisplay the new color bar annotation values. The default values for the color bar are based upon the image scaling parameters used in displaying the image (open the Rescale Setup Widget to see the image scaling values used).

Action items:

Bar Orientation Vertical or Horizontal. Whether to append the color data reference bar horizontally or vertically to the display window widget. (The default is to set the bar in the longest dimension).

Label increment The label increment has two different meanings, depending on the display scale type of the image data. Hitting RETURN after entering a new label increment, will cause Label Values and Label Annotation to recalculate and will redraw new annotation on the color data reference bar.

Linear display scale case The data increment used in calculating Label Values. User-friendly label values will be generated. (e.g., for a data min/max range of [.01,3.0] and increment of 1.0, the label values generated will be [.01, 1.0, 2.0, 3.0], NOT [.01, 1.1, 2.1, 3.1])

Log display scale case The increment represents the factor applied to the powers of 10 which fall within the data range. (e.g., for data data min/max range of [.01,5.0] and increment of 2.0, the label values generated will be [.01, .02, .2, 2.0, 5.0])

Label Values The data values at which the annotation labels will be placed.

Label Format The data format used in coverting from Label Values to Label Annotation.

Label Annotation The label annotation strings to be placed at Label Values locations on the color bar. The label annotation is completely independent from the label values. They can be any string text values, i.e. Label Values can be [1.0,2.0,3.0,4.0] and Label Annotation can be ['Jan', 'Feb', 'Mar','Apr'].

Font

Font Type Informational. Either Hardware or Vector.

Select New Font Press this button to select a new font for your grid labels using the Plot Font Selection Widget.

Name Informational. Name of current hardware or vector font.

Size and Thickness Informational. Applies to vector fonts only. Specified when Select New Font.

Quit Delete the Color Bar Setup Widget. All current default values are retained.

Help Show on-line help in HTML viewer.

Curator: OceanColor Webmaster

Authorized by: gene carl feldman