DulFitsRead - Implements a Tcl Command to read a Fits file into an Sds structure.

Function

Implements a Tcl Command to read a Fits file into an Sds structure.

Description

This C function implements a Tcl command which will read a FITS file into an SDS structure. This function is only built if CFITSIO support is enabled when the DRAMA DUL Library is built. The Tcl command description follows

This command will read an image from a FITS file into an SDS structure. This structure will be of the form described in the DITS specification for ImageStructure type SDS structures.

If the "-type" option is not used, the file will be converted into an SDS structure of type USHORT (for historical compatiblity).

This command will only be available on Dtcl if DRAMA has been built with support for CFITSIO enabled. Dtcl/Dtk will include this command (from DRAMA version 1.5.2) if CFITSIO support is enabled when Dtcl is built.

The FITS header is also put into the SDS structure in an item named HEADER. This is a raw array of SDS_CHAR containing the raw FITS Header cards for the primiary header.

Tcl Command Call

<user defined> fitsFile [options]

Tcl Command Parameters

(>) fitsFile (string) The name of the FITS file to read.

Tcl Options

-type type
Specifies the SDS type into which the data should e converted. Possiblities are byte, short, ushort, int, uint, float, double, int64, natural. "natural" means that it is converted into the natural format for the file. If this argument is not supplied, then it is converted into ushort.

Tcl Command Returns

The SDS ID of the structure or ERROR.

Call

DulFitsRead( clientData, interp, argc, argv)

Parameters

As per C implementation of Tcl commands.

Include Files

tcl.h, dul.h

Returns

Tcl OK or Error.

See Also

Dul library document, tclsh(n), DulFitsWrite(3), FITSIO library specification, FITS specification, Tcl/Tk book.

Language

C

Support

Tony Farrell, AAO

Click here for the DRAMA home page and here for the AAO home page.

 For more information, contact tjf@aaoepp.aao.gov.au