SDFITSTable.h

Classes

SDFITSTable -- SDFITSTable is a FITSTable which follows the Single Dish FITS Convention. (full description)

class SDFITSTable : public FITSTable

Types

enum CoreKeyword

OBJECT
TELESCOP
BANDWID
DATEOBS
EXPOSURE
TSYS
NUM_CORE_KEYWORDS

Interface

Public Members
SDFITSTable(const String &fileName, uInt whichHDU=1)
~SDFITSTable()
virtual Bool reopen(const String &fileName)
virtual Bool isSDFITS() const
static CoreKeyword coreKeyword(const String& name)
static String coreKeywordName(CoreKeyword kw)
Private Members
static void init_kwNames()
static Bool isSDFitsColumn(const String& name)
void sdfits_shuffle()
SDFITSTable()
SDFITSTable(const SDFITSTable &)
SDFITSTable &operator=(const SDFITSTable &)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

SDFITSTable is derived from FITSTable. It contains additional checks and behaviour appropriate to the Single Dish FITS Convention hence this is a Single Dish FITS Table, or SDFITSTable.

Synopsis

This class behaves much like FITSTable. It additionally verifies that the indicated HDU in the input FITS file follows the SDFITS convention (it has all of the required columns) and it treats keywords as virtual columns when appropriate. These virtual columns will appear as fields in the currentRecord and description and will NOT appear in the keywords.

Example

Motivation

It was useful to encapsulate this behaviour in a class so that the checks on a valid SDFITS table and the treatment of keywords as virtual columns would not need to appear everywhere it might be used.

Thrown Exceptions

To Do

Member Description

enum CoreKeyword

the core keywords, UNKNOWN is not a core keyword, NUM_CORE_KEYWORDS is a place holder

SDFITSTable(const String &fileName, uInt whichHDU=1)

construct from a file

~SDFITSTable()

The destructor

virtual Bool reopen(const String &fileName)

Attach this SDFITSTable to a new file name, same HDU# as at open time

virtual Bool isSDFITS() const

is this a valid SDFITS file

static CoreKeyword coreKeyword(const String& name)

translate to/from core keyword names to enumeration

static String coreKeywordName(CoreKeyword kw)

static void init_kwNames()

kwNames initialization function

static Bool isSDFitsColumn(const String& name)

check to see if the named keyword should be turned into a column, all non-reserved keywords will always be turned into a column.

void sdfits_shuffle()

the array of keyword names the regular FITSTable::reopen does nearly everything fine, this function moves stuff out of the keywords and into the output record as appropriate

SDFITSTable()

undefined an inaccessible

SDFITSTable(const SDFITSTable &)

SDFITSTable &operator=(const SDFITSTable &)