GEOMETRY commands
PROGRAM NAME
gcmaplegend - Construct Geometry Representing a Color Legend
DESCRIPTION
gcmaplegend
is used to contruct geometry representing a color legend showing the
colors contained in a
visualization colormap.
The length and thickness of the
legend can be controlled, along with its 2d position in space. The
legend can be oriented either vertically or horizontally. An outline
around the distinct colors in the legend may be optionally included.
The colors in the legend can be reversed. Optionally, text labels
may be generated to indicate values associated with particular
colors. An optional legend title may be specified.
REQUIRED ARGUMENTS
- -i
-
type: infile
desc: input vis colormap
- -o
-
type: outfile
desc: output geometry object
OPTIONAL ARGUMENTS
- -name
-
type: string
desc: color legend
default: color legend
- -orient
-
type: integer toggle
desc: legend orientation
default: 1
allowed values:
- 1 (Horizontal),
- or 2 (Vertical)
- -reverse
-
type: boolean
desc: reverse colors?
default: false
- -outline
-
type: boolean
desc: make outline?
default: true
- -length
-
type: float
desc: length of legend
default: 1
bounds: 0 < [-length] < 2
- -thickness
-
type: float
desc: thickness of legend
default: 0.05
bounds: 0 < [-thickness] < 0.25
- -xpos
-
type: float
desc: x position
default: -0.85
bounds: -1 < [-xpos] < 1
- -ypos
-
type: float
desc: y position
default: -0.5
bounds: -1 < [-ypos] < 1
- -do_text_labels
-
type: boolean
desc: Boolean value indicating whether or not text labels will be drawn.
default: true
- -num_labels
-
type: integer
desc: Number of subdivisions along color legend for text labels.
default: 2
bounds: value >= 0
- -sprintf_format
-
type: string
desc: C-style formatting string. No error checking is perfomed. Use %g for most stuff.
default: %g
- -text_offset
-
type: float
desc: Offset of text in either the horizontal or vertical dimension, depending upon the orientation of the legend.
default: 0.1
bounds: no range checking
- -do_title
-
type: boolean
desc: Boolean indicating whether or not to generate a title to go along with the legend.
default: false
- -title_string
-
type: string
desc: The text for the title.
default: I am a title.
- -title_x_offset
-
type: float
desc: X-Offset of title relative to the origin of the legend.
default: 0
bounds: no range checking
- -title_y_offset
-
type: float
desc: Y-offset of title relative to legend origin.
default: 0
bounds: no range checking
- -title_font_size
-
type: list
desc: Choices for point size for the title.
default: 4 "18 point"
- -title_font_family
-
type: list
desc: List of available font families. Based upon those commonly available on X servers. This works reliably only in the software renderer.
default: 1 "Times"
EXAMPLES
SEE ALSO
ggencmap
RESTRICTIONS
REFERENCES
COPYRIGHT
Copyright (C) 1996,1997 , The Regents of the University of California. All rights reserved.