next up previous 264
Next: FitsTable - A representation of a FITS binary table
Up: AST Class Descriptions
Previous: Ellipse - An elliptical region within a 2-dimensional Frame


FitsChan - I/O Channel using FITS header cards to represent Objects

Description:
A FitsChan is a specialised form of Channel which supports I/O operations involving the use of FITS (Flexible Image Transport System) header cards. Writing an Object to a FitsChan (using astWrite) will, if the Object is suitable, generate a description of that Object composed of FITS header cards, and reading from a FitsChan will create a new Object from its FITS header card description.

While a FitsChan is active, it represents a buffer which may contain zero or more 80-character "header cards" conforming to FITS conventions. Any sequence of FITS-conforming header cards may be stored, apart from the "END" card whose existence is merely implied. The cards may be accessed in any order by using the FitsChan's integer Card attribute, which identifies a "current" card, to which subsequent operations apply. Searches based on keyword may be performed (using astFindFits), new cards may be inserted (astPutFits, astPutCards, astSetFits$<$X$>$) and existing ones may be deleted (astDelFits), extracted (astGetFits$<$X$>$), or changed (astSetFits$<$X$>$).

When you create a FitsChan, you have the option of specifying "source" and "sink" functions which connect it to external data stores by reading and writing FITS header cards. If you provide a source function, it is used to fill the FitsChan with header cards when it is accessed for the first time. If you do not provide a source function, the FitsChan remains empty until you explicitly enter data into it (e.g. using astPutFits, astPutCards, astWrite or by using the SourceFile attribute to specifying a text file from which headers should be read). When the FitsChan is deleted, any remaining header cards in the FitsChan can be saved in either of two ways: 1) by specifying a value for the SinkFile attribute (the name of a text file to which header cards should be written), or 2) by providing a sink function (used to to deliver header cards to an external data store). If you do not provide a sink function or a value for SinkFile, any header cards remaining when the FitsChan is deleted will be lost, so you should arrange to extract them first if necessary (e.g. using astFindFits or astRead).

Coordinate system information may be described using FITS header cards using several different conventions, termed "encodings". When an AST Object is written to (or read from) a FitsChan, the value of the FitsChan's Encoding attribute determines how the Object is converted to (or from) a description involving FITS header cards. In general, different encodings will result in different sets of header cards to describe the same Object. Examples of encodings include the DSS encoding (based on conventions used by the STScI Digitised Sky Survey data), the FITS-WCS encoding (based on a proposed FITS standard) and the NATIVE encoding (a near loss-less way of storing AST Objects in FITS headers).

The available encodings differ in the range of Objects they can represent, in the number of Object descriptions that can coexist in the same FitsChan, and in their accessibility to other (external) astronomy applications (see the Encoding attribute for details). Encodings are not necessarily mutually exclusive and it may sometimes be possible to describe the same Object in several ways within a particular set of FITS header cards by using several different encodings.

The detailed behaviour of astRead and astWrite, when used with a FitsChan, depends on the encoding in use. In general, however, all successful use of astRead is destructive, so that FITS header cards are consumed in the process of reading an Object, and are removed from the FitsChan (this deletion can be prevented for specific cards by calling the astRetainFits function). An unsuccessful call of astRead (for instance, caused by the FitsChan not containing the necessary FITS headers cards needed to create an Object) results in the contents of the FitsChan being left unchanged.

If the encoding in use allows only a single Object description to be stored in a FitsChan (e.g. the DSS, FITS-WCS and FITS-IRAF encodings), then write operations using astWrite will over-write any existing Object description using that encoding. Otherwise (e.g. the NATIVE encoding), multiple Object descriptions are written sequentially and may later be read back in the same sequence.

Constructor Function:
astFitsChan
Inheritance
The FitsChan class inherits from the Channel class.
Attributes
In addition to those attributes common to all Channels, every

FitsChan also has the following attributes:

  • AllWarnings: A list of the available conditions

  • Card: Index of current FITS card in a FitsChan

  • CardType: The data type of the current FITS card in a FitsChan

  • CarLin: Ignore spherical rotations on CAR projections?

  • CDMatrix: Use a CD matrix instead of a PC matrix?

  • Clean: Remove cards used whilst reading even if an error occurs?

  • DefB1950: Use FK4 B1950 as default equatorial coordinates?

  • Encoding: System for encoding Objects as FITS headers

  • FitsDigits: Digits of precision for floating-point FITS values

  • Iwc: Add a Frame describing Intermediate World Coords?

  • Ncard: Number of FITS header cards in a FitsChan

  • Nkey: Number of unique keywords in a FitsChan

  • TabOK: Should the FITS "-TAB" algorithm be recognised?

  • PolyTan: Use PVi_m keywords to define distorted TAN projection?

  • Warnings: Produces warnings about selected conditions
Functions
In addition to those functions applicable to all Channels, the following functions may also be applied to all FitsChans:



next up previous 264
Next: FitsTable - A representation of a FITS binary table
Up: AST Class Descriptions
Previous: Ellipse - An elliptical region within a 2-dimensional Frame

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 211
R.F. Warren-Smith & D.S. Berry
7th December 2012
E-mail:starlink@jiscmail.ac.uk

Copyright (C) 2012 Science \& Technology Facilities Council