27.01.2015 Views

CCfits - HEASARC - NASA

CCfits - HEASARC - NASA

CCfits - HEASARC - NASA

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

24.3 <strong>CCfits</strong>::Column Class Reference 55<br />

columnIndex The column number<br />

column- The column name, keyword TTYPEn<br />

Name<br />

type used for determining class of T in ColumnData, ColumnVector-<br />

Data<br />

format the column data format, TFORMn keyword<br />

unit the column data unit, TUNITn keyword<br />

p the Table pointer<br />

rpt (optional) repeat count for the row ( == 1 for AsciiTables)<br />

w the row width<br />

comment comment to be added to the header.<br />

24.3.3 Member Function Documentation<br />

24.3.3.1 template void <strong>CCfits</strong>::Column::addNullValue ( T nullVal )<br />

Set the TNULLn keyword for the column.<br />

Only relevant for integer valued columns, TNULLn is the value used by cfitsio in undefined<br />

processing. All entries in the table equal to an input "null value" are set equal<br />

to the value of TNULLn. (For floating point columns a system NaN value is used).<br />

24.3.3.2 const String & <strong>CCfits</strong>::Column::dimen ( ) const [inline]<br />

return TDIMn keyword<br />

represents dimensions of data arrays in vector columns. for scalar columns, returns a<br />

default value.<br />

24.3.3.3 const String & <strong>CCfits</strong>::Column::display ( ) const [inline]<br />

return TDISPn keyword<br />

TDISPn is suggested format for output of column data.<br />

24.3.3.4 const String & <strong>CCfits</strong>::Column::format ( ) const [inline]<br />

return TFORMn keyword<br />

TFORMn specifies data format stored in disk file.<br />

24.3.3.5 template bool <strong>CCfits</strong>::Column::getNullValue ( T ∗ nullVal ) const<br />

Get the value of the TNULLn keyword for the column.<br />

Only relevant for integer valued columns. If the TNULLn keyword is present, its value<br />

will be written to ∗nullVal and the function returns true. If the keyword is not found or<br />

its value is undefined, the function returns false and ∗nullVal is not modified.<br />

Generated on Tue Dec 6 2011 16:12:51 for <strong>CCfits</strong> by Doxygen

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!