IRAF

Licensing

The licensing of IRAF generally follows the MIT license scheme. Older versions contained some non-free software. In particular, the NCAR graphics code restricted re-distribution of IRAF before it was removed in version 2.16. Also, old versions used code taken from the Numerical Recipes book under a different license. This code was removed or replaced with Open Source in versions after 2.16.1. This allowed the distribution of IRAF packages in mainstream Linux distributions like Debian or Ubuntu.

System design

Four basic components make up the run-time IRAF system:

• The Applications Packages are a structured collection of portable tasks for scientific data reduction and analysis, but also for system utilities.
• The Command Language (CL) is the default interactive user interface and is also used as scripting language for tasks in the application packages.
• The Virtual Operation System (VOS) provides a portable interface for the application tasks. It is modeled after the Unix system functions, but with an API for the IRAF specific Subset Preprocessor language (SPP).
• The Host System Interface (HSI) is the kernel providing an interface between the host system and the functions of the VOS. It also provides tools necessary for bootstrapping the system from source. The SPP compiler is also part of the HSI.

Only the HSI is system dependent. All other components are portable by the use of the functions provided by the HSI. This way, porting to a new system requires only changes in this component. However, the initial design was implicitly based on the universal use of 32-bit data types and therefore the port to 64 bit required major efforts not only in the HSI but in all components of the system.

Application packages

Application Packages are recursively structured in subpackages and tasks. They can be divided into two classes: general system and basic dataprocessing utilities, and packages specific to astronomical data reduction and analysis. The tasks are dominantly written in SPP and CL.

System packages

The system packages are located in the base package of IRAF and provide tools for the CL, useful operating system utilities, and basic scientific utilities, f.e. for image processing:

dataio

Data format conversion (FITS, IRAF image format etc.)

images

General bitmap image processing and display

lists

List processing

plot

Vector graphics plotting utilities

softools

Software development and system maintenance tools

system

System utilities

utilities

Miscellaneous utilities, including nttools to handle tables.

Optical astronomy packages

The noao packages are used for the analysis of optical astronomy data. Most of these tasks are general, but the imred package also contains data reduction tasks for specific instruments. Some of the important packages are:

imred

Image reductions package, containing both general tasks for astronomical data reduction and for specific KPNO instruments

artdata

Artificial data generation package. May generate artificial catalogs, 2D and 2D spectra, create images from artificial stars, galaxies, noise and cosmic rays etc. for testing purposes.

astrometry

Astrometry package to obtain astrometric coordinates for objects in stellar fields

digiphot

Digital stellar photometry package

onedspec

One dimensional spectral data reduction and analysis package. One important task in this package is splot, a graphical tool for the analysis of spectra.

twodspec

Two dimensional spectral reduction and analysis package, the same operations for two-dimensional spectra (longslit, multispec)

surfphot

Galaxy isophotal analysis package

astcat

Astronomical catalog and surveys access package

External packages

One strength of IRAF was the existence of various external packages, which resolved specific problems or implemented specialized data reduction pipelines. Among the packages are

fitsutil

Utilities for single and multiple extension FITS files

sptable

IRAF package for tabular spectra

ctio

Tools for the Cerro Tololo Inter-American Observatory

stsdas

Software system from Space Telescope Science Institute for calibrating and analyzing data from the Hubble Space Telescope. The support of selected tasks from the stsdas package is continued in the st4gem package. The original tables package from STSci is now included as utilities.nttables in the system packages.

stecf

IRAF tasks developed at the Space Telescope European Coordinating Facility

rvsao

Radial Velocity Package by Smithsonian Astrophysical Observatory

wcstools

Image World Coordinate System Utilities by Jessica Mink

AXe Spectral Extraction

Spectral extraction and visualization software to process large format astronomical slitless spectroscopic images such as those obtained with the Advanced Camera for Surveys on the Hubble Space Telescope. The package consists of several tasks, each of which performs a specific reduction step on the data to produce the final, extracted spectra. The user can then analyse and control the spectra and, if necessary, re-run with slightly changed parameters until a satisfactory result is achieved. A deep ACS WFC grism image can contain detectable spectra of several thousands objects. Checking each individual spectrum is very tedious. To help users analyzing the full wealth of their data, the additional task aXe2web was developed to produce browsable web pages from reduced spectral data to enable many hundreds of spectra to be examined quickly and discerningly. The tool can be used for a quick look or as preview facilities in data pipelines, databases or even for virtual observatories.

