<!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::ExtHDU 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_1ExtHDU.html">ExtHDU</a>
</div>
</div>
<div class="contents">
<h1>CCfits::ExtHDU Class Reference</h1><!-- doxytag: class="CCfits::ExtHDU" --><!-- doxytag: inherits="CCfits::HDU" -->
<p>base class for all <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension HDUs, i.e. Image Extensions and Tables.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="ExtHDU_8h_source.html">ExtHDU.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCfits::ExtHDU:</div>
<div class="dynsection">
<div class="center">
<img src="classCCfits_1_1ExtHDU.gif" alt="Inheritance diagram" usemap="#CCfits::ExtHDU_map" alt=""/>
<map id="CCfits::ExtHDU_map" name="CCfits::ExtHDU_map">
<area href="classCCfits_1_1HDU.html" alt="CCfits::HDU" shape="rect" coords="71,0,204,24"/>
<area href="classCCfits_1_1ImageExt.html" alt="CCfits::ImageExt< T >" shape="rect" coords="0,112,133,136"/>
<area href="classCCfits_1_1Table.html" alt="CCfits::Table" shape="rect" coords="143,112,276,136"/>
<area href="classCCfits_1_1AsciiTable.html" alt="CCfits::AsciiTable" shape="rect" coords="71,168,204,192"/>
<area href="classCCfits_1_1BinTable.html" alt="CCfits::BinTable" shape="rect" coords="214,168,347,192"/>
</map>
</div>
</div>
<p><a href="classCCfits_1_1ExtHDU-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="classCCfits_1_1ExtHDU_1_1WrongExtensionType.html">WrongExtensionType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exception to be thrown on unmatched extension types. <a href="classCCfits_1_1ExtHDU_1_1WrongExtensionType.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"><a class="anchor" id="a58be2cbfe5c11246e8c2269e3ffe69ee"></a><!-- doxytag: member="CCfits::ExtHDU::ExtHDU" ref="a58be2cbfe5c11246e8c2269e3ffe69ee" args="(const ExtHDU &right)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a58be2cbfe5c11246e8c2269e3ffe69ee">ExtHDU</a> (const <a class="el" href="classCCfits_1_1ExtHDU.html">ExtHDU</a> &right)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99d509bf1374ace30a48508dffad25d5"></a><!-- doxytag: member="CCfits::ExtHDU::~ExtHDU" ref="a99d509bf1374ace30a48508dffad25d5" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a99d509bf1374ace30a48508dffad25d5">~ExtHDU</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <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_1ExtHDU.html#a1a4ee80da434b132a5b9015e3d939c11">addColumn</a> (ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=-1, 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="#a1a4ee80da434b132a5b9015e3d939c11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada85c7b4b9b38f6e410db8794779ed60"></a><!-- doxytag: member="CCfits::ExtHDU::clone" ref="ada85c7b4b9b38f6e410db8794779ed60" args="(FITSBase *p) const =0" -->
virtual <a class="el" href="classCCfits_1_1HDU.html">HDU</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#ada85c7b4b9b38f6e410db8794779ed60">clone</a> (FITSBase *p) const =0</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 const std::map< string, <br class="typebreak"/>
<a class="el" href="classCCfits_1_1Column.html">Column</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#ab121d5ab64abcc0a5df4ca7955bec2e9">column</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to the array containing the columns. <a href="#ab121d5ab64abcc0a5df4ca7955bec2e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCCfits_1_1Column.html">Column</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a06d5f1ebd32e0228790c8b4e4b57e2e4">column</a> (int colIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to a <a class="el" href="classCCfits_1_1Table.html">Table</a> column specified by column index. <a href="#a06d5f1ebd32e0228790c8b4e4b57e2e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCCfits_1_1Column.html">Column</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a9d3f8b23a32aa7303b0824fa6cb2f21b">column</a> (const String &colName, bool caseSensitive=true) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to a <a class="el" href="classCCfits_1_1Table.html">Table</a> column specified by name. <a href="#a9d3f8b23a32aa7303b0824fa6cb2f21b"></a><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_1ExtHDU.html#aaee3fda1eb075ef4ee7a9178114bd00d">deleteColumn</a> (const String &columnName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">delete a column in a <a class="el" href="classCCfits_1_1Table.html">Table</a> extension by name. <a href="#aaee3fda1eb075ef4ee7a9178114bd00d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a5a480387701525f75ea450dac7510f23">getRowsize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the optimal number of rows to read or write at a time <a href="#a5a480387701525f75ea450dac7510f23"></a><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_1ExtHDU.html#a16730a075858cd50bfa3daad60c0a1c0">makeThisCurrent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">move the fitsfile pointer to this current <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. <a href="#a16730a075858cd50bfa3daad60c0a1c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1128c49f0381473feff2cd9e5650dce"></a><!-- doxytag: member="CCfits::ExtHDU::name" ref="af1128c49f0381473feff2cd9e5650dce" args="() const " -->
const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#af1128c49f0381473feff2cd9e5650dce">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the name of the extension. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#af63318f88dad6665781c9d699324a3a3">numCols</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of Columns in the <a class="el" href="classCCfits_1_1Table.html">Table</a> (the TFIELDS keyword). <a href="#af63318f88dad6665781c9d699324a3a3"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a95e674b5441a6f9f756655c8774f6040">read</a> (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride, S *nullValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read an image subset into valarray image, processing null values <a href="#a95e674b5441a6f9f756655c8774f6040"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="afa40cf29e2f195c1edb0fb2f3454c358"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="afa40cf29e2f195c1edb0fb2f3454c358" args="(std::valarray< S > &image, const std::vector< long > &first, long nElements)" -->
template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#afa40cf29e2f195c1edb0fb2f3454c358">read</a> (std::valarray< S > &image, const std::vector< long > &first, long nElements)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read an image section starting at a location specified by an n-tuple <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a5f17cd303d61b90c783be430c5136af6"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="a5f17cd303d61b90c783be430c5136af6" args="(std::valarray< S > &image, long first, long nElements)" -->
template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a5f17cd303d61b90c783be430c5136af6">read</a> (std::valarray< S > &image, long first, long nElements)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read an image section starting at a specified pixel <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="acda98f052bbcf7a7ef5241550f63abe8"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="acda98f052bbcf7a7ef5241550f63abe8" args="(std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride)" -->
template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#acda98f052bbcf7a7ef5241550f63abe8">read</a> (std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read an image subset <br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a05aa869b5a7583567d6d005e95e0f25d">read</a> (std::valarray< S > &image, const std::vector< long > &first, long nElements, S *nullValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read part of an image array, processing null values. <a href="#a05aa869b5a7583567d6d005e95e0f25d"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a6101312745074dd182518659b74c74a0">read</a> (std::valarray< S > &image, long first, long nElements, S *nullValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read part of an image array, processing null values. <a href="#a6101312745074dd182518659b74c74a0"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#ae1f8951fae4403f43230b94ae323d8d3">read</a> (std::valarray< S > &image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read image data into container. <a href="#ae1f8951fae4403f43230b94ae323d8d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a166d6a339f64d7d8d4715d33ea75195b"></a><!-- doxytag: member="CCfits::ExtHDU::readData" ref="a166d6a339f64d7d8d4715d33ea75195b" args="(bool readFlag=false, const std::vector< String > &keys=std::vector< String >())=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a166d6a339f64d7d8d4715d33ea75195b">readData</a> (bool readFlag=false, const std::vector< String > &keys=std::vector< String >())=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read data from <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> depending on readFlag and keys. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#ab94cb470d13b5a574728c49589963a36">rows</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of rows in the extension. <a href="#ab94cb470d13b5a574728c49589963a36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa01c75db71c10def95aac15f1ab31c56"></a><!-- doxytag: member="CCfits::ExtHDU::version" ref="aa01c75db71c10def95aac15f1ab31c56" args="(int value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#aa01c75db71c10def95aac15f1ab31c56">version</a> (int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the extension version number <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e2785377c404f05dc948db844c6eec7"></a><!-- doxytag: member="CCfits::ExtHDU::version" ref="a5e2785377c404f05dc948db844c6eec7" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a5e2785377c404f05dc948db844c6eec7">version</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the extension version number. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a102ed63b53b8cf834d803e62a95b38b3">write</a> (const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::valarray< S > &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">write a subset (generalize slice) of data to the image <a href="#a102ed63b53b8cf834d803e62a95b38b3"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="abdda484b582814c12f354648c7e44191"></a><!-- doxytag: member="CCfits::ExtHDU::write" ref="abdda484b582814c12f354648c7e44191" args="(long first, long nElements, const std::valarray< S > &data)" -->
template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#abdda484b582814c12f354648c7e44191">write</a> (long first, long nElements, const std::valarray< S > &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">write array starting from specified pixel number, without undefined data processing <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="af8c4a274af795f83440531cbdf6eedaa"></a><!-- doxytag: member="CCfits::ExtHDU::write" ref="af8c4a274af795f83440531cbdf6eedaa" args="(const std::vector< long > &first, long nElements, const std::valarray< S > &data)" -->
template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#af8c4a274af795f83440531cbdf6eedaa">write</a> (const std::vector< long > &first, long nElements, const std::valarray< S > &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">write array starting from specified n-tuple, without undefined data processing <br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a4fc0786fec129ba05d57220fccdb82fb">write</a> (long first, long nElements, const std::valarray< S > &data, S *nullValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">write array to image starting with a specified pixel and allowing undefined data to be processed <a href="#a4fc0786fec129ba05d57220fccdb82fb"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a444e15ad4193a0bef47067c7a3f753d3">write</a> (const std::vector< long > &first, long nElements, const std::valarray< S > &data, S *nullValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a set of pixels to an image extension with the first pixel specified by an n-tuple, processing undefined data. <a href="#a444e15ad4193a0bef47067c7a3f753d3"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a921ed3185671c8647e844d4a60e9296f">readHduName</a> (const fitsfile *fptr, int hduIndex, String &hduName, int &hduVersion)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read extension name. <a href="#a921ed3185671c8647e844d4a60e9296f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected 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_1ExtHDU.html#ae7f51b15ead23e1daccd9db009e7162a">ExtHDU</a> (FITSBase *p, HduType xtype, int number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> constructor for getting ExtHDUs by number. <a href="#ae7f51b15ead23e1daccd9db009e7162a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a389580abe139d17f485ba9fd31e17f3f">ExtHDU</a> (FITSBase *p, HduType xtype, const String &hduName, int bitpix, int naxis, const std::vector< long > &axes, int version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">writing constructor. <a href="#a389580abe139d17f485ba9fd31e17f3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abed636de0e6946e23bc08a6e5b315e00"></a><!-- doxytag: member="CCfits::ExtHDU::ExtHDU" ref="abed636de0e6946e23bc08a6e5b315e00" args="(FITSBase *p, HduType xtype, const String &hduName, int version)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#abed636de0e6946e23bc08a6e5b315e00">ExtHDU</a> (FITSBase *p, HduType xtype, const String &hduName, int version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor, required as Standard Library Container content. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c62fe03c55892e7bb4a126b775c72e6"></a><!-- doxytag: member="CCfits::ExtHDU::gcount" ref="a7c62fe03c55892e7bb4a126b775c72e6" args="(long value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a7c62fe03c55892e7bb4a126b775c72e6">gcount</a> (long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set required gcount keyword value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a010ebcefb99b5855c5347cfa0ce30dec"></a><!-- doxytag: member="CCfits::ExtHDU::gcount" ref="a010ebcefb99b5855c5347cfa0ce30dec" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a010ebcefb99b5855c5347cfa0ce30dec">gcount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return required gcount keyword value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a306b179a8566fdb70d54747f9857f089"></a><!-- doxytag: member="CCfits::ExtHDU::pcount" ref="a306b179a8566fdb70d54747f9857f089" args="(long value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a306b179a8566fdb70d54747f9857f089">pcount</a> (long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set required pcount keyword value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a088cce4e4843ea71af6047355be29c9d"></a><!-- doxytag: member="CCfits::ExtHDU::pcount" ref="a088cce4e4843ea71af6047355be29c9d" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#a088cce4e4843ea71af6047355be29c9d">pcount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return required pcount keyword value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3b17f06451c8d1bf07e1e1829749c04"></a><!-- doxytag: member="CCfits::ExtHDU::xtension" ref="aa3b17f06451c8d1bf07e1e1829749c04" args="(HduType value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#aa3b17f06451c8d1bf07e1e1829749c04">xtension</a> (HduType value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the extension type <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">HduType </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ExtHDU.html#ad3a43454577309abb2ec1ebe97d3375b">xtension</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the extension type <a href="#ad3a43454577309abb2ec1ebe97d3375b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>base class for all <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> extension HDUs, i.e. Image Extensions and Tables. </p>
<p><a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> needs to have the combined public interface of <a class="el" href="classCCfits_1_1Table.html">Table</a> objects and images. It achieves this by providing the same set of read and write operations as <a class="el" href="classCCfits_1_1PHDU.html" title="class representing the primary HDU for a FITS file.">PHDU</a>, and also providing the same operations for extracting columns from the extension as does <a class="el" href="classCCfits_1_1Table.html">Table</a> [after which the column interface is accessible]. Differentiation between extension types operates by exception handling: .i.e. attempting to access image data structures on a <a class="el" href="classCCfits_1_1Table.html">Table</a> object through the <a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> interface will or trying to return a <a class="el" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a> reference from an Image extension will both throw an exception </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a389580abe139d17f485ba9fd31e17f3f"></a><!-- doxytag: member="CCfits::ExtHDU::ExtHDU" ref="a389580abe139d17f485ba9fd31e17f3f" args="(FITSBase *p, HduType xtype, const String &hduName, int bitpix, int naxis, const std::vector< long > &axes, int version)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::ExtHDU::ExtHDU </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">HduType </td>
<td class="paramname"> <em>xtype</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>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">const std::vector< long > & </td>
<td class="paramname"> <em>axes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>version</em></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 writing constructor forces the user to supply a name for the <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. The bitpix, naxes and naxis data required by this constructor are required <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> keywords for any HDUs. </p>
</div>
</div>
<a class="anchor" id="ae7f51b15ead23e1daccd9db009e7162a"></a><!-- doxytag: member="CCfits::ExtHDU::ExtHDU" ref="ae7f51b15ead23e1daccd9db009e7162a" args="(FITSBase *p, HduType xtype, int number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCfits::ExtHDU::ExtHDU </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">HduType </td>
<td class="paramname"> <em>xtype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>number</em></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><a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> constructor for getting ExtHDUs by number. </p>
<p>Necessary since EXTNAME is a reserved, not required, keyword. But a synthetic name is supplied by static <a class="el" href="classCCfits_1_1ExtHDU.html#a921ed3185671c8647e844d4a60e9296f" title="read extension name.">ExtHDU::readHduName</a> which is called by this constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1a4ee80da434b132a5b9015e3d939c11"></a><!-- doxytag: member="CCfits::ExtHDU::addColumn" ref="a1a4ee80da434b132a5b9015e3d939c11" args="(ValueType type, const String &columnName, long repeatWidth, const String &colUnit=String(""), long decimals=-1, size_t columnNumber=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::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>-1</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 in <a class="el" href="classCCfits_1_1AsciiTable.html#a245630609bfb16d581263b7ee868ce10">CCfits::AsciiTable</a>, and <a class="el" href="classCCfits_1_1BinTable.html#a60e89ab762910b76155da983554d433d">CCfits::BinTable</a>.</p>
</div>
</div>
<a class="anchor" id="ab121d5ab64abcc0a5df4ca7955bec2e9"></a><!-- doxytag: member="CCfits::ExtHDU::column" ref="ab121d5ab64abcc0a5df4ca7955bec2e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const map< string, <a class="el" href="classCCfits_1_1Column.html">Column</a> * > & CCfits::ExtHDU::column </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a reference to the array containing the columns. </p>
<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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>thrown if *this is an image extension. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a06d5f1ebd32e0228790c8b4e4b57e2e4"></a><!-- doxytag: member="CCfits::ExtHDU::column" ref="a06d5f1ebd32e0228790c8b4e4b57e2e4" args="(int colIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCCfits_1_1Column.html">Column</a> & CCfits::ExtHDU::column </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>colIndex</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a reference to a <a class="el" href="classCCfits_1_1Table.html">Table</a> column specified by column index. </p>
<p>This version is provided for convenience; the 'return by name' version is more efficient because columns are stored in an associative array sorted by name.</p>
<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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>thrown if *this is an image extension. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a67eb478179846fc940e202476b4c08a3">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a9d3f8b23a32aa7303b0824fa6cb2f21b"></a><!-- doxytag: member="CCfits::ExtHDU::column" ref="a9d3f8b23a32aa7303b0824fa6cb2f21b" args="(const String &colName, bool caseSensitive=true) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCCfits_1_1Column.html">Column</a> & CCfits::ExtHDU::column </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>colName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>caseSensitive</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a reference to a <a class="el" href="classCCfits_1_1Table.html">Table</a> column specified by name. </p>
<p>If the <em>caseSensitive</em> parameter is set to false, the search will be case-insensitive. The overridden base class implementation <a class="el" href="classCCfits_1_1ExtHDU.html#a9d3f8b23a32aa7303b0824fa6cb2f21b" title="return a reference to a Table column specified by name.">ExtHDU::column</a> throws an exception, which is thus the action to be taken if self is an image extension</p>
<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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>see above </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#ae578460dd522485e48ccd8f4536e5531">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="aaee3fda1eb075ef4ee7a9178114bd00d"></a><!-- doxytag: member="CCfits::ExtHDU::deleteColumn" ref="aaee3fda1eb075ef4ee7a9178114bd00d" args="(const String &columnName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::deleteColumn </td>
<td>(</td>
<td class="paramtype">const String & </td>
<td class="paramname"> <em>columnName</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>delete a column in a <a class="el" href="classCCfits_1_1Table.html">Table</a> extension by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>columnName</em> </td><td>The name of the column to be deleted.</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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>if extension is an image. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a19bde9d4a37a2ee07016ef627e5fecde">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a5a480387701525f75ea450dac7510f23"></a><!-- doxytag: member="CCfits::ExtHDU::getRowsize" ref="a5a480387701525f75ea450dac7510f23" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long CCfits::ExtHDU::getRowsize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the optimal number of rows to read or write at a time </p>
<p>A wrapper for the CFITSIO function fits_get_rowsize, useful for obtaining maximum I/O efficiency. This will throw if it is not called for a <a class="el" href="classCCfits_1_1Table.html">Table</a> extension. </p>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a54e2948a7603a058c6a3cd99f0806ac9">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a16730a075858cd50bfa3daad60c0a1c0"></a><!-- doxytag: member="CCfits::ExtHDU::makeThisCurrent" ref="a16730a075858cd50bfa3daad60c0a1c0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::makeThisCurrent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>move the fitsfile pointer to this current <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>. </p>
<p>This function should never need to be called by the user since it is called internally whenever required. </p>
<p>Reimplemented from <a class="el" href="classCCfits_1_1HDU.html#af0bbec3fe5f6b41ff4a95feff6600d57">CCfits::HDU</a>.</p>
</div>
</div>
<a class="anchor" id="af63318f88dad6665781c9d699324a3a3"></a><!-- doxytag: member="CCfits::ExtHDU::numCols" ref="af63318f88dad6665781c9d699324a3a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CCfits::ExtHDU::numCols </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the number of Columns in the <a class="el" href="classCCfits_1_1Table.html">Table</a> (the TFIELDS keyword). </p>
<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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>thrown if *this is an image extension. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a95e674b5441a6f9f756655c8774f6040"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="a95e674b5441a6f9f756655c8774f6040" args="(std::valarray< S > &image, const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::vector< long > &stride, S *nullValue)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::read </td>
<td>(</td>
<td class="paramtype">std::valarray< S > & </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>firstVertex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>lastVertex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>stride</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S * </td>
<td class="paramname"> <em>nullValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read an image subset into valarray image, processing null values </p>
<p>The image subset is defined by two vertices and a stride indicating the 'denseness' of the values to be picked in each dimension (a stride = (1,1,1,...) means picking every pixel in every dimension, whereas stride = (2,2,2,...) means picking every other value in each dimension. </p>
</div>
</div>
<a class="anchor" id="a05aa869b5a7583567d6d005e95e0f25d"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="a05aa869b5a7583567d6d005e95e0f25d" args="(std::valarray< S > &image, const std::vector< long > &first, long nElements, S *nullValue)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::read </td>
<td>(</td>
<td class="paramtype">std::valarray< S > & </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>nElements</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S * </td>
<td class="paramname"> <em>nullValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read part of an image array, processing null values. </p>
<p>As above except for</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>first</em> </td><td>a vector<long> representing an n-tuple giving the coordinates in the image of the first pixel. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6101312745074dd182518659b74c74a0"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="a6101312745074dd182518659b74c74a0" args="(std::valarray< S > &image, long first, long nElements, S *nullValue)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::read </td>
<td>(</td>
<td class="paramtype">std::valarray< S > & </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>nElements</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S * </td>
<td class="paramname"> <em>nullValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read part of an image array, processing null values. </p>
<p>Implicit data conversion is supported (i.e. user does not need to know the type of the data stored. A <a class="el" href="classCCfits_1_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a> extension is thrown if *this is not an image.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>The receiving container, a std::valarray reference </td></tr>
<tr><td valign="top"></td><td valign="top"><em>first</em> </td><td>The first pixel from the array to read [a long value] </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nElements</em> </td><td>The number of values to read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nullValue</em> </td><td>A pointer containing the value in the table to be considered as undefined. See cfitsio for details </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae1f8951fae4403f43230b94ae323d8d3"></a><!-- doxytag: member="CCfits::ExtHDU::read" ref="ae1f8951fae4403f43230b94ae323d8d3" args="(std::valarray< S > &image)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::read </td>
<td>(</td>
<td class="paramtype">std::valarray< S > & </td>
<td class="paramname"> <em>image</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read image data into container. </p>
<p>The container image contains the entire image array after the call. This and all the other variants of <a class="el" href="classCCfits_1_1ExtHDU.html#ae1f8951fae4403f43230b94ae323d8d3" title="Read image data into container.">read()</a> throw a <a class="el" href="classCCfits_1_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a> exception if called for a <a class="el" href="classCCfits_1_1Table.html">Table</a> object. </p>
</div>
</div>
<a class="anchor" id="a921ed3185671c8647e844d4a60e9296f"></a><!-- doxytag: member="CCfits::ExtHDU::readHduName" ref="a921ed3185671c8647e844d4a60e9296f" args="(const fitsfile *fptr, int hduIndex, String &hduName, int &hduVersion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CCfits::ExtHDU::readHduName </td>
<td>(</td>
<td class="paramtype">const fitsfile * </td>
<td class="paramname"> <em>fptr</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">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>hduVersion</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read extension name. </p>
<p>Used primarily to allow extensions to be specified by <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> number and provide their name for the associative array that contains them. Alternatively, if there is no name keyword in the extension, one is synthesized from the index. </p>
</div>
</div>
<a class="anchor" id="ab94cb470d13b5a574728c49589963a36"></a><!-- doxytag: member="CCfits::ExtHDU::rows" ref="ab94cb470d13b5a574728c49589963a36" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long CCfits::ExtHDU::rows </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the number of rows in the extension. </p>
<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_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a></em> </td><td>thrown if *this is an image extension. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450">CCfits::Table</a>.</p>
</div>
</div>
<a class="anchor" id="a102ed63b53b8cf834d803e62a95b38b3"></a><!-- doxytag: member="CCfits::ExtHDU::write" ref="a102ed63b53b8cf834d803e62a95b38b3" args="(const std::vector< long > &firstVertex, const std::vector< long > &lastVertex, const std::valarray< S > &data)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::write </td>
<td>(</td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>firstVertex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>lastVertex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::valarray< S > & </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>write a subset (generalize slice) of data to the image </p>
<p>A generalized slice/subset is a subset of the image (e.g. one plane of a data cube of size <= the dimension of the cube). It is specified by two opposite vertices. The equivalent cfitsio call does not support undefined data processing so there is no version that allows a null value to be specified.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>firstVertex</em> </td><td>the coordinates specifying lower and upper vertices of the n-dimensional slice </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lastVertex</em> </td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to be written </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4fc0786fec129ba05d57220fccdb82fb"></a><!-- doxytag: member="CCfits::ExtHDU::write" ref="a4fc0786fec129ba05d57220fccdb82fb" args="(long first, long nElements, const std::valarray< S > &data, S *nullValue)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::write </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>nElements</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::valarray< S > & </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S * </td>
<td class="paramname"> <em>nullValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>write array to image starting with a specified pixel and allowing undefined data to be processed </p>
<p>parameters after the first are as for version with n-tuple specifying first element. these two version are equivalent, except that it is possible for the first pixel number to exceed the range of 32-bit integers, which is how long datatype is commonly implemented. </p>
</div>
</div>
<a class="anchor" id="a444e15ad4193a0bef47067c7a3f753d3"></a><!-- doxytag: member="CCfits::ExtHDU::write" ref="a444e15ad4193a0bef47067c7a3f753d3" args="(const std::vector< long > &first, long nElements, const std::valarray< S > &data, S *nullValue)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename S > </div>
<table class="memname">
<tr>
<td class="memname">void CCfits::ExtHDU::write </td>
<td>(</td>
<td class="paramtype">const std::vector< long > & </td>
<td class="paramname"> <em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>nElements</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::valarray< S > & </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S * </td>
<td class="paramname"> <em>nullValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a set of pixels to an image extension with the first pixel specified by an n-tuple, processing undefined data. </p>
<p>All the overloaded versions of <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> perform operations on *this if it is an image and throw a <a class="el" href="classCCfits_1_1ExtHDU_1_1WrongExtensionType.html" title="Exception to be thrown on unmatched extension types.">WrongExtensionType</a> exception if not. Where appropriate, alternate versions allow undefined data to be processed</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>first</em> </td><td>an n-tuple of dimension equal to the image dimension specifying the first pixel in the range to be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nElements</em> </td><td>number of pixels to be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>array of data to be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nullValue</em> </td><td>pointer to null value (data with this value written as undefined; needs the BLANK keyword to have been specified). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad3a43454577309abb2ec1ebe97d3375b"></a><!-- doxytag: member="CCfits::ExtHDU::xtension" ref="ad3a43454577309abb2ec1ebe97d3375b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HduType CCfits::ExtHDU::xtension </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the extension type </p>
<p>allowed values are ImageHDU, AsciiTbl, and BinaryTbl </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ExtHDU_8h_source.html">ExtHDU.h</a></li>
<li>ExtHDU.cxx</li>
<li><a class="el" href="ExtHDUT_8h_source.html">ExtHDUT.h</a></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
>
69
