next up previous 98
Next: The order of play
Up: The ORAC-DR Display System
Previous: How to change the disp.dat file


How the pipeline displays

The disp.dat file has a series of entries consisting of a line each. Each line has a series of space-separated items. All but the first item, the suffix, use the keyword=value syntax.

These items are:

suffix

A file suffix representing a particular step of the data reduction process as designated by that instrument's file naming convention. For example, for UFTI data ``dk'' states what to do with a file called f19990330_00042_dk.sdf. Many entries may be made for a particular suffix. The following special conventions are used: NUM describes a file ending in just an observation number (usually representing raw data). For instruments that have multiple data arrays in a single data frame, S2$<$suffix$>$ (e.g. S2dk) represents the second data array in the frame with the _dk suffix.

tool

A display tool such as Gaia or KAPVIEW (the latter being a collective term for various KAPPA display tasks). The tools available are determined by the display type (q.v.) selected.

type

A display type such as graph, image, contour etc. These vary according to the tool selected. The following types are available. The tools which support the given display type are listed in parentheses.

contour (KAPVIEW)

Plots a contour plot.

datamodel (KAPVIEW)

Displays data (as points) with a model overlaid.

graph (KAPVIEW, P4)

Plots a line graph such as a spectrum.

histogram (KAPVIEW)

Plots a line graph such as a spectrum.

image (GAIA, KAPVIEW,
P4)

Displays an image.

sigma (KAPVIEW)

Draws a scatter plot with a Y range of +/- N standard deviations.

vector (KAPVIEW)

Displays an image and vectors (e.g. polarimetry data).

region

For device tools that support it, region addresses the parts of a window where a display ends up. For KAPVIEW, these are: whole screen (0), top left quarter (1), top-right quarter (2), bottom-left quarter (3), bottom-right quarter (4), left half (5), left right (6), top half (7), bottom half (8). Defaults to 0.

window

The number of the window in which the display is to go. The value of this is simply an identifier and does not presuppose order. If you ask for an image display to go to window 2 and you have configured no displays to go to windows 0 and 1 then you will only get one window on your screen. If you then configure a histogram display to go to window 2 it will go to the same window whereas if you configure it to go to window 1 (or 5 or 9 or anything else besides 2) it will end up in its own window. Note that no windows are launched until they are required.

xautoscale

Specifies whether or not to use a section of the data frame. If set to 1, meaning true, the whole X axis is used. If set to 0, the pixel limits are specified by keywords xmin and xmax. The default is 1.

There are corresponding autoscaling keywords for higher dimensions named yautoscale, 3autoscale, 4autoscale etc.

xmin, xmax

The X-axis pixel limits of the data to be displayed when xautoscale=1. xmin should be less than or equal to xmax. There are corresponding pixel-range keywords for higher dimensions: ymin and ymax, 3min and 3max, 4min and 4max etc. when autoscaling on the corresponding axis is disabled.

zautoscale

Set to 1 meaning true, this scales this requests that the data are scaled automatically between the data range. In the case of images on GAIA the cut is at the 95 percentile. When zautoscale is 0, the scaling is between the limits defined by keywords zmin and zmax. Defaults to 1 if absent.

zmin, zmax

When zautoscale is 1, these specifiy the lower and higher scaling limits for the data values.

cut

If the number of dimensions in the data file is greater than that requested, sections in higher dimensions are set to 1 by compressing the undesired dimension(s). Option cut specifies the desired dimension(s).

Option cut is a comma-separated list specifying the dimensionality and axes to retain. The number of entries should equal the dimensionality needed by the type of plot. For instance, a graph only one value is required since a graph is 1-D. The allowed values are X, Y, 3, 4, or 5. If the number of dimensions in the data file is fewer than that requested, ORAC-DR prints a warning message.

Here are two examples, a graph can be displayed from a 2-dimensional image by displaying a cut in the X direction (averaging over the Ys) by setting cut=X. A `white-light' contour plot of a x,y,wavelength spectral data cube may be plotted using cut=X,Y.

There are also parameters special to particular types of display, which also use the keyword=value syntax. These are:

angrot

The angle to add to all vectors in a type=vector plot.

comp

The array component to display. Allowed values are Data, Variance, or Error. The default is Data. This applies to type=contour, datamodel, graph, histogram, image, or sigma displays.

dashed

The location of the dashed lines for a type=sigma display in standard deviaiton units. This defaults to 3.

errbar

If set to 1 (true), error bars are plotted on a type=graph display, provided there is variance information present. The default is 0, meaning do not plot error bars.

multivector

This controls the appearance of vectors in a type=vector plot. If set to 0 (false), the default, the vectors are white and have thickness 1. If set to 1 (true), the vectors are yellow with a blue trim and have thickness three.

nbins

This is the number of bins to be used for histogram calculation for type=histogram. It defaults to 20.

ncont

This specifies the number of contours to plot for type=contour. It defaults to 6 if a non-positive value is supplied.

range

The standard-deviation range for a type=sigma display. This defaults to 5.

key

If set to 1 (true), a colour table key is drawn alongside the displayed image. The default is 0, meaning no colour table key is drawn.



next up previous 98
Next: The order of play
Up: The ORAC-DR Display System
Previous: How to change the disp.dat file

ORAC-DR: Overview and General Introduction
Starlink User Note 230
Frossie Economou, Tim Jenness,
Malcolm Currie, Andy Adamson, Alasdair Allan, Brad Cavanagh
Joint Astronomy Centre, Hilo, Hawaii
June 2004
E-mail:starlink@jiscmail.ac.uk

Copyright © 1997-2004 Particle Physics and Astronomy Research Council