casa
5.7.0-16
|
Simplified interface to FITS tables with Casacore Look and Feel. More...
#include <FITSTable.h>
Public Member Functions | |
virtual | ~FITSTabular () |
virtual Bool | isValid () const =0 |
isValid() returns False if this object isn't a valid Tabular data structure. More... | |
virtual const TableRecord & | keywords () const =0 |
Returns keywords which are associated with the underlying FITS files. More... | |
virtual const RecordDesc & | description () const =0 |
Returns the description of the underlying FITS table. More... | |
virtual const Record & | units () const =0 |
Returns any TUNITnnn associated with a column (the field names are the column names, each field value is the TUNITnnn value for that field). More... | |
virtual const Record & | displayFormats () const =0 |
Returns any TDISPnnn associated with a column (the field names are the column names, each field value is the TDISPnnn value for that field). More... | |
virtual const Record & | nulls () const =0 |
Returns any TNULLnnn associated with a column (the field names are the column names, each field value is the TNULLnnn value for that field). More... | |
virtual Bool | pastEnd () const =0 |
Returns True if we have advanced past the end of data. More... | |
virtual void | next ()=0 |
Advance the row if possible (guaranteed harmless if pastEnd() is True. More... | |
virtual Bool | reopen (const String &) |
Reopen the table, default behavior is to do nothing, return False. More... | |
virtual const String & | name () const =0 |
return the name More... | |
virtual Bool | hasChanged () const |
Has the description changed since construction, default is False. More... | |
virtual void | resetChangedFlag () |
reset the changed flag, default do nothing More... | |
virtual const Record & | currentRow () const =0 |
Return the currentRow. More... | |
Static Public Member Functions | |
static TableRecord | keywordsFromHDU (HeaderDataUnit &hdu, Bool allKeywords=False) |
Helper function for retrieving keywords from a native-FITS hdu. More... | |
static RecordDesc | descriptionFromHDU (BinaryTableExtension &hdu) |
Helper function for retrieving a description from a native-FITS hdu. More... | |
static Record | subStringShapeFromHDU (BinaryTableExtension &hdu) |
Help function for retrieving any shape information from String columns using the SubString convention. More... | |
static Record | unitsFromHDU (BinaryTableExtension &hdu) |
Helper function for retrieving the TUNITnnn from a native-FITS hdu. More... | |
static Record | displayFormatsFromHDU (BinaryTableExtension &hdu) |
Helper function for retrieving the TDISPnnn from a native-FITS hdu. More... | |
static Record | nullsFromHDU (BinaryTableExtension &hdu) |
Helper function for retrieving the TNULLnnn from a native-FITS hdu. More... | |
static TableDesc | tableDesc (const FITSTabular &fitstabular) |
Get a TableDesc appropriate to hold a FITSTabular the keywords, description, units, displayFormats, and nulls are all used. More... | |
Simplified interface to FITS tables with Casacore Look and Feel.
Public interface
FITSTablular is an obstract base class which is used for read-only access to tabular FITS-like data structures.
Definition at line 80 of file FITSTable.h.
|
virtual |
|
pure virtual |
Return the currentRow.
This is guaranteed to be valid so long as only member functions of this base class are called (so you can safely attach RecordFieldPtr objects to it. The result is undefined if pastEnd() is True.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
pure virtual |
Returns the description of the underlying FITS table.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
static |
Helper function for retrieving a description from a native-FITS hdu.
|
pure virtual |
Returns any TDISPnnn associated with a column (the field names are the column names, each field value is the TDISPnnn value for that field).
Note that only those columns with a non-empty TDISPnnn have an entry in the displayFormats() Record.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
static |
Helper function for retrieving the TDISPnnn from a native-FITS hdu.
|
inlinevirtual |
Has the description changed since construction, default is False.
Reimplemented in casacore::FITSTimedTable, and casacore::FITSMultiTable.
Definition at line 124 of file FITSTable.h.
References casacore::False.
|
pure virtual |
isValid() returns False if this object isn't a valid Tabular data structure.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
pure virtual |
Returns keywords which are associated with the underlying FITS files.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
static |
Helper function for retrieving keywords from a native-FITS hdu.
If allKeywords is not True, some keywords will be excluded from the list. Currently the list of excluded keywords includes TTYPEnnn, TFORMnnn, and TUNITnnn
|
pure virtual |
return the name
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
Referenced by casacore::FITSMultiTable::name(), and casacore::FITSTimedTable::name().
|
pure virtual |
Advance the row if possible (guaranteed harmless if pastEnd() is True.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
pure virtual |
Returns any TNULLnnn associated with a column (the field names are the column names, each field value is the TNULLnnn value for that field).
Note that only those columns with a specific entry for TNULLnnn and which have not been promoted to doubles due TSCAL and TZERO values will have an entry in the nulls() Record. The meaning of TNULL is only defined for integer and byte columns. When a column is promoted to a double because of scaling, any TNULL values will be assigned a value of NaN.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
static |
Helper function for retrieving the TNULLnnn from a native-FITS hdu.
|
pure virtual |
Returns True if we have advanced past the end of data.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
Reopen the table, default behavior is to do nothing, return False.
Reimplemented in casacore::FITSTable, and casacore::SDFITSTable.
Definition at line 118 of file FITSTable.h.
References casacore::False.
|
inlinevirtual |
reset the changed flag, default do nothing
Reimplemented in casacore::FITSMultiTable, and casacore::FITSTimedTable.
Definition at line 126 of file FITSTable.h.
|
static |
Help function for retrieving any shape information from String columns using the SubString convention.
Information is returned in a Record having named fields = all String columns following those convention. Each of these fields is, in turn, a sub-record having these three fields: NCHAR, NELEM, DELIM. If NELEM == -1 then there must have been a DELIM specified and this field is a variable shaped string array where each element has at most NCHAR and they are separated by DELIM (which is a String field here). Otherwise, DELIM is not used and there are NCHAR per element for each of NELEM in each cell for this column.
|
static |
Get a TableDesc appropriate to hold a FITSTabular the keywords, description, units, displayFormats, and nulls are all used.
|
pure virtual |
Returns any TUNITnnn associated with a column (the field names are the column names, each field value is the TUNITnnn value for that field).
Note that only those columns with a non-empty TUNITnnn have an entry in the units() Record.
Implemented in casacore::FITSTable, casacore::FITSTimedTable, and casacore::FITSMultiTable.
|
static |
Helper function for retrieving the TUNITnnn from a native-FITS hdu.