<!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::FITS 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_1FITS.html">FITS</a>
</div>
</div>
<div class="contents">
<h1>CCfits::FITS Class Reference</h1><!-- doxytag: class="CCfits::FITS" -->
<p>Memory object representation of a disk <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="FITS_8h_source.html">FITS.h</a>></code></p>
<p><a href="classCCfits_1_1FITS-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="structCCfits_1_1FITS_1_1CantCreate.html">CantCreate</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">thrown on failure to create new file <a href="structCCfits_1_1FITS_1_1CantCreate.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS_1_1CantOpen.html">CantOpen</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">thrown on failure to open existing file <a href="classCCfits_1_1FITS_1_1CantOpen.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS_1_1NoSuchHDU.html">NoSuchHDU</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown by <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> retrieval methods. <a href="classCCfits_1_1FITS_1_1NoSuchHDU.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS_1_1OperationNotSupported.html">OperationNotSupported</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">thrown for unsupported operations, such as attempted to select rows from an image extension. <a href="classCCfits_1_1FITS_1_1OperationNotSupported.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a59493b5e36616b7904ddede84df78430">FITS</a> (const String &name, RWmode mode, const std::vector< String > &searchKeys, const std::vector< String > &searchValues, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< string >(), int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">open fits file and read <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> which contains supplied keywords with [optional] specified values (sometimes one just wants to know that the keyword is present). <a href="#a59493b5e36616b7904ddede84df78430"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a691405118727baad47e504c16998e404">FITS</a> (const string &name, RWmode mode, int hduIndex, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< String >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read a single numbered <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <a href="#a691405118727baad47e504c16998e404"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#aa3dd737a0211193e99d09459b1b09564">FITS</a> (const String &name, int bitpix, int naxis, long *naxes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for creating new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> objects containing images. <a href="#aa3dd737a0211193e99d09459b1b09564"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ab83f4abde51f181d69016a1aa971a290">FITS</a> (const String &name, RWmode mode, const std::vector< String > &hduNames, const std::vector< std::vector< String > > &hduKeys, bool readDataFlag=false, const std::vector< String > &primaryKeys=std::vector< String >(), const std::vector< int > &hduVersions=std::vector< int >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> read constructor in full generality. <a href="#ab83f4abde51f181d69016a1aa971a290"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#acb344d192a9cce91ef4fa70d983af305">FITS</a> (const String &fileName, const <a class="el" href="classCCfits_1_1FITS.html">FITS</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and corresponding file with copy of the primary header of the source If the filename corresponds to an existing file and does not start with the '!' character the construction will fail with a <a class="el" href="structCCfits_1_1FITS_1_1CantCreate.html" title="thrown on failure to create new file">CantCreate</a> exception. <a href="#acb344d192a9cce91ef4fa70d983af305"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a1d7fca4f600df79fce819b86f8727368">FITS</a> (const String &name, RWmode mode, const std::vector< String > &hduNames, bool readDataFlag=false, const std::vector< String > &primaryKey=std::vector< String >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a1cb56c87695f73c6110cdd3dd1fb03b0">FITS</a> (const String &name, RWmode mode, const string &hduName, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< String >(), int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file and read a single specified <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <a href="#a1cb56c87695f73c6110cdd3dd1fb03b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a913bc6d48a4ff69013e49e1ae4fbb696">FITS</a> (const String &name, RWmode mode=Read, bool readDataFlag=false, const std::vector< String > &primaryKeys=std::vector< String >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">basic constructor <a href="#a913bc6d48a4ff69013e49e1ae4fbb696"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53b2988c54661d9e03af4a152da5dbae"></a><!-- doxytag: member="CCfits::FITS::~FITS" ref="a53b2988c54661d9e03af4a152da5dbae" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a53b2988c54661d9e03af4a152da5dbae">~FITS</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#afe53063dd05cf44654a311e5d17d4da8">addImage</a> (const String &hduName, int bpix, std::vector< long > &naxes, int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an image extension to an existing <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. (File with w or rw access). <a href="#afe53063dd05cf44654a311e5d17d4da8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCCfits_1_1Table.html">Table</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a867732f42c7863550baf28795efc6876">addTable</a> (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 >(), HduType type=BinaryTbl, int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a table extension to an existing <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. Add extension to <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object for file with w or rw access. <a href="#a867732f42c7863550baf28795efc6876"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a80ed085f917280e58c6bddf95de93c3c">copy</a> (const <a class="el" href="classCCfits_1_1HDU.html">HDU</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> source into the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. <a href="#a80ed085f917280e58c6bddf95de93c3c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d675f1654f0678461bac0d47e202d49"></a><!-- doxytag: member="CCfits::FITS::currentExtension" ref="a7d675f1654f0678461bac0d47e202d49" args="()" -->
<a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a7d675f1654f0678461bac0d47e202d49">currentExtension</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a non-const reference to whichever is the current extension. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#afc795a249942094157a54fedb6325eb0">currentExtensionName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the name of the extension that the fitsfile is currently addressing. <a href="#afc795a249942094157a54fedb6325eb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ad865b86fabd85a36b6e3ec782a3fad83">deleteExtension</a> (int doomed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete extension specified by extension number. <a href="#ad865b86fabd85a36b6e3ec782a3fad83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#aac73f0a1f2742c0f1ea5eeb5bc0f8df5">deleteExtension</a> (const String &doomed, int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete extension specified by name and version number. <a href="#aac73f0a1f2742c0f1ea5eeb5bc0f8df5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#afbc014a0dd8bfcc9d883e550f971f669">destroy</a> () throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Erase <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and close corresponding file. <a href="#afbc014a0dd8bfcc9d883e550f971f669"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const ExtMap & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a5e4b2efb2d9c75db28fe264cb8576280">extension</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return const reference to the extension container <a href="#a5e4b2efb2d9c75db28fe264cb8576280"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21ee1ab28908eb2ed74b5f88cfcc97bf"></a><!-- doxytag: member="CCfits::FITS::extension" ref="a21ee1ab28908eb2ed74b5f88cfcc97bf" args="(const String &hduName, int version=1)" -->
<a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a21ee1ab28908eb2ed74b5f88cfcc97bf">extension</a> (const String &hduName, int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension by name and (optionally) version number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af29d26cb351ba86544648203d5dbf5dc"></a><!-- doxytag: member="CCfits::FITS::extension" ref="af29d26cb351ba86544648203d5dbf5dc" args="(const String &hduName, int version=1) const " -->
const <a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#af29d26cb351ba86544648203d5dbf5dc">extension</a> (const String &hduName, int version=1) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension by name and (optionally) version number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b5b4cccb7912bb0cf8c03600e2f89b4"></a><!-- doxytag: member="CCfits::FITS::extension" ref="a4b5b4cccb7912bb0cf8c03600e2f89b4" args="(int i)" -->
<a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a4b5b4cccb7912bb0cf8c03600e2f89b4">extension</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension by index number. non-const version. see const version for details. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17d7f2a579835881a3b74c765ac612e1"></a><!-- doxytag: member="CCfits::FITS::extension" ref="a17d7f2a579835881a3b74c765ac612e1" args="(int i) const " -->
const <a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a17d7f2a579835881a3b74c765ac612e1">extension</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension by index number. N.B. The input index number is currently defined as enumerating extensions, so the extension(1) returns <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> number 2. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCCfits_1_1Table.html">Table</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#add1f740bb5706da76773951cbb1f5f89">filter</a> (const String &expression, <a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> &inputTable, bool overwrite=true, bool readData=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Filter the rows of the inputTable with the condition expression, and return a reference to the resulting <a class="el" href="classCCfits_1_1Table.html">Table</a>. <a href="#add1f740bb5706da76773951cbb1f5f89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10cc4bf1ef07a50ea79d3bfaa57a844f"></a><!-- doxytag: member="CCfits::FITS::fitsPointer" ref="a10cc4bf1ef07a50ea79d3bfaa57a844f" args="() const " -->
fitsfile * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a10cc4bf1ef07a50ea79d3bfaa57a844f">fitsPointer</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the CFITSIO fitsfile pointer for this <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a2df185878082d2dabe76f3f25600311b">flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">flush buffer contents to disk <a href="#a2df185878082d2dabe76f3f25600311b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a785184269e4cdf607cb844b5b45ad105"></a><!-- doxytag: member="CCfits::FITS::getCompressionType" ref="a785184269e4cdf607cb844b5b45ad105" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a785184269e4cdf607cb844b5b45ad105">getCompressionType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the int specifying the compression algorithm to be used when adding an image extension. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4af2b8fb489f7fbfeabc1a381c94834c"></a><!-- doxytag: member="CCfits::FITS::getNoiseBits" ref="a4af2b8fb489f7fbfeabc1a381c94834c" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a4af2b8fb489f7fbfeabc1a381c94834c">getNoiseBits</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the cfitsio noisebits parameter used when compressing floating-point images. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a879b8f7cb81cfbc781e8a7b6c6982ca9">getTileDimensions</a> (std::vector< long > &tileSizes) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current settings of dimension sizes for tiles used in image compression. <a href="#a879b8f7cb81cfbc781e8a7b6c6982ca9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46ee9a7cb851501eb921149f1173d11d"></a><!-- doxytag: member="CCfits::FITS::name" ref="a46ee9a7cb851501eb921149f1173d11d" args="() const " -->
const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a46ee9a7cb851501eb921149f1173d11d">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return filename of file corresponding to <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69714491156b3f1452f37f9277505925"></a><!-- doxytag: member="CCfits::FITS::pHDU" ref="a69714491156b3f1452f37f9277505925" args="()" -->
<a class="el" href="classCCfits_1_1PHDU.html">PHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a69714491156b3f1452f37f9277505925">pHDU</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to the primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18d1d822d3eecbf6298f974504863c05"></a><!-- doxytag: member="CCfits::FITS::pHDU" ref="a18d1d822d3eecbf6298f974504863c05" args="() const " -->
const <a class="el" href="classCCfits_1_1PHDU.html">PHDU</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a18d1d822d3eecbf6298f974504863c05">pHDU</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a const reference to the primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a6237260607e157ec5f521522f137f09c">read</a> (const std::vector< String > &searchKeys, const std::vector< String > &searchValues, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read method for read header or <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> that contains specified keywords. <a href="#a6237260607e157ec5f521522f137f09c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#adafc3aecf2d2398109d2c42f6025f2e5">read</a> (int hduIndex, bool readDataFlag=false, const std::vector< String > &keys=std::vector< String >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read an <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> specified by index number. <a href="#adafc3aecf2d2398109d2c42f6025f2e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a6e3ebb1d61fd6374c0f1033ba0777112">read</a> (const std::vector< String > &hduNames, const std::vector< std::vector< String > > &keys, bool readDataFlag=false, const std::vector< int > &hduVersions=std::vector< int >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get data from a set of HDUs from disk file, specifying keys and version numbers. <a href="#a6e3ebb1d61fd6374c0f1033ba0777112"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ac592041903c94b09cee8cdc29e185b0a">read</a> (const std::vector< String > &hduNames, bool readDataFlag=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get data from a set of HDUs from disk file. <a href="#ac592041903c94b09cee8cdc29e185b0a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a3640e3ad1c29931b37a13ac91106504e">read</a> (const String &hduName, bool readDataFlag=false, const std::vector< String > &keys=std::vector< String >(), int version=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get data from single <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> from disk file. <a href="#a3640e3ad1c29931b37a13ac91106504e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d5050b4a572ea98e0c830295894c142"></a><!-- doxytag: member="CCfits::FITS::resetPosition" ref="a9d5050b4a572ea98e0c830295894c142" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a9d5050b4a572ea98e0c830295894c142">resetPosition</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">explicit call to set the fits file pointer to the primary. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ad65169c171ad79257367716d8f93b3f2">setCompressionType</a> (int compType)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the compression algorithm to be used when adding image extensions to the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. <a href="#ad65169c171ad79257367716d8f93b3f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a224f6b22c1c3129c07c077d4b5617d2f">setNoiseBits</a> (int noiseBits)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the cfitsio noisebits parameter used when compressing floating-point images. <a href="#a224f6b22c1c3129c07c077d4b5617d2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#aa0bfb6b1a6dc55c585482ba703773f50">setTileDimensions</a> (const std::vector< long > &tileSizes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the dimensions of the tiles into which the image is divided during compression. <a href="#aa0bfb6b1a6dc55c585482ba703773f50"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f151c247fb7d0b13cd7c1d5994417d1"></a><!-- doxytag: member="CCfits::FITS::clearErrors" ref="a6f151c247fb7d0b13cd7c1d5994417d1" args="()" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#a6f151c247fb7d0b13cd7c1d5994417d1">clearErrors</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clear the error stack and set status to zero. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0e7b06ebbb6097ed6fa2fd555af4ca3"></a><!-- doxytag: member="CCfits::FITS::setVerboseMode" ref="ab0e7b06ebbb6097ed6fa2fd555af4ca3" args="(bool value)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ab0e7b06ebbb6097ed6fa2fd555af4ca3">setVerboseMode</a> (bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set verbose setting for library <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1FITS.html#ac897e39e93234792d519913e656be5fc">verboseMode</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return verbose setting for library <a href="#ac897e39e93234792d519913e656be5fc"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Memory object representation of a disk <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file. </p>
<p>Constructors are provided to get <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> data from an existing file or to create new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> data sets. Overloaded versions allow the user to</p>
<p>a) read from one or more specified extensions, specified by EXTNAME and VERSION or by <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> number. b either just header information or data on construction c) to specify scalar keyword values to be read on construction d) to open and read an extension that has specified keyword values e) create a new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and corresponding file, including an empty primary header.</p>
<p>The memory fits object as constructed is always an image of a valid <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object, i.e. a primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> is created on construction.</p>
<p>calling the destructor closes the disk file, so that <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> files are automatically deleted at the end of scope unless other arrangements are made. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a913bc6d48a4ff69013e49e1ae4fbb696"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="a913bc6d48a4ff69013e49e1ae4fbb696" args="(const String &name, RWmode mode=Read, bool readDataFlag=false, const std::vector< String > &primaryKeys=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</em> = <code>Read</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>primaryKeys</em> = <code>std::vector<String>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>basic constructor </p>
<p>This basic constructor makes a <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object from the given filename. If the mode is Read [default], it will read all of the headers in the file, and all of the data if the readDataFlag is supplied as true. It will also read optional primary keys.</p>
<p>The filename string is passed directly to the cfitsio library: thus the extended filename syntax described in the cfitsio manual should work as documented. (Though the extended file name feature which allows the opening of a particular image located in the row of a table is currently unsupported.) If in Read mode and the extended syntax selects a particular extension, that extension will become the current <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> position upon construction.</p>
<p>The file name is the only required argument. If the mode is Write and the file does not already exist, a default primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> will be created in the file with BITPIX=8 and NAXIS=0: this mode is designed for writing <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> files with table extensions only. For files with image data the constructor that specified the data type and number of axes should be called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file to be read/written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The read/write mode: must be Read or Write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>readDataFlag</em> </td><td>boolean: read data on construction if true </td></tr>
<tr><td valign="top"></td><td valign="top"><em>primaryKeys</em> </td><td>Allows optional reading of primary header keys on construction</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCCfits_1_1FITS_1_1NoSuchHDU.html" title="exception thrown by HDU retrieval methods.">NoSuchHDU</a></em> </td><td>thrown on <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> seek error either by index or {name,version} </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCCfits_1_1FitsError.html" title="FitsError is the exception thrown by non-zero cfitsio status codes.">FitsError</a></em> </td><td>thrown on non-zero status code from cfitsio when not overriden by <a class="el" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a> error to produce more illuminating message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1cb56c87695f73c6110cdd3dd1fb03b0"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="a1cb56c87695f73c6110cdd3dd1fb03b0" args="(const String &name, RWmode mode, const string &hduName, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< String >(), int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</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">bool </td>
<td class="paramname"> <em>readDataFlag</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>hduKeys</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>primaryKey</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file and read a single specified <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. </p>
<p>This and similar constructor variants support reading table data.</p>
<p>Optional arguments allow the reading of primary header keys and specified data from hduName, the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> to be read. An object representing the primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> is always created: if it contains an image, that image may be read by subsequent calls.</p>
<p>If extended file name syntax is used and selects an extension other than hduName, a <a class="el" href="classCCfits_1_1FITS_1_1OperationNotSupported.html" title="thrown for unsupported operations, such as attempted to select rows from an image...">FITS::OperationNotSupported</a> exception will be thrown.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file to be read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The read/write mode: takes values Read or Write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduName</em> </td><td>The name of the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduKeys</em> </td><td>Optional array of keywords to be read from the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>Optional version number. If not supplied the first <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> with name <em>hduName</em> is read see above for other parameter definitions </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1d7fca4f600df79fce819b86f8727368"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="a1d7fca4f600df79fce819b86f8727368" args="(const String &name, RWmode mode, const std::vector< String > &hduNames, bool readDataFlag=false, const std::vector< String > &primaryKey=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>hduNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>primaryKey</em> = <code>std::vector<String>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is intended as a convenience where the file consists of single versions of HDUs and data only, not keys are to be read.</p>
<p>If extended file name syntax is used and selects an extension not listed in hduNames, a <a class="el" href="classCCfits_1_1FITS_1_1OperationNotSupported.html" title="thrown for unsupported operations, such as attempted to select rows from an image...">FITS::OperationNotSupported</a> exception will be thrown. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hduNames</em> </td><td>array of <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> names to be read.</td></tr>
</table>
</dd>
</dl>
<p>see above for other parameter definitions. </p>
</div>
</div>
<a class="anchor" id="acb344d192a9cce91ef4fa70d983af305"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="acb344d192a9cce91ef4fa70d983af305" args="(const String &fileName, const FITS &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCCfits_1_1FITS.html">FITS</a> & </td>
<td class="paramname"> <em>source</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>create a new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and corresponding file with copy of the primary header of the source If the filename corresponds to an existing file and does not start with the '!' character the construction will fail with a <a class="el" href="structCCfits_1_1FITS_1_1CantCreate.html" title="thrown on failure to create new file">CantCreate</a> exception. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fileName</em> </td><td>New file to be created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>A previously created <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object to be copied.</td></tr>
</table>
</dd>
</dl>
<p>see above for other parameter definitions. </p>
</div>
</div>
<a class="anchor" id="ab83f4abde51f181d69016a1aa971a290"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="ab83f4abde51f181d69016a1aa971a290" args="(const String &name, RWmode mode, const std::vector< String > &hduNames, const std::vector< std::vector< String > > &hduKeys, bool readDataFlag=false, const std::vector< String > &primaryKeys=std::vector< String >(), const std::vector< int > &hduVersions=std::vector< int >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>hduNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< std::vector< String > > & </td>
<td class="paramname"> <em>hduKeys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>primaryKeys</em> = <code>std::vector<String>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"> <em>hduVersions</em> = <code>std::vector<int>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> read constructor in full generality. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hduVersions</em> </td><td>an optional version number for each <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> to be read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduKeys</em> </td><td>an array of keywords for each <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> to be read. see above for other parameter definitions. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa3dd737a0211193e99d09459b1b09564"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="aa3dd737a0211193e99d09459b1b09564" args="(const String &name, int bitpix, int naxis, long *naxes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>bitpix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>naxis</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"> <em>naxes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for creating new <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> objects containing images. </p>
<p>This constructor is only called for creating new files (mode is not an argument) and creates a new primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> with the datatype & axes specified by bitpix, naxis, and naxes. The data are added to the new fits object and file by subsequent calls to <a class="el" href="classCCfits_1_1FITS.html#a69714491156b3f1452f37f9277505925" title="return a reference to the primary HDU.">FITS::pHDU()</a>.write( <arguments> )</p>
<p>A file with a compressed image may be creating by appending to the end of the file name the same "[compress ...]" syntax specified in the cfitsio manual. Note however that the compressed image will be placed in the first extension and NOT in the primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>.</p>
<p>If the filename corresponds to an existing file and does not start with the '!' character the construction will fail with a <a class="el" href="structCCfits_1_1FITS_1_1CantCreate.html" title="thrown on failure to create new file">CantCreate</a> exception.</p>
<p>The arguments are: </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The file to be written to disk </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bitpix</em> </td><td>the datatype of the primary image. <em>bitpix</em> may be one of the following CFITSIO constants: BYTE_IMG, SHORT_IMG, LONG_IMG, FLOAT_IMG, DOUBLE_IMG, USHORT_IMG, ULONG_IMG. Note that if you send in a <em>bitpix</em> of USHORT_IMG or ULONG_IMG, CCfits will set <a class="el" href="classCCfits_1_1HDU.html#a81a2d5b001c0ae7d0a298942940189d8" title="return the data type keyword.">HDU::bitpix()</a> to its signed equivalent (SHORT_IMG or LONG_IMG), and then set BZERO to 2^15 or 2^31.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>naxis</em> </td><td>the data dimension of the primary image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>naxes</em> </td><td>the array of axis lengths for the primary image. Ignored if naxis =0, i.e. the primary header is empty. extensions can be added arbitrarily to the file after this constructor is called. The constructors should write header information to disk: </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a691405118727baad47e504c16998e404"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="a691405118727baad47e504c16998e404" args="(const string &name, RWmode mode, int hduIndex, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>hduIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>hduKeys</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>primaryKey</em> = <code>std::vector<String>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read a single numbered <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. </p>
<p>Constructor analogous to the version that reads by name. This is required since <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> extensions are not required to have the EXTNAME or HDUNAME keyword by the standard. If there is no name, a dummy name based on the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> number is created and becomes the key.</p>
<p>If extended file name syntax is used and selects an extension other than hduIndex, a <a class="el" href="classCCfits_1_1FITS_1_1OperationNotSupported.html" title="thrown for unsupported operations, such as attempted to select rows from an image...">FITS::OperationNotSupported</a> exception will be thrown.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hduIndex</em> </td><td>The index of the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> to be read. see above for other parameter definitions. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a59493b5e36616b7904ddede84df78430"></a><!-- doxytag: member="CCfits::FITS::FITS" ref="a59493b5e36616b7904ddede84df78430" args="(const String &name, RWmode mode, const std::vector< String > &searchKeys, const std::vector< String > &searchValues, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), const std::vector< String > &primaryKey=std::vector< string >(), int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::FITS </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RWmode </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>searchKeys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>searchValues</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>hduKeys</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>primaryKey</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>open fits file and read <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> which contains supplied keywords with [optional] specified values (sometimes one just wants to know that the keyword is present). </p>
<p>Optional parameters allows the reading of specified primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> keys and specified columns and keywords in the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> of interest.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file to be read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The read/write mode: must be Read or Write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchKeys</em> </td><td>A string vector of keywords to search for in each header</td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchValues</em> </td><td>A string vector of values those keywords are required to have for success. Note that the keys must be of type string. If any value does not need to be checked the corresponding searchValue element can be empty. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>readDataFlag</em> </td><td>boolean: if true, read data if <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> is found </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduKeys</em> </td><td>Allows optional reading of keys in the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> that is searched for if it is successfully found </td></tr>
<tr><td valign="top"></td><td valign="top"><em>primaryKey</em> </td><td>Allows optional reading of primary header keys on construction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>Optional version number. If specified, checks the EXTVERS keyword.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCCfits_1_1FitsError.html" title="FitsError is the exception thrown by non-zero cfitsio status codes.">FitsError</a></em> </td><td>thrown on non-zero status code from cfitsio when not overriden by <a class="el" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a> error to produce more illuminating message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afe53063dd05cf44654a311e5d17d4da8"></a><!-- doxytag: member="CCfits::FITS::addImage" ref="afe53063dd05cf44654a311e5d17d4da8" args="(const String &hduName, int bpix, std::vector< long > &naxes, int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::addImage </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>bpix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< long > & </td>
<td class="paramname"> <em>naxes</em>, </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an image extension to an existing <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. (File with w or rw access). </p>
<p>Does not make primary images, which are built in the constructor for the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file. The image data is not added here: it can be added by a call to one of the <a class="el" href="classCCfits_1_1ExtHDU.html#a444e15ad4193a0bef47067c7a3f753d3" title="Write a set of pixels to an image extension with the first pixel specified by an...">ExtHDU::write</a> functions.</p>
<p><em>bpix</em> may be one of the following CFITSIO constants: BYTE_IMG, SHORT_IMG, LONG_IMG, FLOAT_IMG, DOUBLE_IMG, USHORT_IMG, ULONG_IMG. Note that if you send in a <em>bpix</em> of USHORT_IMG or ULONG_IMG, CCfits will set <a class="el" href="classCCfits_1_1HDU.html#a81a2d5b001c0ae7d0a298942940189d8" title="return the data type keyword.">HDU::bitpix()</a> to its signed equivalent (SHORT_IMG or LONG_IMG), and then set BZERO to 2^15 or 2^31.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Add a function for replacing the primary image </dd></dl>
</div>
</div>
<a class="anchor" id="a867732f42c7863550baf28795efc6876"></a><!-- doxytag: member="CCfits::FITS::addTable" ref="a867732f42c7863550baf28795efc6876" args="(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 >(), HduType type=BinaryTbl, int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCCfits_1_1Table.html">Table</a> * CCfits::FITS::addTable </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">HduType </td>
<td class="paramname"> <em>type</em> = <code>BinaryTbl</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a table extension to an existing <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. Add extension to <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object for file with w or rw access. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>The number of rows in the table to be created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnName</em> </td><td>A vector containing the table column names </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnFmt</em> </td><td>A vector containing the table column formats </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnUnit</em> </td><td>(Optional) a vector giving the units of the columns. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The table type - AsciiTbl or BinaryTbl (defaults to BinaryTbl) the lists of columns are optional - one can create an empty table extension but if supplied, colType, columnName and colFmt must have equal dimensions.</td></tr>
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>the code should one day check that the version keyword is higher than any other versions already added to the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object (although cfitsio doesn't do this either).</dd></dl>
</div>
</div>
<a class="anchor" id="a80ed085f917280e58c6bddf95de93c3c"></a><!-- doxytag: member="CCfits::FITS::copy" ref="a80ed085f917280e58c6bddf95de93c3c" args="(const HDU &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::copy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCCfits_1_1HDU.html">HDU</a> & </td>
<td class="paramname"> <em>source</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>copy the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> source into the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. </p>
<p>This function adds a copy of an <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> from another file into *this. It does not create a duplicate of an <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> in the file associated with *this. </p>
</div>
</div>
<a class="anchor" id="afc795a249942094157a54fedb6325eb0"></a><!-- doxytag: member="CCfits::FITS::currentExtensionName" ref="afc795a249942094157a54fedb6325eb0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const String & CCfits::FITS::currentExtensionName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the name of the extension that the fitsfile is currently addressing. </p>
<p>If the extension in question does not have an EXTNAME or HDUNAME keyword, then the function returns $HDU$n, where n is the sequential <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> index number (primary <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> = 0). </p>
</div>
</div>
<a class="anchor" id="ad865b86fabd85a36b6e3ec782a3fad83"></a><!-- doxytag: member="CCfits::FITS::deleteExtension" ref="ad865b86fabd85a36b6e3ec782a3fad83" args="(int doomed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::deleteExtension </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>doomed</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete extension specified by extension number. </p>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
</div>
</div>
<a class="anchor" id="aac73f0a1f2742c0f1ea5eeb5bc0f8df5"></a><!-- doxytag: member="CCfits::FITS::deleteExtension" ref="aac73f0a1f2742c0f1ea5eeb5bc0f8df5" args="(const String &doomed, int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::deleteExtension </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>doomed</em>, </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete extension specified by name and version number. </p>
<p>Removes extension from <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and memory copy.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>doomed</em> </td><td>the name of the extension to be deleted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>an optional version number, the EXTVER keyword, defaults to 1</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCCfits_1_1FITS_1_1NoSuchHDU.html" title="exception thrown by HDU retrieval methods.">NoSuchHDU</a></em> </td><td>Thrown if there is no extension with the specified version number </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCCfits_1_1FitsError.html" title="FitsError is the exception thrown by non-zero cfitsio status codes.">FitsError</a></em> </td><td>Thrown if there is a non-zero status code from cfitsio, e.g. if the delete operation is applied to a <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> file opened for read only access. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afbc014a0dd8bfcc9d883e550f971f669"></a><!-- doxytag: member="CCfits::FITS::destroy" ref="afbc014a0dd8bfcc9d883e550f971f669" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::destroy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Erase <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object and close corresponding file. </p>
<p>Force deallocation and erase of elements of a <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> memory object. Allows a reset of everything inside the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object, and closes the file. The object is inaccessible after this call.</p>
<p>destroy is public to allow users to reuse a symbol for a new file, but it is identical in operation to the destructor. </p>
</div>
</div>
<a class="anchor" id="a5e4b2efb2d9c75db28fe264cb8576280"></a><!-- doxytag: member="CCfits::FITS::extension" ref="a5e4b2efb2d9c75db28fe264cb8576280" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::multimap< std::String, <a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> * > & CCfits::FITS::extension </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return const reference to the extension container </p>
<p>This is useful for such operations as <a class="el" href="classCCfits_1_1FITS.html#a17d7f2a579835881a3b74c765ac612e1" title="return FITS extension by index number. N.B. The input index number is currently defined...">extension()</a>.size() etc. </p>
</div>
</div>
<a class="anchor" id="add1f740bb5706da76773951cbb1f5f89"></a><!-- doxytag: member="CCfits::FITS::filter" ref="add1f740bb5706da76773951cbb1f5f89" args="(const String &expression, ExtHDU &inputTable, bool overwrite=true, bool readData=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCCfits_1_1Table.html">Table</a> & CCfits::FITS::filter </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>expression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> & </td>
<td class="paramname"> <em>inputTable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>overwrite</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readData</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Filter the rows of the inputTable with the condition expression, and return a reference to the resulting <a class="el" href="classCCfits_1_1Table.html">Table</a>. </p>
<p>This function provides an object oriented version of cfitsio's fits_select_rows call. The expression string is any boolean expression involving the names of the columns in the input table (e.g., if there were a column called "density", a valid expression might be "DENSITY > 3.5": see the cfitsio documentation for further details).</p>
<p>[N.B. the "append" functionality described below does not work when linked with cfitsio 2.202 or prior because of a known issue with that version of the library. This causes the output to be a new extension with a correct header copy and version number but without the filtered data]. If the inputTable is an Extension <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> of this <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object, then if overwrite is true the operation will overwrite the inputTable with the filtered version, otherwise it will append a new <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> with the same extension name but the next highest version (EXTVER) number available. </p>
</div>
</div>
<a class="anchor" id="a2df185878082d2dabe76f3f25600311b"></a><!-- doxytag: member="CCfits::FITS::flush" ref="a2df185878082d2dabe76f3f25600311b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::flush </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>flush buffer contents to disk </p>
<p>Provides manual control of disk writing operation. Image data are flushed automatically to disk after the write operation is completed, but not column data. </p>
</div>
</div>
<a class="anchor" id="a879b8f7cb81cfbc781e8a7b6c6982ca9"></a><!-- doxytag: member="CCfits::FITS::getTileDimensions" ref="a879b8f7cb81cfbc781e8a7b6c6982ca9" args="(std::vector< long > &tileSizes) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::getTileDimensions </td>
<td>(</td>
<td class="paramtype">std::vector< long > & </td>
<td class="paramname"> <em>tileSizes</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current settings of dimension sizes for tiles used in image compression. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tileSizes</em> </td><td>A vector to be filled with cfitsio's current tile dimension settings. CCfits will resize this vector to contain the proper number of values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6237260607e157ec5f521522f137f09c"></a><!-- doxytag: member="CCfits::FITS::read" ref="a6237260607e157ec5f521522f137f09c" args="(const std::vector< String > &searchKeys, const std::vector< String > &searchValues, bool readDataFlag=false, const std::vector< String > &hduKeys=std::vector< String >(), int version=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::FITS::read </td>
<td>(</td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>searchKeys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>searchValues</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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>hduKeys</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read method for read header or <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> that contains specified keywords. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>searchKeys</em> </td><td>A string vector of keywords to search for in each header</td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchValues</em> </td><td>A string vector of values those keywords are required to have for success. Note that the keys must be of type string. If any value does not need to be checked the corresponding searchValue element can be empty. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>readDataFlag</em> </td><td>boolean: if true, read data if <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> is found </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hduKeys</em> </td><td>Allows optional reading of keys in the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> that is searched for if it is successfully found </td></tr>
<tr><td valign="top"></td><td valign="top"><em>version</em> </td><td>Optional version number. If specified, checks the EXTVERS keyword. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adafc3aecf2d2398109d2c42f6025f2e5"></a><!-- doxytag: member="CCfits::FITS::read" ref="adafc3aecf2d2398109d2c42f6025f2e5" args="(int hduIndex, bool readDataFlag=false, const std::vector< String > &keys=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::read </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>hduIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read an <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> specified by index number. </p>
<p>This is provided to allow reading of HDUs after construction. see above for parameter definitions. </p>
</div>
</div>
<a class="anchor" id="a6e3ebb1d61fd6374c0f1033ba0777112"></a><!-- doxytag: member="CCfits::FITS::read" ref="a6e3ebb1d61fd6374c0f1033ba0777112" args="(const std::vector< String > &hduNames, const std::vector< std::vector< String > > &keys, bool readDataFlag=false, const std::vector< int > &hduVersions=std::vector< int >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::read </td>
<td>(</td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>hduNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< std::vector< String > > & </td>
<td class="paramname"> <em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"> <em>hduVersions</em> = <code>std::vector<int>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get data from a set of HDUs from disk file, specifying keys and version numbers. </p>
<p>This is provided to allow reading of HDUs after construction. see above for parameter definitions. </p>
</div>
</div>
<a class="anchor" id="ac592041903c94b09cee8cdc29e185b0a"></a><!-- doxytag: member="CCfits::FITS::read" ref="ac592041903c94b09cee8cdc29e185b0a" args="(const std::vector< String > &hduNames, bool readDataFlag=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::read </td>
<td>(</td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>hduNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readDataFlag</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get data from a set of HDUs from disk file. </p>
<p>This is provided to allow reading of HDUs after construction. see above for parameter definitions. </p>
</div>
</div>
<a class="anchor" id="a3640e3ad1c29931b37a13ac91106504e"></a><!-- doxytag: member="CCfits::FITS::read" ref="a3640e3ad1c29931b37a13ac91106504e" args="(const String &hduName, bool readDataFlag=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">void CCfits::FITS::read </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">bool </td>
<td class="paramname"> <em>readDataFlag</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get data from single <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> from disk file. </p>
<p>This is provided to allow the adding of additional HDUs to the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object after construction of the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. After the <a class="el" href="classCCfits_1_1FITS.html#a3640e3ad1c29931b37a13ac91106504e" title="get data from single HDU from disk file.">read()</a> functions have been called for the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object, subsequent read method to the Primary, <a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a>, and <a class="el" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a> objects will retrieve data from the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object in memory (those methods can be called to read data in those <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> objects that was not read when the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> objects were constructed.</p>
<p>All the read functions will throw <a class="el" href="classCCfits_1_1FITS_1_1NoSuchHDU.html" title="exception thrown by HDU retrieval methods.">NoSuchHDU</a> exceptions on seek errors since they involve constructing <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> objects.</p>
<p>The parameter definitions are as documented for the corresponding constructor. </p>
</div>
</div>
<a class="anchor" id="ad65169c171ad79257367716d8f93b3f2"></a><!-- doxytag: member="CCfits::FITS::setCompressionType" ref="ad65169c171ad79257367716d8f93b3f2" args="(int compType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::setCompressionType </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>compType</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set the compression algorithm to be used when adding image extensions to the <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>compType</em> </td><td>Currently 3 symbolic constants are defined in cfitsio for specifying compression algorithms: GZIP_1, RICE_1, and PLIO_1. See the cfitsio documentation for more information about these algorithms. Entering NULL for compType will turn off compression and cause normal <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> images to be written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a224f6b22c1c3129c07c077d4b5617d2f"></a><!-- doxytag: member="CCfits::FITS::setNoiseBits" ref="a224f6b22c1c3129c07c077d4b5617d2f" args="(int noiseBits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::setNoiseBits </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noiseBits</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the cfitsio noisebits parameter used when compressing floating-point images. </p>
<p>The default value is 4. Decreasing the value of noisebits will improve the overall compression efficiency at the expense of losing more information. </p>
</div>
</div>
<a class="anchor" id="aa0bfb6b1a6dc55c585482ba703773f50"></a><!-- doxytag: member="CCfits::FITS::setTileDimensions" ref="aa0bfb6b1a6dc55c585482ba703773f50" args="(const std::vector< long > &tileSizes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::FITS::setTileDimensions </td>
<td>(</td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>tileSizes</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the dimensions of the tiles into which the image is divided during compression. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tileSizes</em> </td><td>A vector of length N containing the tile dimesions. If N is less than the number of dimensions of the image it is applied to, the unspecified dimensions will be assigned a size of 1 pixel. If N is larger than the number of image dimensions, the extra dimensions will be ignored.</td></tr>
</table>
</dd>
</dl>
<p>The default cfitsio behavior is to create tiles with dimensions NAXIS1 x 1 x 1 etc. up to the number of image dimensions. </p>
</div>
</div>
<a class="anchor" id="ac897e39e93234792d519913e656be5fc"></a><!-- doxytag: member="CCfits::FITS::verboseMode" ref="ac897e39e93234792d519913e656be5fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CCfits::FITS::verboseMode </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return verbose setting for library </p>
<p>If true, all messages that are reported by exceptions are printed to std::cerr. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FITS_8h_source.html">FITS.h</a></li>
<li>FITS.cxx</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 9 11:59:44 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
>
74
