FRMLABEL

Displays an image label on a frame.

Format

FRMLABEL [keywords] "text

Parameters

"text	text to display on the frame's image label; all text is displayed in uppercase; 250 characters maximum; the following placeholders can be specified for text substitution of information from the frame, dataset or displayed image; the output format is indicated in italics, e.g., nnn
	(FRAME)	frame number, nnn
	(DATASET)	ADDE dataset name, 24 characters maximum
	(POS)	ADDE dataset position, nnnn
	(BAND)	band number, nn
	(WL)	wavelength, nn.nn unit
	(WN)	wave number, nn.nn unit
	(FREQ)	frequency, nn.nn unit
	(ID)	NEXRAD station ID, 3 characters
	(MEMO)	memo field, 32 characters maximum
	(SS)	sensor source number, nnn
	(STYPE)	text description in SATANNOT file for the image's sensor source number, 12 characters maximum
	(ERES)	element resolution, nn.nn
	(LRES)	line resolution, nn.nn
	(RES)	displayed resolution of the image, nn.nn
	(EGEORES)	geographical element resolution in km, n.nn; see the Remarks
	(LGEORES)	geographical line resolution in km, n.nn; see the Remarks
	(GEORES)	geographical resolution in km, (n.nn X n.nn KM); see the Remarks
	(DAY)	day, dd mon yy
	(MDY)	day, mon dd yy
	(JDAY)	Julian day, ccyyddd
	(TIME)	image time, hhmmss
	(HH)	image time, hh
	(HHMM)	image time, hh:mm
	(HHMMSS)	image time, hh:mm:ss

Keywords

CRAwl=	FOREVER	crawls the text across the frame continuously until stopped with Alt Q
	N num	number of times the entire text string crawls across the frame; the range is 0 to 100 (default=10); when completed, the text is repositioned to the location specified with keyword JUST
	T sec	number of seconds the text crawls across the frame; the range is 0 to 600 (default=120); when the specified number of seconds expires, the text is repositioned to the location specified with keyword JUST
IMA=	image frame number (default=current)
JUSt=	C	centers the text on the frame (default)
	L	left justifies the text on the frame
	R	right justifies the text on the frame
LEVel=	text bg	brightness level for the text and background (default=255 0)
LINe=	starting frame line (default=12 lines from bottom of frame)
NLIne=	number of lines blanked out for text (default=12)

Remarks

The image label is not a graphic; it is written to the image plane of the frame. The EG command will not erase the label. You must reload the image to erase the image label.

Each character is eight pixels square with a 1-pixel separation. Thus, the maximum number of characters you can display on a frame is the number of elements divided by nine.

The following five characters are not part of FRMLABEL's character set and are thus displayed as a blank (like a space character): tilde ( ~ ), grave accent ( ` ), exclamation point ( ! ), left square bracket ( [ ), right square bracket ( ] ). Also, the left and right curly brackets ( { and } ) are displayed as left and right square brackets ( [ and ] ).

If you specify keyword CRAWL, the text moves slowly across the screen from right to left. The crawl continues even if a new image is loaded onto the frame. Press Alt Q to end the text crawl and reposition the text to the location specified in keyword JUST.

The (GEORES), (LGEORES) and (EGEORES) placeholders can be used only if GEORES=YES was specified in the IMGDISP command that displayed the image. The resolution values, listed as n.nn in the Parameters section above, are in kilometers and are displayed in the format 0.nn, n.nn, nn.n or nnn (depending on the magnitude of the resolution). The two resolution values displayed with the (GEORES) placeholder are the same as (LGEORES) and (EGEORES), in that order.

Examples

FRMLABEL "GOES-9 INFRARED IMAGE

This entry displays an image label with the text GOES-9 INFRARED IMAGE on the bottom 12 lines of the frame.

FRMLABEL LINE=1 CRAWL=FOREVER "SEVERE THUNDERSTORM WARNING FOR DANE COUNTY

This entry displays an image label with the specified text on the top 12 lines of the frame. The text continuously crawls across the frame from right to left until Alt Q is pressed.

FRMLABEL JUST=L "GOES-8 BAND (BAND) FROM (DAY) AT (HHMM) UTC

This entry displays an image label with the specified text left justified on the bottom 12 lines of the frame. The placeholders (BAND), (DAY) and (HHMM) are replaced with the corresponding values from the displayed image.

FRMLABEL LINE=22 LEVEL=0 255 "IMAGE FROM DATASET (DATASET), POSITION (POS)

This entry displays an image label with the specified text in black (brightness level 0) with a white (brightness level 255) background beginning at line 22. The placeholders (DATASET) and (POS) are replaced with the corresponding values from the displayed image.

FRMLABEL LEVEL=232 2 "(ID) RADAR - BASE REFLECTIVITY TILT 1 AT (HHMM) ON (DAY)

This entry is very similar to the FRMLABEL command in the MKX_BREF1 predefined image product in the IMGDISP.CORE file. The product displays a NEXRAD Base Reflectivity image and uses this FRMLABEL command to display an image label with the (ID), (HHMM) and (DAY) placeholders replaced by the NEXRAD station ID, time and date of the displayed image.

[Search Manual] [Table of Contents] [Go to Previous] [Go to Next]