Seadisp Gridline Function: Program-level Documentation

Seadisp Gridline Function (grid)

Description:Add graphic gridlines and/or grid labels to the specified or current seadisp window.

[Interactive Mode][Command Mode]

Command Mode :

Usage:grid, fbuf=fbuf, merge_mode=merge_mode, no_grid=no_grid, grdcol=grdcol, glinestyle=glinestyle, glinethick=glinethick, latdel=latdel, londel=londel, latsamp=latsamp, lonsamp=lonsamp, label=label, lblcol=lblcol, latlab=latlab, lonlab=lonlab, latalign=latalign, lonalign=lonalign, fonttype=fonttype, fontname=fontname, charsize=charsize, charthick=charthick

General keywords:

fbuf Seadisp window number (default is current window).

merge_mode 0 = replace all current bitmap graphics with this grid
1 = overlay on top of any existing bitmap graphics (Default)
2 = underlay grid under any existing bitmap graphics
3 = erase all bitmap graphics, redraw coastline and overlay this grid

Gridline keywords:

For all navigable file types

no_grid 0 = gridlines on (Default)
Non-zero = gridlines off

grdcol gridline color (1 to 7 SeaDAS graphics colors). (Default=1)

glinestyle 0 = solid (Default)
1=dotted
2=dashes
3=dash-dot
4=dash 3 dot
5=long dashes

glinethick Line thickness. 1 to 10. (Default=1)

latdel Spacing in degrees between latitude grid lines. (Default is calculated).

londel Spacing in degrees between longitude grid lines. (Default is calculated).

For non-IDL mapped file types

latsamp The sampling rate at which to draw the latitude grid lines. (Default=1)

lonsamp The sampling rate at which to draw the longitude grid lines. (Default=1)

Grid Label Keywords:

label 0 = labels off
Non-zero= labels on (Default=1)

lblcol Label color (1 to 7 SeaDAS graphics colors). (Default=1)

latlab Longitude at which to place the latitude labels.

lonlab Latitude at which to place the longitude labels.

latalign Text alignment of the latitude labels: 0.0=left justify, 0.5=center, 1.0=right justify.

lonalign Text alignment of the longitude labels: 0.0=left justify, 0.5=center, 1.0=right justify.

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=1.0)

charthick Specify character thickness for vector font only (Default=1)

Interactive Mode:

Description: The Gridline Setup Widget provides an interface for the gridline options. Selecting Setups->Gridlines within the Seadisp Display Window Widget will bring up the Gridline Setup Widget. Some of the defaults (such as gridline spacing) are set on an image-by-image basis. You do not need to use the setup widget in order to overlay default gridlines. Simply select Functions->Grid.

Action items:

Grid Line Options:

Draw Grid Lines A toggle specifying whether or not to put on gridlines at all. (i.e., just the labels could be put on)

Grid Color The graphics color of the grid lines.

Mod Bring up the widget to allow modification of the graphics color hues. Once modified, the changes will apply to all currently displayed images.

Latitude Grid The increment in degrees for your latitude gridlines.

Longitude Grid The increment in degrees for your longitude gridlines.

Samples Per Grid The number of points to fix between latitude and longitude gridlines, in order to draw the gridlines. This option is useful for input data which are geographically warped. (Default=0). (This option is available for all navigable files except SeaDAS mapped files.)

Reset Default Reset the default increments to the originally calculated defaults.

Line Thickness The line thickness of the grid lines.

Line Style The line style of the grid lines (solid, dots, dashes, dash-dot, dash 3 dots, long dash)

Label Grid Lines

A toggle specifying whether or not to put on grid labels at all (ie, just the grid lines can be put on).

Label Color

The graphics color to be used for the labels. Click on the color graphics bar to select a new color.

Mod

Bring up the widget to allow modification of the graphics color hues. Once modified, the changes will apply to all currently displayed images.

Latitude Labels

The latitude at which the longitude labels will be placed.

Longitude Labels

The longitude at which the latitude labels will be placed.

Text Alignment

The alignment of the grid labels text with respect to the grid line coordinates: Left justified, Centered, or Right Justified

Reset Default

Reset position of Latitude and Longitude labels.

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.

Apply Mode

Replace Graphics	Replace all existing graphics in the display window with the gridlines
Overlay	Overlay the gridline graphics on top of any existing graphics in the window.
Underlay	Place the gridline graphics on top of the image, but underneath all other graphics in the window.
Redraw Coast/Grid	Redraw the coastline and gridlines using the current settings.

Apply the gridline graphics to the current window, using the options above.

Help

Show this help file in local HTML viewer.

Quit

Exit the Gridline Setup Widget. All settings will be retained the next time the Gridline Setup Widget is opened.

Curator: OceanColor Webmaster

Authorized by: gene carl feldman

fbuf	Seadisp window number (default is current window).
merge_mode	0 = replace all current bitmap graphics with this grid 1 = overlay on top of any existing bitmap graphics (Default) 2 = underlay grid under any existing bitmap graphics 3 = erase all bitmap graphics, redraw coastline and overlay this grid

Draw Grid Lines	A toggle specifying whether or not to put on gridlines at all. (i.e., just the labels could be put on)
Grid Color	The graphics color of the grid lines.
Mod	Bring up the widget to allow modification of the graphics color hues. Once modified, the changes will apply to all currently displayed images.
Latitude Grid	The increment in degrees for your latitude gridlines.
Longitude Grid	The increment in degrees for your longitude gridlines.
Samples Per Grid	The number of points to fix between latitude and longitude gridlines, in order to draw the gridlines. This option is useful for input data which are geographically warped. (Default=0). (This option is available for all navigable files except SeaDAS mapped files.)
Reset Default	Reset the default increments to the originally calculated defaults.
Line Thickness	The line thickness of the grid lines.
Line Style	The line style of the grid lines (solid, dots, dashes, dash-dot, dash 3 dots, long dash)