Draws a spatial grid of line plots for an axis of a cube NDF CLINPLOT
This application will typically be used to display a grid of spectra taken from a cube in which the current WCS Frame includes one spectral axis (e.g. frequency) and two spatial axes (e.g. RA and Dec). For this reason the following documentation refers to the ‘spectral axis’ and the ‘spatial axes’. However, cubes containing other types of axes can also be displayed, and references to ‘spectral’ and ‘spatial’ axes should be interpreted appropriately.
A rectangular grid of NX by NY points (see Parameters NX and NY) is defined over the spatial extent of the cube, and a spectrum is drawn at each such point. If NX and NY equal the spatial dimensions of the cube (which is the default for spatial axes of fewer than 31 pixels), then one spectrum is drawn for every spatial pixel in the cube. For speed, the spectrum will be binned up so that the number of elements in the spectrum does not exceed the horizontal number of device pixels available for the line plot.
Annotated axes for the spatial co-ordinates may be drawn around the grid of line plots (see Parameter AXES). The appearance of these and the space they occupy may be controlled in detail (see Parameters STYLE and MARGIN).
The plot may take several different forms such as a "join-the-dots"
plot, a "staircase"
plot, a
"chain"
plot (see Parameter MODE). The plotting style (colour, founts, text size, etc.) may be specified
in detail using Parameter SPECSTYLE.
The data value at the top and bottom of each line plot can be specified using Parameters YBOT and YTOP. The defaults can be selected in several ways including percentiles (see Parameter LMODE).
The current picture is usually cleared before plotting the new picture, but Parameter CLEAR can be used to prevent this, allowing the plot (say) to be drawn over the top of a previously displayed grey-scale image.
The range and nature of the vertical and horizontal axes in each line plot can be displayed in a key to the right of the main plot (see Parameter KEY). Also, an option exists to add numerical labels to the first (i.e. bottom-left) line plot, see Parameter REFLABEL. However, due to the nature of the plot, the text used may often be too small to read.
TRUE
, each spectrum will be drawn in a rectangular cell that is
centred on the corresponding point on the sky. This may potentially cause the spectra to
overlap, depending on their spatial separation. If ALIGN is FALSE
, then the spectra are drawn
in a regular grid of equal-sized cells that cover the entire picture. This may cause them
to be drawn at spatial positions that do not correspond to their actual spatial positions
within the supplied cube. The dynamic default is TRUE
if Parameter CLEAR is TRUE
and
there is an existing DATA picture on the graphics device. []
TRUE
if labelled and annotated axes describing the spatial are to be drawn around the
outer edges of the plot. The appearance of the axes can be controlled using the STYLE
parameter. The dynamic default is to draw axes only if the CLEAR parameter indicates
that the graphics device is not being cleared. []
TRUE
then no tick marks or labels are placed on the edges of line plots that touch the
outer spatial axes (other edges that do not touch the outer axes will still be annotated).
This can avoid existing tick marks being over-written when drawing a grid of spectra
over the top of a picture that includes annotated axes. The dynamic default is TRUE
if and
only if the graphics device is not being cleared (i.e. Parameter CLEAR is FALSE
) and no
spatial axes are being drawn (i.e. Parameter AXES is FALSE
). []
TRUE
the current picture is cleared before the plot is drawn. If FALSE
, then the
display is left uncleared and an attempt is made to align the spatial axes of the new plot
with any spatial axes of the existing plot. Thus, for instance, a while light image may be
displayed using DISPLAY, and then spectra drawn over the top of the image using this
application. [TRUE]
"Data"
, "Quality"
, "Variance"
, or "Error"
(where "Error"
is an alternative to
"Variance"
and causes the square root of the variance values to be displayed). If "Quality"
is
specified, then the quality values are treated as numerical values (in the range 0 to 255).
["Data"]
[
Current graphics device]
TRUE
,
then the display will be ‘stretched’ to fill the current picture in both directions. This can be
useful to elongate the spectra to reveal more detail by using more of the display surface
at the cost of different spatial scales, and when the spatial axes have markedly different
dimensions. The dynamic default is TRUE
if either of the spatial dimensions is one. and
FALSE
otherwise. []
TRUE
, then a ‘key’ will be drawn to the
right of the plot. The key will include information about the vertical and horizontal axes
of the line plots, including the maximum and minimum value covered by the axis and
the quantity represented by the axis. The appearance of this key can be controlled using
Parameter KEYSTYLE, and its position can be controlled using Parameter KEYPOS. [TRUE]
[
current value]
A comma-separated list of strings should be given in which each string is either
an attribute setting, or the name of a text file preceded by an up-arrow character
""
.
Such text files should contain further comma-separated lists which will be read and interpreted in the
same manner. Attribute settings are applied in the order in which they occur within the list, with later
settings overriding any earlier settings given for the same attribute.
Each individual attribute setting should be of the form:
name=value
where name
is the name of a plotting attribute, and
value
is the value to assign to the attribute. Default values will be used for any unspecified attributes. All
attributes will be defaulted if a null value (!
)—the initial default—is supplied. To apply changes of
style to only the current invocation, begin these attributes with a plus sign. A mixture of persistent
and temporary style changes is achieved by listing all the persistent attributes followed by a plus sign
then the list of temporary attributes.
See Section E for a description of the available attributes. Any unrecognised attributes are ignored (no error is reported).
The appearance of the text in the key can be changed by setting new values for the attributes
Colour(Strings), Font(Strings) etc. [
current value]
"Range"
— The minimum and maximum data values in the supplied cube are used as the defaults for
YBOT and YTOP. No other sub-strings are needed by this option.
"Extended"
— The minimum and maximum data values in the cube are extended by percentages of
the data range, specified by the second and third sub-strings. For instance, if the value "Ex,10,5"
is
supplied, then the default for YBOT is set to the minimum data value minus 10% of the data range,
and the default for YTOP is set to the maximum data value plus 5% of the data range. If only one
value is supplied, the second value defaults to the supplied value. If no values are supplied, both
values default to "2.5"
.
"Percentile"
— The default values for YBOT and YTOP are set to the specified percentiles of the data
in the supplied cube. For instance, if the value "Per,10,99"
is supplied, then the default for YBOT is
set so that the lowest 10% of the plotted points are off the bottom of the plot, and the default for
YTOP is set so that the highest 1% of the points are off the top of the plot. If only one value,
, is supplied, the
second value, ,
defaults to .
If no values are supplied, the values default to "5,95"
.
"Sigma"
— The default values for YBOT and YTOP are set to the specified numbers of standard
deviations below and above the mean of the data. For instance, if the value "sig,1.5,3.0"
is
supplied, then the default for YBOT is set to the mean of the data minus 1.5 standard deviations, and
the default for YTOP is set to the mean plus 3 standard deviations. If only one value is supplied,
the second value defaults to the supplied value. If no values are provided both default to
"3.0"
.
The method name can be abbreviated to a single character, and is case insensitive. The initial
value is "Range"
. [
current value]
!
) value is supplied, the value used is (for all edges); 0.15
if annotated axes are being
produced; and 0.0
otherwise. The initial default is null. [
current value]
"Chain"
or
"Mark"
. It specifies the symbol with which each position should be marked, and should be
given as an integer PGPLOT marker type. For instance, 0
gives a box, 1
gives a dot, 2
gives
a cross, 3
gives an asterisk, 7
gives a triangle. The value must be larger than or equal to
31.
[
current value]
"Histogram"
— An histogram of the points is plotted in the style of a ‘staircase’ (with vertical lines
only joining the y-axis values and not extending to the base of the plot). The vertical lines are placed
midway between adjacent x-axis positions. Bad values are flanked by vertical lines to the lower edge
of the plot.
"GapHistogram"
— The same as the "Histogram"
option except bad values are not flanked by vertical
lines to the lower edge of the plot, leaving a gap.
"Line"
— The points are joined by straight lines.
"Point"
— A dot is plotted at each point.
"Mark"
— Each point is marker with a symbol specified by Parameter MARKER.
"Chain"
— A combination of "Line"
and "Mark"
.
The initial default is "Line"
. [
current value]
[]
[]
TRUE
then the first line plot (i.e. the lower-left
spectrum) will be annotated with numerical and textual labels describing the two axes.
Note, due to the small size of the line plot, such text may be too small to read on some
graphics devices. [
current value]
TRUE
if axes are to
be drawn around each spectrum. The appearance of the axes can be controlled using the
SPECSTYLE parameter. [TRUE]
A comma-separated list of strings should be given in which each string is either
an attribute setting, or the name of a text file preceded by an up-arrow character
""
.
Such text files should contain further comma-separated lists which will be read and interpreted in the
same manner. Attribute settings are applied in the order in which they occur within the list, with later
settings overriding any earlier settings given for the same attribute.
Each individual attribute setting should be of the form:
name=value
where name
is the name of a plotting attribute, and
value
is the value to assign to the attribute. Default values will be used for any unspecified attributes. All
attributes will be defaulted if a null value (!
)—the initial default—is supplied. To apply changes of
style to only the current invocation, begin these attributes with a plus sign. A mixture of persistent
and temporary style changes is achieved by listing all the persistent attributes followed by a plus sign
then the list of temporary attributes.
See Section E for a description of the available attributes. Any unrecognised attributes are ignored (no error is reported).
By default the axes have interior tick marks, and are without labels and a title to avoid overprinting on adjacent plots.
The appearance of the data values is controlled by the attributes Colour(Curves), Width(Curves), etc. (the
synonym Lines may be used in place of Curves). [
current value]
A comma-separated list of strings should be given in which each string is either
an attribute setting, or the name of a text file preceded by an up-arrow character
""
.
Such text files should contain further comma-separated lists which will be read and interpreted in the
same manner. Attribute settings are applied in the order in which they occur within the list, with later
settings overriding any earlier settings given for the same attribute.
Each individual attribute setting should be of the form:
name=value
where name
is the name of a plotting attribute, and
value
is the value to assign to the attribute. Default values will be used for any unspecified attributes. All
attributes will be defaulted if a null value (!
)—the initial default—is supplied. To apply changes of
style to only the current invocation, begin these attributes with a plus sign. A mixture of persistent
and temporary style changes is achieved by listing all the persistent attributes followed by a plus sign
then the list of temporary attributes.
See Section E for a description of the available attributes. Any unrecognised attributes are ignored (no
error is reported). [
current value]
Its integer index within the current Frame of the NDF (in the range 1 to 3 in the current frame).
Its Symbol string such as "RA"
or "VRAD"
.
A generic option where "SPEC"
requests the spectral axis, "TIME"
selects the time axis, "SKYLON"
and
"SKYLAT"
picks the sky longitude and latitude axes respectively. Only those axis domains present are
available as options.
A list of acceptable values is displayed if an illegal value is supplied. The dynamic default is the index
of any spectral axis found in the current Frame of the NDF. []
[]
[]
pgplot.ps
) which can be printed on a PostScript printer and the data are plotted in histogram
form. "Ne Arc
variance"
. No labels are drawn around the lower-left line plot. If no Title is specified via the STYLE parameter, then the TITLE component in the NDF is used as the default title for the annotated axes. Should the NDF not have a TITLE component, then the default title is instead taken from current co-ordinate Frame in the NDF, unless this attribute has not been set explicitly, whereupon the name of the NDF is used as the default title.
If all the data values at a spatial position are bad, no line plot is drawn at that location.
The application stores a number of pictures in the graphics database in the following order: a FRAME picture containing the annotated axes, data plots, and optional key; a KEY picture to store the key if present; and a DATA picture containing just the data plots. The world co-ordinates in the DATA picture will correspond to the offset along a spectrum on the horizontal axis, data value on the vertical axis, and the two spatial co-ordinates for that spectrum. On exit the current database picture for the chosen device reverts to the input picture.
This routine correctly processes the AXIS, DATA, QUALITY, VARIANCE, LABEL, TITLE, WCS, and UNITS components of the input NDF.
Processing of bad pixels and automatic quality masking are supported.