BAR

Draws a grayscale bar on a frame containing an image.

Format

BAR frame [keywords]

Parameter

frame

frame number (default= current frame)

Keywords

ANNot=	NO		do not write text annotation, only the bar and label (default)
	YES justify line ele color size "text writes text annotation on frame, where:
		justify	justification of text; specify L, R or C, where L=left, R=right, C=center (default=C)
		line	beginning TV line to write text (default=7 on a 480x640 frame; def=computed on other sizes)
		ele	beginning TV element to write text (default=320 on a 480x640 frame; default=computed on other sizes)
		color	graphics color level of text (default=3)
		size	pixel size of text (default=11 on a 480x640 frame; default=computed on other sizes)
		"text	annotation text (default=memo field from IMGLIST FORM=ALL; if the image also has an INFO AUX block, like NEXRAD precip images, it is written below the memo field text)
BORder=	outer inner		grayscale value for outer and inner borders (default=255 0; use BOR= -1 to turn off all borders)
COLor=	graphics color level for bar labels (default=3)
GRA=	graphics frame to display labels (default=current if running McIDAS-X with independent graphics; otherwise, number specified in the frame parameter)
LINt=	label interval; must be a value greater than zero (default=computed)
LSIze=	height of labels (default=computed)
ORIent=	VER		bar is displayed vertically (default)
	HOR		bar is displayed horizontally
POSition=	line ele short long user-specified location and size (default)
		line	starting TV line (default=computed)
		ele	starting TV element (default=computed)
		short	length in pixels of the bar's short axis (default=computed)
		long	length in pixels of the bar's long axis (default=computed)
	CUR		draws a bar the size of the cursor at its current location
RANge=	min max		range of values to display (default=computed)
SU=	stretch table name to apply to the grayscale bar; see the Remarks (default=table specified in the IMGDISP command)
WIDth=	graphics line width, in pixels; maximum is 64 (default=current GD setting)

Remarks

The BAR command displays a grayscale bar and labels. The bar is written to the image so an enhancement created with commands EU or EB appears on the bar. Because the labels are written as graphics, the EG command erases the labels but not the bar. The frame parameter specifies the frame to write the bar, and the GRA keyword specifies the frame to write the labels.

The POSITION keyword determines the location of the bar. If you do not use this keyword, the bar is drawn in a vertical orientation along the right side of the frame. If you use the POS=line ele short long format, line and ele define the TV line and element of the upper-left corner of the bar, and short and long define the dimensions of the bar. If you use ORIENT=VER, short is the horizontal length and long is the vertical length. If you use ORIENT=HOR, short is the vertical length and long is the horizontal length.

If the image was displayed with a stretch table (for example, using IMGDISP with the SU keyword), BAR's SU and RANGE keywords are ignored. If the image has an auxiliary block (for example, NEXRAD Level III radar images), the RANGE keyword is ignored and the LINT keyword is valid only if the image was displayed with a stretch table.

The following three rules determine the units of the labels.

If the image was displayed with a stretch table, the label units are the same as the calibration units of the stretch table.
If the image has an auxiliary block and was not displayed with a stretch table, the label units are the same as the units in the auxiliary block.
If the image was not displayed with a stretch table and does not have an auxiliary block, the units are the same as the calibration units of the stretch table specified in the BAR command's SU keyword. If SU is not specified, the units are brightness values.

Examples

BAR

This entry displays a vertical grayscale bar and graphics labels along the right side of the current frame.

BAR ORIENT=HOR LINT=15 LSIZE=6 COLOR=5

This entry displays a horizontal grayscale bar and graphics labels along the bottom of the current frame. The labels are drawn every 15 brightness levels along the bar in graphics color level 5 with a character height of six pixels.

BAR POS=CUR

This entry displays a grayscale bar that fills the cursor at its current location. The dimensions of the cursor determine the orientation of the bar and labels. If the cursor is square or is longer in the vertical direction than in the horizontal direction, the bar and labels are oriented vertically. If the cursor is longer in the horizontal direction than in the vertical direction, the bar and labels are oriented horizontally.

BAR POS=20 20 10 600 ORIENT=HOR SU=QVISRB RANGE=180 330 LINT=15

This entry displays a horizontal grayscale bar and graphics labels along the top of the current frame. The bar, which displays only values between 180 and 330, is 10 pixels high, 600 pixels long, and starts at TV line 20, element 20. The labels appear every 15 values along the bar in units matching the calibration units of the stretch table QVISRB.

BAR ANNOT=YES L 445 5 2 8

This entry displays a vertical grayscale bar and graphics in the default location (along the right side of the frame) and displays the memo field of the currently displayed image in graphics color level 2 with a character height of eight pixels beginning at TV line 445, element 5. If the image also has an INFO AUX block (like NEXRAD precipitation images), it is displayed below the memo field. The memo field can be listed by specifying FORM=ALL with the IMGLIST command.