KPG1_LUTKY

Draws a key showing a colour table

Description:

The key consists of a ramp of colour covering the specified range of colour indices, with annotated axes. Axis 1 is always the data-value axis (whether it is drawn vertically or horizontally). The whole plot (including annotation) is scaled to fit inside the picture specified by IPIC.

Invocation

CALL KPG1_LUTKY( IPIC, PARAM, HIGH, LOW, LABEL, APP, LP, UP, F, GAP1, GAP2, JUST, RJUST, NEL, COLDAT, STATUS )

Arguments

IPIC = INTEGER (Given)
An AGI identifier for a picture in which the key is to be produced.
PARAM = CHARACTER ∗ ( ∗ ) (Given)
The name of the style parameter to use (e.g. STYLE, KEYSTYLE, etc.).
HIGH = REAL (Given)
The X-axis value (i.e. pixel value or pen number) corresponding to the colour index UP.
LOW = REAL (Given)
The X-axis value (i.e. pixel value or pen number) corresponding to the colour index LP.
LABEL = CHARACTER ∗ ( ∗ ) (Given)
The default label to put against the data values.
APP = CHARACTER ∗ ( ∗ ) (Given)
The calling application, in the form " KAPPA_LUTVIEW" .
LP = INTEGER (Given)
The smallest colour index to include in the display.
UP = INTEGER (Given)
The largest colour index to include in the display.
F = REAL (Given)
An amount by which to extend the margins left for annotation, expressed as a factor of the height or width of the plotting area. For instance, a value of 0.1 could be given to fit the annotation " comfortably" into the Plot. A value of 0.0 will result in the annotation being hard up against the edge of the plot.
GAP1 = REAL (Given)
A gap, in millimetres, to place between the bottom or right edge of the supplied picture, and the nearest edge of the colour ramp.
GAP2 = REAL (Given)
A gap, in millimetres, to place between the top or left edge of the supplied picture, and the nearest edge of the colour ramp.
JUST = CHARACTER∗2 (Given)
Indicates the justification of the new plot within the specified area. ’ BL’ , ’ BC’ , ’ BR’ , ’ CL’ , ’ CC’ , ’ CR’ , ’ TL’ , ’ TC’ or ’ TR’ , where B is Bottom, C is Centre, T is Top, L is Left and R is Right. Must be upper case. If either character is a space, then the corresponding value from RJUST is used instead. Other unrecognised values are treated as " C" .
RJUST( 2 ) = REAL (Given)
Each element is used only if the corresponding element in JUST is a apce. The first element gives the fractional vertical position of the new plot: 0.0 means put the new plot as low as possible, 1.0 means put it as high as possible. The second element gives the fractional horizontal position of the new plot: 0.0 means put the new plot as far to the left as possible, 1.0 means put it as far to the right as possible.
NEL = INTEGER (Given)
The size of the vector COLDAT. If this is zero, COLDAT is not accessed, and requested for keys in the form of a histogram are ignored (that is, keys are always produced in the form of a ramp).
COLDAT( NEL ) = INTEGER (Given)
A vector of colour indices, one for each displayed data pixel. Only accessed if NEL is greater than zero and the STYLE parameter indicates that the key is to drawn in the form of a histogram.
STATUS = INTEGER (Given and Returned)
The global status.