gemini

Data reduction pipeline for the Gemini Observatory

Many of these packages are however not maintained anymore. Porting to 64 bit also required significant effort and not all external packages were ported and therefore only usable in a 32-bit environment.

User-defined tasks

IRAF allows users to write their own tasks in two main ways. One is by writing non-compiled procedure (Command Language, CL) scripts. The second is through compiled subset pre-processor (SPP) programs. Tutorial documents exist for both methods.

IRAF specific languages

Command language

The Command Language (CL), serves as a command and runtime supportive interface between the user at his computer terminal and the application programs he is executing. The user types his commands to the CL and it does whatever task and file manipulations are necessary to carry out the commands. In later versions, the original CL was extended to ECL, which has an editable command line as its main advantage. A version that enabled direct access to the Virtual Observatory (VOCL) was developed too.

The CL primarily serves as a shell and organizes the work with the system and the applications. There are three types of tasks the CL can execute: native tasks, which are part of compiled IRAF executables, scripts (CL tasks which are tasks written in CL), and foreign tasks, external programs or scripts that are executed by the CL. For each task, a parameter file may exist. It contains a description of each of the parameters used by the task that should be known and managed by the CL.

Here is a simple Hello World script in CL:

<span id="mwAUE"></span><span class="err" id="mwAUI">{</span> <span class="nf" id="mwAUM">print</span><span class="p" id="mwAUQ">(</span><span class="err" id="mwAUU">'</span><span class="w" id="mwAUY"> </span><span class="nv" id="mwAUc">Hello</span><span class="p" id="mwAUg">,</span><span class="w" id="mwAUk"> </span><span class="nv" id="mwAUo">world</span><span class="w" id="mwAUs"> </span><span class="err" id="mwAUw">!!</span><span class="w" id="mwAU0"> </span><span class="err" id="mwAU4">'</span><span class="p" id="mwAU8">)</span> <span class="err" id="mwAVA">}</span>

CL scripts have usually the suffix .cl, which may cause conflicts with Common Lisp code files.

Subset preprocessor language

The subset preprocessor language (SPP) implements a subset of the IRAF preprocessor language that was planned in the early days of IRAF. The SPP language is based on the Ratfor language. The lexical form, operators, and control flow constructs are identical to those provided by Ratfor. The major differences are the data types, the form of a procedure, the addition of inline strings and character constants, the use of square brackets for arrays, and the task statement. The i/o facilities provided are quite different.

The xc program, provided with IRAF, translates SPP programs into Fortran 66, and from there with f2c into C code.

The preprocessor is complemented with mkpkg, a make like build automation tool, generic, a tool to translate generic types into type dependent source code, and xyacc, a modified yacc to produce SPP output.

Here is a simple Hello World program in SPP:

<span id="mwAWw"></span><span class="nf" id="mwAW0">task</span> <span class="nf" id="mwAW4">hello</span> <span class="c1" id="mwAW8"># CL callable task</span> <span class="nf" id="mwAXA">procedure</span> <span class="nf" id="mwAXE">hello</span><span class="p" id="mwAXI">()</span> <span class="c1" id="mwAXM"># common procedure</span> <span class="nf" id="mwAXQ">begin</span> <span class="nf" id="mwAXU">call</span> <span class="nf" id="mwAXY">printf</span> <span class="p" id="mwAXc">(</span><span class="s" id="mwAXg">"hello, world</span><span class="se" id="mwAXk">\n</span><span class="s" id="mwAXo">"</span><span class="p" id="mwAXs">)</span> <span class="nf" id="mwAXw">end</span>

SPP programs have usually the suffix .x, those which need to be preprocessed with the generic tool have .gx.

Supplementary software

A full IRAF working environment usually requires two other applications: an extended xterm window with a graphics windows (called xgterm and distributed in a separate x11iraf package) and an image display program referred to as an "image server". The two most popular image servers are SAOImageDS9 (by SAO) and ximtool (NOAO, also distributed in the x11iraf package).

As an alternative of xgterm and the Command Language, the Python package PyRAF can be used. PyRAF is able to translate CL scripts into Python scripts. It also provides a graphics window (based on Tk or on Matplotlib). As command shell, either the Python or IPython command shell can be used, or a special mode resembling much of the look and feel of the CL command shell.