<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>CCfits: CCfits::BinTable Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>CCfits</b>::<a class="el" href="classCCfits_1_1BinTable.html">BinTable</a>
</div>
</div>
<div class="contents">
<h1>CCfits::BinTable Class Reference</h1><!-- doxytag: class="CCfits::BinTable" --><!-- doxytag: inherits="CCfits::Table" -->
<p>Class Representing Binary <a class="el" href="classCCfits_1_1Table.html">Table</a> Extensions. Contains columns with scalar or vector row entries.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="BinTable_8h_source.html">BinTable.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCfits::BinTable:</div>
<div class="dynsection">
<div class="center">
<img src="classCCfits_1_1BinTable.gif" alt="Inheritance diagram" usemap="#CCfits::BinTable_map" alt=""/>
<map id="CCfits::BinTable_map" name="CCfits::BinTable_map">
<area href="classCCfits_1_1Table.html" alt="CCfits::Table" shape="rect" coords="0,112,101,136"/>
<area href="classCCfits_1_1ExtHDU.html" alt="CCfits::ExtHDU" shape="rect" coords="0,56,101,80"/>
<area href="classCCfits_1_1HDU.html" alt="CCfits::HDU" shape="rect" coords="0,0,101,24"/>
</map>
</div>
</div>
<p><a href="classCCfits_1_1BinTable-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a60e89ab762910b76155da983554d433d">addColumn</a> (ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=0, size_t columnNumber=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add a new column to an existing table <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <a href="#a60e89ab762910b76155da983554d433d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04506e39335dd06136d276091f097cde"></a><!-- doxytag: member="CCfits::BinTable::clone" ref="a04506e39335dd06136d276091f097cde" args="(FITSBase *p) const " -->
virtual <a class="el" href="classCCfits_1_1BinTable.html">BinTable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a04506e39335dd06136d276091f097cde">clone</a> (FITSBase *p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual copy constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a90cba1f7ee83d3c9f4471e0a2f317391">readData</a> (bool readFlag=false, const std::vector< String > &keys=std::vector< String >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read columns and keys specified in the input array. <a href="#a90cba1f7ee83d3c9f4471e0a2f317391"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a3775a258e59292fad79c41a08d0683"></a><!-- doxytag: member="CCfits::BinTable::BinTable" ref="a7a3775a258e59292fad79c41a08d0683" args="(FITSBase *p, int number)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a7a3775a258e59292fad79c41a08d0683">BinTable</a> (FITSBase *p, int number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> with <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> number <code>number</code> from existing file represented by fitsfile pointer p. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a7f144dbfdaa1a01331adf1bb83a9347a">BinTable</a> (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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">writing constructor <a href="#a7f144dbfdaa1a01331adf1bb83a9347a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a8d97ec9581e1c46111ce933c608b489a">BinTable</a> (FITSBase *p, const String &hduName=String(""), bool readFlag=false, const std::vector< String > &keys=std::vector< String >(), int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reading constructor. <a href="#a8d97ec9581e1c46111ce933c608b489a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bb44b892d5ed7c6d7271c4fb4c637c0"></a><!-- doxytag: member="CCfits::BinTable::~BinTable" ref="a1bb44b892d5ed7c6d7271c4fb4c637c0" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1BinTable.html#a1bb44b892d5ed7c6d7271c4fb4c637c0">~BinTable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class Representing Binary <a class="el" href="classCCfits_1_1Table.html">Table</a> Extensions. Contains columns with scalar or vector row entries. </p>
<p><a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> (re)implements functions prescribed in the <a class="el" href="classCCfits_1_1Table.html">Table</a> abstract class. The implementations allow the calling of cfitsio specialized routines for <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> header construction. functions particular to the <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> class include those dealing with variable width columns</p>
<p>Direct instantiation of <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> objects is disallowed: they are created by explicit calls to <a class="el" href="classCCfits_1_1FITS.html#a867732f42c7863550baf28795efc6876" title="Add a table extension to an existing FITS object. Add extension to FITS object for...">FITS::addTable</a>( ... ), <a class="el" href="classCCfits_1_1FITS.html#a3640e3ad1c29931b37a13ac91106504e" title="get data from single HDU from disk file.">FITS::read</a>(...) or internally by one of the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> ctors on initialization. For addTable, creation of BinTables is the default. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8d97ec9581e1c46111ce933c608b489a"></a><!-- doxytag: member="CCfits::BinTable::BinTable" ref="a8d97ec9581e1c46111ce933c608b489a" args="(FITSBase *p, const String &hduName=String(""), bool readFlag=false, const std::vector< String > &keys=std::vector< String >(), int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::BinTable::BinTable </td>
<td>(</td>
<td class="paramtype">FITSBase * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>hduName</em> = <code>String("")</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readFlag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>keys</em> = <code>std::vector<String>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>version</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>reading constructor. </p>
<p>Construct a <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> extension from an extension of an existing disk file. The <a class="el" href="classCCfits_1_1Table.html">Table</a> 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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>Pointer to FITSBase class, an internal implementation detail </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduName</em> </td><td>name of <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> object to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>readFlag</em> </td><td>flag to determine whether to read data on construction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>(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 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>(optional) version number. If not specified, will read the first extension that matches hduName. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7f144dbfdaa1a01331adf1bb83a9347a"></a><!-- doxytag: member="CCfits::BinTable::BinTable" ref="a7f144dbfdaa1a01331adf1bb83a9347a" args="(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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::BinTable::BinTable </td>
<td>(</td>
<td class="paramtype">FITSBase * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>hduName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>columnName</em> = <code>std::vector<String>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>columnFmt</em> = <code>std::vector<String>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>columnUnit</em> = <code>std::vector<String>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>version</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>writing constructor </p>
<p>The constructor creates a valid <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> which is ready for <a class="el" href="classCCfits_1_1Column.html#a9415ebdf1c8bab1194f352471a057f6f" title="write a vector of values into a scalar column starting with firstRow">Column::write</a> or insertRows operations. The disk <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file is update accordingly. The data type of each column is determined by the columnFmt argument (TFORM keywords). See cfitsio documentation for acceptable values.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>Pointer to FITSBase class, an internal implementation detail </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduName</em> </td><td>name of <a class="el" href="classCCfits_1_1BinTable.html" title="Class Representing Binary Table Extensions. Contains columns with scalar or vector...">BinTable</a> object to be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>number of rows in the table (NAXIS2) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnName</em> </td><td>array of column names for columns to be constructed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnFmt</em> </td><td>array of column formats for columns to be constructed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnUnit</em> </td><td>(optional) array of units for data in columns. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>(optional) version number for <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>.</td></tr>
</table>
</dd>
</dl>
<p>The dimensions of columnType, columnName and columnFmt must match, but this is not enforced. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a60e89ab762910b76155da983554d433d"></a><!-- doxytag: member="CCfits::BinTable::addColumn" ref="a60e89ab762910b76155da983554d433d" args="(ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=0, size_t columnNumber=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::BinTable::addColumn </td>
<td>(</td>
<td class="paramtype">ValueType </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>columnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>repeatWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>colUnit</em> = <code>String("")</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>decimals</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>columnNumber</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>add a new column to an existing table <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The data type of the column to be added </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnName</em> </td><td>The name of the column to be added </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repeatWidth</em> </td><td>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. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>colUnit</em> </td><td>an optional field specifying the units of the data (TUNITn) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>decimals</em> </td><td>optional parameter specifying the number of decimals for an ascii numeric column </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnNumber</em> </td><td>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. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCCfits_1_1ExtHDU.html#a1a4ee80da434b132a5b9015e3d939c11">CCfits::ExtHDU</a>.</p>
</div>
</div>
<a class="anchor" id="a90cba1f7ee83d3c9f4471e0a2f317391"></a><!-- doxytag: member="CCfits::BinTable::readData" ref="a90cba1f7ee83d3c9f4471e0a2f317391" args="(bool readFlag=false, const std::vector< String > &keys=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::BinTable::readData </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readFlag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>keys</em> = <code>std::vector<String>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read columns and keys specified in the input array. </p>
<p>See <a class="el" href="classCCfits_1_1Table.html">Table</a> class documentation for further details. </p>
<p>Implements <a class="el" href="classCCfits_1_1ExtHDU.html#a166d6a339f64d7d8d4715d33ea75195b">CCfits::ExtHDU</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="BinTable_8h_source.html">BinTable.h</a></li>
<li>BinTable.cxx</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 9 11:59:41 2009 for CCfits by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
ecbd8c5b7568e331fe6ea5b9a07a78a0
>
files
>
40
