<!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::ImageExt< T > Class Template 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_1ImageExt.html">ImageExt</a>
</div>
</div>
<div class="contents">
<h1>CCfits::ImageExt< T > Class Template Reference</h1><!-- doxytag: class="CCfits::ImageExt" --><!-- doxytag: inherits="CCfits::ExtHDU" --><div class="dynheader">
Inheritance diagram for CCfits::ImageExt< T >:</div>
<div class="dynsection">
<div class="center">
<img src="classCCfits_1_1ImageExt.gif" alt="Inheritance diagram" usemap="#CCfits::ImageExt< T >_map" alt=""/>
<map id="CCfits::ImageExt< T >_map" name="CCfits::ImageExt< T >_map">
<area href="classCCfits_1_1ExtHDU.html" alt="CCfits::ExtHDU" shape="rect" coords="0,56,133,80"/>
<area href="classCCfits_1_1HDU.html" alt="CCfits::HDU" shape="rect" coords="0,0,133,24"/>
</map>
</div>
</div>
<p><a href="classCCfits_1_1ImageExt-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a036e9a9301d0a8c5cfb2045168bf752e"></a><!-- doxytag: member="CCfits::ImageExt::~ImageExt" ref="a036e9a9301d0a8c5cfb2045168bf752e" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ImageExt.html#a036e9a9301d0a8c5cfb2045168bf752e">~ImageExt</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="anchor" id="a50f37e2cb14259f534b6bd88bc853da7"></a><!-- doxytag: member="CCfits::ImageExt::clone" ref="a50f37e2cb14259f534b6bd88bc853da7" args="(FITSBase *p) const " -->
virtual <a class="el" href="classCCfits_1_1ImageExt.html">ImageExt</a>< T > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ImageExt.html#a50f37e2cb14259f534b6bd88bc853da7">clone</a> (FITSBase *p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual copy constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace83a5e81e20d8210bf04ab2fd03aaa4"></a><!-- doxytag: member="CCfits::ImageExt::image" ref="ace83a5e81e20d8210bf04ab2fd03aaa4" args="() const " -->
const std::valarray< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ImageExt.html#ace83a5e81e20d8210bf04ab2fd03aaa4">image</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the image data <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_1ImageExt.html#a0f74472174c571dea4e7faa0cb23eae8">readData</a> (bool readFlag=false, const std::vector< String > &keys=std::vector< String >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read Image extension <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> data <a href="#a0f74472174c571dea4e7faa0cb23eae8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eb7b465140aa151e2f7272c977846cd"></a><!-- doxytag: member="CCfits::ImageExt::scale" ref="a1eb7b465140aa151e2f7272c977846cd" args="() const " -->
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ImageExt.html#a1eb7b465140aa151e2f7272c977846cd">scale</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the BSCALE keyword value <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_1ImageExt.html#ad0531bb4a797027e6ff77517d2e09cc6">scale</a> (double value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the BSCALE keyword value for images (see warning for images of int type) <a href="#ad0531bb4a797027e6ff77517d2e09cc6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53d36df4ae92f58771a25559120bacb9"></a><!-- doxytag: member="CCfits::ImageExt::zero" ref="a53d36df4ae92f58771a25559120bacb9" args="() const " -->
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCfits_1_1ImageExt.html#a53d36df4ae92f58771a25559120bacb9">zero</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the BZERO keyword value <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_1ImageExt.html#aa6d47bd83e9538694ee7d4f4d70ef33b">zero</a> (double value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the BZERO keyword value for images (see warning for images of int type) <a href="#aa6d47bd83e9538694ee7d4f4d70ef33b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br/>
class CCfits::ImageExt< T ></h3>
<p>ImageExt<T> is a subclass of <a class="el" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> that contains image data of type T. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0f74472174c571dea4e7faa0cb23eae8"></a><!-- doxytag: member="CCfits::ImageExt::readData" ref="a0f74472174c571dea4e7faa0cb23eae8" args="(bool readFlag=false, const std::vector< String > &keys=std::vector< String >())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCCfits_1_1ImageExt.html">CCfits::ImageExt</a>< T >::readData </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>readFlag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< String > & </td>
<td class="paramname"> <em>keys</em> = <code>std::vector<String>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>read Image extension <a class="el" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> data </p>
<p>Called by <a class="el" href="classCCfits_1_1FITS.html" title="Memory object representation of a disk FITS file.">FITS</a> ctor, not intended for general use. parameters control how much gets read on initialization.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>readFlag</em> </td><td>read the image data if true </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>a vector of strings of keyword names 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>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCCfits_1_1ExtHDU.html#a166d6a339f64d7d8d4715d33ea75195b">CCfits::ExtHDU</a>.</p>
</div>
</div>
<a class="anchor" id="ad0531bb4a797027e6ff77517d2e09cc6"></a><!-- doxytag: member="CCfits::ImageExt::scale" ref="ad0531bb4a797027e6ff77517d2e09cc6" args="(double value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCCfits_1_1ImageExt.html">CCfits::ImageExt</a>< T >::scale </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set the BSCALE keyword value for images (see warning for images of int type) </p>
<p>For primary HDUs and image extensions, this will add (or update) the BSCALE keyword in the header. The new setting will affect future image array read/writes as described in section 4.7 Data Scaling of the CFITSIO manual. For table extensions this function does nothing.</p>
<p>WARNING: If the image contains <b>integer-type data</b> (as indicated by the <a class="el" href="classCCfits_1_1HDU.html#a81a2d5b001c0ae7d0a298942940189d8" title="return the data type keyword.">bitpix()</a> return value), the new scale and zero value combination must not be such that the scaled data would require a floating-point type (this uses the CFITSIO function fits_get_img_equivtype to make the determination). If this situation occurs, the function will throw a <a class="el" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a>. </p>
<p>Reimplemented from <a class="el" href="classCCfits_1_1HDU.html#a6c8e0dc188f74f681f6bfe17819b2eb9">CCfits::HDU</a>.</p>
</div>
</div>
<a class="anchor" id="aa6d47bd83e9538694ee7d4f4d70ef33b"></a><!-- doxytag: member="CCfits::ImageExt::zero" ref="aa6d47bd83e9538694ee7d4f4d70ef33b" args="(double value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCCfits_1_1ImageExt.html">CCfits::ImageExt</a>< T >::zero </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set the BZERO keyword value for images (see warning for images of int type) </p>
<p>For primary HDUs and image extensions, this will add (or update) the BZERO keyword in the header. The new setting will affect future image array read/writes as described in section 4.7 Data Scaling of the CFITSIO manual. For table extensions this function does nothing.</p>
<p>WARNING: If the image contains <b>integer-type data</b> (as indicated by the <a class="el" href="classCCfits_1_1HDU.html#a81a2d5b001c0ae7d0a298942940189d8" title="return the data type keyword.">bitpix()</a> return value), the new scale and zero value combination must not be such that the scaled data would require a floating-point type (this uses the CFITSIO function fits_get_img_equivtype to make the determination). If this situation occurs, the function will throw a <a class="el" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a>. </p>
<p>Reimplemented from <a class="el" href="classCCfits_1_1HDU.html#a2fb3adf98e8cc736b200520afed61c13">CCfits::HDU</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ImageExt_8h_source.html">ImageExt.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 9 11:59:47 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
>
123
