casa::SDFITSTable Class Reference

SDFITSTable is a FITSTable which follows the Single Dish FITS Convention. More...

#include <SDFITSTable.h>

Inheritance diagram for casa::SDFITSTable:

List of all members.

Public Types
enum	CoreKeyword {   OBJECT,   TELESCOP,   BANDWID,   DATEOBS,   EXPOSURE,   TSYS,   NUM_CORE_KEYWORDS,   UNKNOWN }
	the core keywords, UNKNOWN is not a core keyword, NUM_CORE_KEYWORDS is a place holder More...
Public Member Functions
	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 Public Member Functions
static CoreKeyword	coreKeyword (const String &name)
	translate to/from core keyword names to enumeration
static String	coreKeywordName (CoreKeyword kw)
Private Member Functions
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 &)
Static Private Member Functions
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.
Private Attributes
Bool	isSDFITS_p
Static Private Attributes
static Block< String >	kwNames
	block of core keyword names

---

Detailed Description

SDFITSTable is a FITSTable which follows the Single Dish FITS Convention.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• FITSTable

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

• everything

Definition at line 86 of file SDFITSTable.h.

---

Member Enumeration Documentation

enum casa::SDFITSTable::CoreKeyword

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

Enumerator:

OBJECT
TELESCOP
BANDWID
DATEOBS
EXPOSURE
TSYS
NUM_CORE_KEYWORDS
UNKNOWN

Definition at line 91 of file SDFITSTable.h.

---

Constructor & Destructor Documentation

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

construct from a file

casa::SDFITSTable::~SDFITSTable

(

)

The destructor.

casa::SDFITSTable::SDFITSTable

(

)

[private]

undefined an inaccessible

casa::SDFITSTable::SDFITSTable

(

const SDFITSTable &

)

[private]

---

Member Function Documentation

static CoreKeyword casa::SDFITSTable::coreKeyword

(

const String &

name

)

[static]

translate to/from core keyword names to enumeration

static String casa::SDFITSTable::coreKeywordName

(

CoreKeyword

kw

)

[static]

static void casa::SDFITSTable::init_kwNames

(

)

[static, private]

kwNames initialization function

virtual Bool casa::SDFITSTable::isSDFITS

(

)

const [inline, virtual]

is this a valid SDFITS file

Definition at line 105 of file SDFITSTable.h.

References isSDFITS_p.

static Bool casa::SDFITSTable::isSDFitsColumn

(

const String &

name

)

[static, private]

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

SDFITSTable& casa::SDFITSTable::operator=

(

const SDFITSTable &

)

[private]

virtual Bool casa::SDFITSTable::reopen

(

const String &

fileName

)

[virtual]

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

Reimplemented from casa::FITSTable.

void casa::SDFITSTable::sdfits_shuffle

(

)

[private]

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

---

Member Data Documentation

Bool casa::SDFITSTable::isSDFITS_p [private]

Definition at line 112 of file SDFITSTable.h.

Referenced by isSDFITS().

Block<String> casa::SDFITSTable::kwNames [static, private]

block of core keyword names

Definition at line 115 of file SDFITSTable.h.

---

The documentation for this class was generated from the following file:

• casacore/fits/FITS/SDFITSTable.h