CCfits
2.4
|
Class Representing Ascii Table Extensions. More...
#include <AsciiTable.h>
Public Member Functions | |
virtual void | addColumn (ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=0, size_t columnNumber=0) |
add a new column to an existing table HDU. | |
virtual AsciiTable * | clone (FITSBase *p) const |
virtual copy constructor | |
virtual void | readData (bool readFlag=false, const std::vector< String > &keys=std::vector< String >()) |
read columns and keys specified in the input array. | |
![]() | |
Table (const Table &right) | |
copy constructor | |
virtual | ~Table () |
destructor | |
virtual Column & | column (const String &colName, bool caseSensitive=true) const |
return a reference to a Table column specified by name. | |
virtual Column & | column (int colIndex) const |
return a reference to the column identified by colIndex | |
virtual const std::map< string, Column * > & | column () const |
return a reference to the array containing the columns. | |
virtual std::map< string, Column * > & | column () |
return a reference to the array containing the columns. | |
virtual void | deleteColumn (const String &columnName) |
delete a column in a Table extension by name. | |
void | deleteRows (long first, long number=1) |
delete a range of rows in a table. | |
void | deleteRows (const std::vector< long > &rowList) |
delete a set of rows in the table specified by an input array. | |
virtual long | getRowsize () const |
return the optimal number of rows to read or write at a time | |
void | insertRows (long first, long number=1) |
insert empty rows into the table | |
virtual int | numCols () const |
return the number of Columns in the Table (the TFIELDS keyword). | |
virtual long | rows () const |
return the number of rows in the table (NAXIS2). | |
void | rows (long numRows) |
set the number of rows in the Table. | |
void | updateRows () |
update the number of rows in the table | |
![]() | |
ExtHDU (const ExtHDU &right) | |
copy constructor | |
virtual | ~ExtHDU () |
destructor | |
bool | isCompressed () const |
return true if image is stored using compression. | |
virtual void | makeThisCurrent () const |
move the fitsfile pointer to this current HDU. | |
const String & | name () const |
return the name of the extension. | |
template<typename S > | |
void | read (std::valarray< S > &image) |
Read image data into container. | |
template<typename S > | |
void | read (std::valarray< S > &image, long first, long nElements, S *nullValue) |
read part of an image array, processing null values. | |
template<typename S > | |
void | read (std::valarray< S > &image, const std::vector< long > &first, long nElements, S *nullValue) |
read part of an image array, processing null values. | |
template<typename S > | |
void | read (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride) |
read an image subset | |
template<typename S > | |
void | read (std::valarray< S > &image, long first, long nElements) |
read an image section starting at a specified pixel | |
template<typename S > | |
void | read (std::valarray< S > &image, const std::vector< long > &first, long nElements) |
read an image section starting at a location specified by an n-tuple | |
template<typename S > | |
void | read (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride, S *nullValue) |
read an image subset into valarray image, processing null values | |
int | version () const |
return the extension version number. | |
void | version (int value) |
set the extension version number | |
template<typename S > | |
void | write (const std::vector< long > &first, long nElements, const std::valarray< S > &data, S *nullValue) |
Write a set of pixels to an image extension with the first pixel specified by an n-tuple, processing undefined data. | |
template<typename S > | |
void | write (long first, long nElements, const std::valarray< S > &data, S *nullValue) |
write array to image starting with a specified pixel and allowing undefined data to be processed | |
template<typename S > | |
void | write (const std::vector< long > &first, long nElements, const std::valarray< S > &data) |
write array starting from specified n-tuple, without undefined data processing | |
template<typename S > | |
void | write (long first, long nElements, const std::valarray< S > &data) |
write array starting from specified pixel number, without undefined data processing | |
template<typename S > | |
void | write (const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::valarray< S > &data) |
write a subset (generalize slice) of data to the image | |
![]() | |
HDU (const HDU &right) | |
copy constructor | |
template<typename T > | |
Keyword & | addKey (const String &name, T val, const String &comment) |
create a new keyword in the HDU with specified value and comment fields | |
Keyword * | addKey (const Keyword *inKeyword) |
create a copy of an existing Keyword and add to HDU | |
long | axes () const |
return the number of axes in the HDU data section (always 2 for tables). | |
long | axis (size_t index) const |
return the size of axis numbered index [zero based]. | |
long | bitpix () const |
return the data type keyword. | |
const string & | comment () const |
return the comment string previously read by getComment() | |
void | copyAllKeys (const HDU *inHdu) |
copy all keys from another header | |
void | deleteKey (const String &doomed) |
delete a keyword from the header | |
fitsfile * | fitsPointer () const |
return the fitsfile pointer for the FITS object containing the HDU | |
std::pair< unsigned long, unsigned long > | getChecksum () const |
compute and return the checksum values for the HDU without creating or modifying the CHECKSUM/DATASUM keywords. | |
const String & | getComments () |
read the comments from the HDU and add it to the FITS object. | |
const String & | getHistory () |
read the history information from the HDU and add it to the FITS object. | |
const string & | history () const |
return the history string previously read by getHistory() | |
void | index (int value) |
set the HDU number | |
int | index () const |
return the HDU number | |
std::map< String, Keyword * > & | keyWord () |
return the associative array containing the HDU keywords so far read. | |
Keyword & | keyWord (const String &keyName) |
return a (previously read) keyword from the HDU object. | |
const std::map< string, Keyword * > & | keyWord () const |
return the associative array containing the HDU Keywords that have been read so far. | |
const Keyword & | keyWord (const string &keyname) const |
return a (previously read) keyword from the HDU object. const version | |
bool | operator!= (const HDU &right) const |
inequality operator | |
bool | operator== (const HDU &right) const |
equality operator | |
FITSBase * | parent () const |
return reference to the pointer representing the FITSBase object containing the HDU | |
void | readAllKeys () |
read all of the keys in the header | |
template<typename T > | |
void | readKey (const String &keyName, T &val) |
read a keyword of specified type from the header of a disk FITS file and return its value. | |
template<typename T > | |
void | readKeys (std::vector< String > &keyNames, std::vector< T > &vals) |
read a set of specified keywords of the same data type from the header of a disk FITS file and return their values | |
virtual double | scale () const |
return the BSCALE keyword value | |
virtual void | scale (double value) |
set the BSCALE keyword value for images (see warning for images of int type) | |
void | suppressScaling (bool toggle=true) |
turn off image scaling regardless of the BSCALE and BZERO keyword values | |
void | updateChecksum () |
update the CHECKSUM keyword value, assuming DATASUM exists and is correct | |
std::pair< int, int > | verifyChecksum () const |
verify the HDU by computing the checksums and comparing them with the CHECKSUM/DATASUM keywords | |
void | writeChecksum () |
compute and write the DATASUM and CHECKSUM keyword values | |
void | writeComment (const String &comment="Generic Comment") |
write a comment string. | |
void | writeDate () |
write a date string to *this. | |
void | writeHistory (const String &history="Generic History String") |
write a history string. | |
virtual double | zero () const |
return the BZERO keyword value | |
virtual void | zero (double value) |
set the BZERO keyword value for images (see warning for images of int type) |
Protected Member Functions | |
AsciiTable (FITSBase *p, const String &hduName=String(""), bool readFlag=false, const std::vector< String > &keys=std::vector< String >(), int version=1) | |
reading constructor: Construct a AsciiTable extension from an extension of an existing disk file. | |
AsciiTable (FITSBase *p, const String &hduName, int rows, const std::vector< String > &columnName=std::vector< String >(), const std::vector< String > &columnFmt=std::vector< String >(), const std::vector< String > &columnUnit=std::vector< String >(), int version=1) | |
writing constructor: create new Ascii Table object with the specified columns | |
AsciiTable (FITSBase *p, int number) | |
read AsciiTable with HDU number number from existing file. | |
~AsciiTable () | |
destructor. | |
![]() | |
Table (FITSBase *p, HduType xtype, const String &hduName, int rows, const std::vector< String > &columnName, const std::vector< String > &columnFmt, const std::vector< String > &columnUnit=std::vector< String >(), int version=1) | |
Constructor to be used for creating new HDUs. | |
Table (FITSBase *p, HduType xtype, const String &hduName=String(""), int version=1) | |
Constructor to be called by operations that read Table specified by hduName and version. | |
Table (FITSBase *p, HduType xtype, int number) | |
Table constructor for getting Tables by number. | |
void | init (bool readFlag=false, const std::vector< String > &keys=std::vector< String >()) |
void | numCols (int value) |
set the number of Columns in the Table | |
virtual void | setColumn (const String &colname, Column *value) |
set the column with name colname to the input value. | |
![]() | |
ExtHDU (FITSBase *p, HduType xtype, const String &hduName, int version) | |
default constructor, required as Standard Library Container content. | |
ExtHDU (FITSBase *p, HduType xtype, const String &hduName, int bitpix, int naxis, const std::vector< long > &axes, int version) | |
writing constructor. | |
ExtHDU (FITSBase *p, HduType xtype, int number) | |
ExtHDU constructor for getting ExtHDUs by number. | |
long | gcount () const |
return required gcount keyword value | |
void | gcount (long value) |
set required gcount keyword value | |
long | pcount () const |
return required pcount keyword value | |
void | pcount (long value) |
set required pcount keyword value | |
HduType | xtension () const |
return the extension type | |
void | xtension (HduType value) |
set the extension type | |
![]() | |
HDU (FITSBase *p=0) | |
default constructor, called by HDU subclasses that read from FITS files. | |
HDU (FITSBase *p, int bitpix, int naxis, const std::vector< long > &axes) | |
constructor for creating new HDU objects, called by HDU subclasses writing to FITS files. | |
virtual | ~HDU () |
destructor | |
std::vector< long > & | naxes () |
return the HDU data axis array. |
Additional Inherited Members | |
![]() | |
static void | readHduName (const fitsfile *fptr, int hduIndex, String &hduName, int &hduVersion) |
read extension name. |
Class Representing Ascii Table Extensions.
May only contain columns with scalar row entries and a small range of data types. AsciiTable (re)implements functions prescribed in the Table abstract class. The implementations allow the calling of cfitsio specialized routines for AsciiTable header construction.
Direct instantiation of AsciiTable objects is disallowed: they are created by explicit calls to FITS::addTable( ... ), FITS::read(...) or internally by one of the FITS ctors on initialization. The default for FITS::addTable is to produce BinTable extensions.
|
protected |
reading constructor: Construct a AsciiTable extension from an extension of an existing disk file.
The Table is specified by name and optional version number within the file. An array of strings representing columns or keys indicates which data are to be read. The column data are only read if readFlag is true. Reading on construction is optimized, so it is more efficient to read data at the point of instantiation. This favours a "resource acquisition is initialization" model of data management.
p | pointer to FITSBase object for internal use |
hduName | name of AsciiTable object to be read. |
readFlag | flag to determine whether to read data on construction |
keys | (optional) a list of keywords/columns to be read. The implementation will determine which are keywords. If none are specified, the constructor will simply read the header |
version | (optional) version number. If not specified, will read the first extension that matches hduName. |
|
protected |
writing constructor: create new Ascii Table object with the specified columns
The constructor creates a valid HDU which is ready for Column::write or insertRows operations. The disk FITS file is update accordingly. The data type of each column is determined by the columnFmt argument (TFORM keywords). See cfitsio documentation for acceptable values.
hduName | name of AsciiTable object to be written |
rows | number of rows in the table (NAXIS2) |
columnName | array of column names for columns to be constructed. |
columnFmt | array of column formats for columns to be constructed. |
columnUnit | (optional) array of units for data in columns. |
version | (optional) version number for HDU. |
The dimensions of columnType, columnName and columnFmt must match, although this is not enforced at present.
|
protected |
read AsciiTable with HDU number number
from existing file.
This is used internally by methods that need to access HDUs for which no EXTNAME [or equivalent] keyword exists.
|
virtual |
add a new column to an existing table HDU.
type | The data type of the column to be added |
columnName | The name of the column to be added |
repeatWidth | for a string valued, this is the width of a string. For a numeric column it supplies the vector length of the rows. It is ignored for ascii table numeric data. |
colUnit | an optional field specifying the units of the data (TUNITn) |
decimals | optional parameter specifying the number of decimals for an ascii numeric column |
columnNumber | optional parameter specifying column number to be created. If not specified the column is added to the end. If specified, the column is inserted and the columns already read are reindexed. This parameter is provided as a convenience to support existing code rather than recommended. |
Reimplemented from CCfits::ExtHDU.
|
virtual |
read columns and keys specified in the input array.
See Table class documentation for further details.
Implements CCfits::ExtHDU.