So the facilities summarised in the introduction sound appealing. Now you want to know how to access them, but the thick manual looks daunting. Actually, most of this manual comprises descriptions of each application. The best way to learn the basics is to try some example sessions.
Login to a colour workstation or X-terminal. Then enter the commands following the prompts shown
% is the shell prompt string, which you don’t type. As we go along there will be
commentary explaining what is happening and why. Let’s begin.
This defines C-shell aliases for each Kappa command, includes the help information, and shows the version number. It need only be issued once per login session. Thus you will see
Let’s run a Kappa application. CADD adds a scalar constant to an NDF file—the Starlink
standard data format—to make a new NDF file (usually called an NDF for short). In this case
ten is added to the pixels in
$KAPPA_DIR/comwest.sdf to create
test.sdf in the current
There are three parameters qualifying the CADD command: the names of the input and output NDFs
and the constant. Notice that these parameters are separated by spaces. Most applications have a few
of these positional parameters, usually the most commonly used. Parameters given on the command
line are not subsequently prompted for by the application. Also you see that the NDF file extensions
are not given. The
.sdf extension indicates that it was created by the Hierarchical Data
System (SUN/92), or HDS for short. Note that an arbitrary
.sdf file is not necessarily an
Next we run the statistics task. Here we have not given any parameters. In this case the application will ask for the values of any parameters it needs.
The only parameter required is called NDF, and STATS prompts us for it.
In this example, STATS wants to know for which NDF we require statistical data. The
text between the
// delimiters is the suggested default for the parameter. By pressing the
carriage return we accept this default as the parameter’s value. Here the suggested default is
the name of the NDF created by CADD. (Ignore the
@ for the moment—it just tells the
application that it is a file.) Kappa remembers the last NDF used or created, and uses it
for the suggested default to save typing. Since
test is the NDF whose statistics we want
we just hit the return key. Again we exclude the
.sdf extension. Here is the output from
Of course, in your case the current directory will not be
/home/scratch/mjc. The NDF title is the
unchanged from the
$KAPPA_DIR/comwest NDF. This is the normal behaviour for tasks that create a new
NDF from an old one; they do, however, have a parameter for changing this default. To alter a
defaulted parameter you supply its new value on the command line. Defaulted parameters exist to
prevent a long series of prompts where reasonable values can be defined, and hence save time.
(However, there is a way of being prompted for all parameters of a command should you
NDFs may contain three standard arrays—the data array, the data variance and quality. STATS can calculate statistics for any of these. By default, STATS uses the data array, as indicated here.
Next we wish to smooth our data. GAUSMOOTH performs a Gaussian smooth of neighbouring pixels.
Again we are prompted with the same suggested default, since we have not created any new NDFs
within STATS. Say we don’t want to smooth that NDF, but the original one. We just enter the
name of the NDF at the prompt. Notice that we don’t need the
@ prefix, since Parameter IN
expects a file. (One occasion where you would need it is when the filename is a number,
e.g. if your NDF was called 234 you must enter
@234, otherwise the parameter system will
think you are giving the integer 234. Yes …I know …the parameter system is trying to be too
The description of Parameter FWHM is too brief for us to select a value. So we obtain some help on
this parameter, and then GAUSMOOTH reprompts for a value. The smoothed NDF is written to the
testsm in the current directory.
Next we want to look at the result of our image processing. The first thing to do is to select an graphics
xwindows device becomes the current graphics device and remains so until the next
GDSET command. (You may need to enter the
xdisplay command (SUN/129) to redirect the output
from the host computer to the screen in front you.)
Now we actually display it on the screen. Some applications have many parameters, and it would be impractical to have to specify all those preceding the ones we wanted to alter. The solution is to specify the parameter by keyword. Here we have requested that the scaling of the data values to colour indices within the graphics device uses the current percentile range. Note that you may abbreviate the options of a menu, such as offered by Parameter MODE, to any unambiguous string.
If you have just created the window, the image will not look much like the comet, because the existing colour table is poor. If we replace the table with a grey-scale ramp from white to black,
what happens depends on your workstation hardware and settings. If your graphics system is set to 256 colours (technically, an 8-bit pseudo-colour visual), then the effects of the above LUTNEG command will be immediately visible, and you will see a blurred image of the ubiquitous Comet West on the screen. If, on the other hand, your graphics system is set to 16-bit or 24-bit graphics, then the effects of the LUTNEG command will only become visible when you next display an image. In this case, re-invoking the above DISPLAY command will make the image appear correctly with the requested grey-scale colour table.
The ACCEPT keyword is a very useful feature. It tells an application to accept all the suggested
defaults. In this case DISPLAY uses the current NDF and scales between the current percentile
limits—10 and 90. The keyword can be abbreviated to double backslash from the shell. Aside: the
parameter system actually requires a single backslash. From the shell, however, backslash
is a metacharacter, and so must be ‘escaped’ to treat the character literally. One way is to
\ before each metacharacter. You can escape a series of characters by placing them
inside single quotes
’ ’. Other metacharacters to watch out for when using Kappa include
Next we want to make the image colourful. There are a number of predefined lookup tables, or you may create and modify your own. Here we’ve given the X-window a ‘warm’ brown-yellow colour table1:
If you are not happy with this colour table, you may want to explore a wider range of colour tables using the LUTEDIT command which provides a complete graphical user interface for manipulating and viewing colour tables.
ICL is a command language designed for use with Starlink applications, such as Kappa. It is now of some
antiquity but is still in use. The main advantages for the Kappa user are that shell metacharacters like
need not be escaped; command names may be abbreviated; far fewer executables need be loaded, and
therefore it is slightly faster than using the shell when you want to invoke more than a few
commands on a busy system; there is a wide selection of intrinsic functions and floating-point
arithmetic; and results may be passed between applications via ICL variables. However, in these
two demonstrations the command languages are interchangeable apart from the accept
Let’s start the second example.
This starts ICL. System, local and user-defined ICLlogin files are invoked. Here there is only a system
login procedure which sets up help on Starlink packages, and commands for setting up definitions for
those packages. One of those commands is
kappa; it is analogous to the
kappa command from the
shell. We enter it after receiving the ICL prompt.
You should see something like the following.
Now we run an application, ADD, that adds the pixels in
$KAPPA_DIR/comwest.sdf to those in
$KAPPA_DIR/ccdframec.sdf. Although these images have different dimensions, the intersection is
After the first Kappa command is issued you’ll see an arcane message like this.
It just tells you that the Kappa monolith is being loaded. You’ll see similar messages for each of the three monoliths when they are first wanted.
Since we did not give the name of the destination NDF that will hold the co-added NDFs, ADD prompts for it. Notice that literal parameters are case insensitive.
This shows that the
demo1 NDF has the same dimensions as the smaller of the two NDFs.
We were going to display the image on the current graphics device, but then changed our minds. A
in response to a prompt aborts a task.
Kappa uses the graphics database, which records the positions and extents of graphs and images, collectively called pictures.
This instruction divides the display surface into two equally sized pictures, side by side. They are labelled 1 and 2 in the database. Picture 1 is the current picture, in which future pictures are drawn, unless we select a new current picture.
Thus in Picture 1 we display an image of Comet West around which we draw annotated axes. The backslash causes the current scaling method to be used.
DISPLAY could not find the a
comwest.sdf in the current directory. So there is an error message and
we are prompted. This time we remember to add the environment variable.
An image of Comet West should be visible to the left of the screen.
SHADOW creates an image that appears like a bas-relief. We’ve called the resulting NDF comwest_bas. The backslash causes the current NDF to be the input NDF for SHADOW.
We select the right-hand picture created earlier.
As above we display the current NDF, the bas-relief image, with annotated axes on the right of the raw
comet image (we do not need to request the axes explicitly this time, since the
axes parameter retains
the value used in the previous invocation until changed).
The relief looks best with a grey-scale colour table. Note that this does not affect the colour of the border. LUTGREY is a procedure which calls a more-general application. Since it is the first procedure we’ve invoked there is a short pause while all the Kappa procedures are compiled and loaded.
Next we decide to make a hard copy of the bas-relief image. DISPLAY does this and can add a key of
grey levels and their corresponding values. The chosen device is
ps_l; this overrides the
device for the duration of DISPLAY. If this name isn’t recognised at your site, issue the GDNAMES
command for a list of your local device names. Select the landscape PostScript device. We scale
between wider limits to reduce the glare.
DISPLAY does not send your plot to the printer, since this is hardware and node dependent.
Therefore, you must issue a shell command from ICL to perform this action. That’s not difficult—just
! before the UNIX command, and in most cases just issue the command as if you were in the
shell, like we do below.
Shell aliases may also be used, so if
ri equates to
rm -i, we could remove any unwanted HDS files.
If you don’t have this symbol, as is likely, then you will receive the appropriate error message from
That’s the end of the second demonstration. Of course, these introductions have only scratched the surface of what Kappa can do for you. You should look at the classified lists to search for the desired function, and then find more details in the specifications.
If you get stuck or something untoward happens, there is a
Hints help topic.
1Again, you will need to re-display the image to see the effects of this command unless your graphics system is set to 256 colours.