<!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: PHDU.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>PHDU.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Read the documentation to learn more about C++ code generator</span>
<a name="l00002"></a>00002 <span class="comment">// versioning.</span>
<a name="l00003"></a>00003 <span class="comment">// This is version 2.2 release dated Sep 2009</span>
<a name="l00004"></a>00004 <span class="comment">// Astrophysics Science Division,</span>
<a name="l00005"></a>00005 <span class="comment">// NASA/ Goddard Space Flight Center</span>
<a name="l00006"></a>00006 <span class="comment">// HEASARC</span>
<a name="l00007"></a>00007 <span class="comment">// http://heasarc.gsfc.nasa.gov</span>
<a name="l00008"></a>00008 <span class="comment">// e-mail: ccfits@legacy.gsfc.nasa.gov</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// Original author: Ben Dorman</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef PHDU_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define PHDU_H 1</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="comment">// valarray</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <valarray></span>
<a name="l00017"></a>00017 <span class="comment">// HDU</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include "HDU.h"</span>
<a name="l00019"></a>00019 <span class="comment">// FITS</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "FITS.h"</span>
<a name="l00021"></a>00021 <span class="comment">// FITSUtil</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "FITSUtil.h"</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">namespace </span>CCfits {
<a name="l00025"></a>00025 <span class="keyword">class </span>FITSBase;
<a name="l00026"></a>00026
<a name="l00027"></a>00027 } <span class="comment">// namespace CCfits</span>
<a name="l00028"></a>00028 <span class="comment">// for CLONE_DEFECT</span>
<a name="l00029"></a>00029 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#include "MSconfig.h"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>CCfits {
<a name="l00035"></a>00035
<a name="l00070"></a>00070 <span class="comment">/* !\fn PHDU::PHDU (FITSBase* p)</span>
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> \brief Reading Primary HDU constructor.</span>
<a name="l00073"></a>00073 <span class="comment"> Constructor used when reading the primary HDU from an existing file.</span>
<a name="l00074"></a>00074 <span class="comment"> Does nothing except initialize, with the real work done by the subclass</span>
<a name="l00075"></a>00075 <span class="comment"> PrimaryHDU<T>.</span>
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">*/</span>
<a name="l00078"></a>00078
<a name="l00259"></a><a class="code" href="classCCfits_1_1PHDU.html">00259</a> <span class="keyword">class </span><a class="code" href="classCCfits_1_1PHDU.html" title="class representing the primary HDU for a FITS file.">PHDU</a> : <span class="keyword">public</span> <a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a> <span class="comment">//## Inherits: <unnamed>%394E6F9800C3</span>
<a name="l00260"></a>00260 {
<a name="l00261"></a>00261
<a name="l00262"></a>00262 <span class="keyword">public</span>:
<a name="l00263"></a>00263 <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1PHDU.html#aebb0d9bac5b961e7de036ad10f1a02c2" title="destructor">~PHDU</a>();
<a name="l00264"></a>00264
<a name="l00265"></a>00265 <span class="comment">// Read data reads the image if readFlag is true and</span>
<a name="l00266"></a>00266 <span class="comment">// optional keywords if supplied. Thus, with no arguments,</span>
<a name="l00267"></a>00267 <span class="comment">// readData() does nothing.</span>
<a name="l00268"></a>00268 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a496d7e092054cb21565f4b1bf3d977f4" title="read primary HDU data">readData</a> (<span class="keywordtype">bool</span> readFlag = <span class="keyword">false</span>, <span class="keyword">const</span> std::vector<String>& keys = std::vector<String>()) = 0;
<a name="l00269"></a>00269 <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1PHDU.html" title="class representing the primary HDU for a FITS file.">PHDU</a> * <a class="code" href="classCCfits_1_1PHDU.html#a6cefe66318d6014ef2d489e7a779f299" title="virtual copy constructor, to be implemented in subclasses.">clone</a> (FITSBase* p) <span class="keyword">const</span> = 0;
<a name="l00270"></a>00270 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a04b7249f250f651a96b6423930c6e4e2" title="return the BZERO keyword value">zero</a> (<span class="keywordtype">double</span> value);
<a name="l00271"></a>00271 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a0205708df85524ee37eddb7485604591" title="return the BSCALE keyword value">scale</a> (<span class="keywordtype">double</span> value);
<a name="l00272"></a>00272 <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classCCfits_1_1PHDU.html#a04b7249f250f651a96b6423930c6e4e2" title="return the BZERO keyword value">zero</a> () <span class="keyword">const</span>;
<a name="l00273"></a>00273 <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classCCfits_1_1PHDU.html#a0205708df85524ee37eddb7485604591" title="return the BSCALE keyword value">scale</a> () <span class="keyword">const</span>;
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="keyword">public</span>:
<a name="l00276"></a>00276 <span class="comment">// Additional Public Declarations</span>
<a name="l00277"></a>00277 <span class="comment">// image reading/writing interface. </span>
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="comment">// The S template parameter, like for Column, denotes the fact that</span>
<a name="l00280"></a>00280 <span class="comment">// the type of the input array and the object to be read may not match.</span>
<a name="l00281"></a>00281
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="comment">// the rw interface for images consists of equivalents for fits_read_img,</span>
<a name="l00284"></a>00284 <span class="comment">// fits_read_pix, and fits_read_subset.</span>
<a name="l00285"></a>00285
<a name="l00286"></a>00286 <span class="comment">// the paradigm for reading is that the image object (a valarray<T> type)</span>
<a name="l00287"></a>00287 <span class="comment">// is the size of the data already read.</span>
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="comment">// write_subset has no null value aware analogue.</span>
<a name="l00290"></a>00290 <span class="keyword">template</span> <<span class="keyword">typename</span> S>
<a name="l00291"></a>00291 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a2a7dfaa22263656ba9db636f82b89850" title="Write a set of pixels to an image extension with the first pixel specified by an...">write</a>(<span class="keyword">const</span> std::vector<long>& first,
<a name="l00292"></a>00292 <span class="keywordtype">long</span> nElements,
<a name="l00293"></a>00293 <span class="keyword">const</span> std::valarray<S>& data,
<a name="l00294"></a>00294 S* nullValue);
<a name="l00295"></a>00295
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="keyword">template</span> <<span class="keyword">typename</span> S>
<a name="l00298"></a>00298 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a2a7dfaa22263656ba9db636f82b89850" title="Write a set of pixels to an image extension with the first pixel specified by an...">write</a>(<span class="keywordtype">long</span> first,
<a name="l00299"></a>00299 <span class="keywordtype">long</span> nElements,
<a name="l00300"></a>00300 <span class="keyword">const</span> std::valarray<S>& data,
<a name="l00301"></a>00301 S* nullValue);
<a name="l00302"></a>00302
<a name="l00303"></a>00303
<a name="l00304"></a>00304 <span class="keyword">template</span> <<span class="keyword">typename</span> S>
<a name="l00305"></a>00305 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a2a7dfaa22263656ba9db636f82b89850" title="Write a set of pixels to an image extension with the first pixel specified by an...">write</a>(<span class="keyword">const</span> std::vector<long>& first,
<a name="l00306"></a>00306 <span class="keywordtype">long</span> nElements,
<a name="l00307"></a>00307 <span class="keyword">const</span> std::valarray<S>& data);
<a name="l00308"></a>00308
<a name="l00309"></a>00309
<a name="l00310"></a>00310 <span class="keyword">template</span> <<span class="keyword">typename</span> S>
<a name="l00311"></a>00311 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a2a7dfaa22263656ba9db636f82b89850" title="Write a set of pixels to an image extension with the first pixel specified by an...">write</a>(<span class="keywordtype">long</span> first,
<a name="l00312"></a>00312 <span class="keywordtype">long</span> nElements,
<a name="l00313"></a>00313 <span class="keyword">const</span> std::valarray<S>& data);
<a name="l00314"></a>00314
<a name="l00315"></a>00315 <span class="keyword">template</span> <<span class="keyword">typename</span> S>
<a name="l00316"></a>00316 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a2a7dfaa22263656ba9db636f82b89850" title="Write a set of pixels to an image extension with the first pixel specified by an...">write</a>(<span class="keyword">const</span> std::vector<long>& firstVertex,
<a name="l00317"></a>00317 <span class="keyword">const</span> std::vector<long>& lastVertex,
<a name="l00318"></a>00318 <span class="keyword">const</span> std::vector<long>& stride,
<a name="l00319"></a>00319 <span class="keyword">const</span> std::valarray<S>& data);
<a name="l00320"></a>00320
<a name="l00321"></a>00321 <span class="comment">// read image data and return an array. Can't return a reference</span>
<a name="l00322"></a>00322 <span class="comment">// because the type conversion needs to allocate a new object in general.</span>
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00325"></a>00325 <span class="keywordtype">void</span> read(std::valarray<S>& image) ;
<a name="l00326"></a>00326
<a name="l00327"></a>00327 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00328"></a>00328 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keywordtype">long</span> first,<span class="keywordtype">long</span> nElements);
<a name="l00329"></a>00329
<a name="l00330"></a>00330 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00331"></a>00331 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keywordtype">long</span> first,<span class="keywordtype">long</span> nElements, S* nullValue) ;
<a name="l00332"></a>00332
<a name="l00333"></a>00333 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00334"></a>00334 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keyword">const</span> std::vector<long>& first,<span class="keywordtype">long</span> nElements) ;
<a name="l00335"></a>00335
<a name="l00336"></a>00336 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00337"></a>00337 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keyword">const</span> std::vector<long>& first, <span class="keywordtype">long</span> nElements,
<a name="l00338"></a>00338 S* nullValue);
<a name="l00339"></a>00339
<a name="l00340"></a>00340 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00341"></a>00341 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keyword">const</span> std::vector<long>& firstVertex,
<a name="l00342"></a>00342 <span class="keyword">const</span> std::vector<long>& lastVertex,
<a name="l00343"></a>00343 <span class="keyword">const</span> std::vector<long>& stride) ;
<a name="l00344"></a>00344
<a name="l00345"></a>00345 <span class="keyword">template</span><<span class="keyword">typename</span> S>
<a name="l00346"></a>00346 <span class="keywordtype">void</span> read (std::valarray<S>& image, <span class="keyword">const</span> std::vector<long>& firstVertex,
<a name="l00347"></a>00347 <span class="keyword">const</span> std::vector<long>& lastVertex,
<a name="l00348"></a>00348 <span class="keyword">const</span> std::vector<long>& stride,
<a name="l00349"></a>00349 S* nullValue) ;
<a name="l00350"></a>00350
<a name="l00351"></a>00351
<a name="l00352"></a>00352 <span class="keyword">protected</span>:
<a name="l00353"></a>00353 <a class="code" href="classCCfits_1_1PHDU.html#abd7c1f8131fa1acd2c638a9b9372e55a" title="copy constructor">PHDU</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1PHDU.html" title="class representing the primary HDU for a FITS file.">PHDU</a> &right);
<a name="l00354"></a>00354 <span class="comment">// Constructor for new FITS objects, takes as arguments</span>
<a name="l00355"></a>00355 <span class="comment">// the required keywords for a primary HDU.</span>
<a name="l00356"></a>00356 <a class="code" href="classCCfits_1_1PHDU.html#abd7c1f8131fa1acd2c638a9b9372e55a" title="copy constructor">PHDU</a> (FITSBase* p, <span class="keywordtype">int</span> bpix, <span class="keywordtype">int</span> naxis, <span class="keyword">const</span> std::vector<long>& <a class="code" href="classCCfits_1_1HDU.html#a18bd99b5d72ace7e7b353102eb80793a" title="return the number of axes in the HDU data section (always 2 for tables).">axes</a>);
<a name="l00357"></a>00357 <span class="comment">// Custom constructor. Allows specification of data to be read and whether to read data at</span>
<a name="l00358"></a>00358 <span class="comment">// construction or wait until the image data are requested. The default is 'lazy initialization:'</span>
<a name="l00359"></a>00359 <span class="comment">// wait until asked.</span>
<a name="l00360"></a>00360 <a class="code" href="classCCfits_1_1PHDU.html#abd7c1f8131fa1acd2c638a9b9372e55a" title="copy constructor">PHDU</a> (FITSBase* p = 0);
<a name="l00361"></a>00361
<a name="l00362"></a>00362 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1PHDU.html#a04e290b1a4d638db9dee0e6a03d30ede">initRead</a> ();
<a name="l00363"></a>00363 <span class="keywordtype">bool</span> simple () <span class="keyword">const</span>;
<a name="l00364"></a>00364 <span class="keywordtype">void</span> simple (<span class="keywordtype">bool</span> value);
<a name="l00365"></a>00365 <span class="keywordtype">bool</span> extend () <span class="keyword">const</span>;
<a name="l00366"></a>00366 <span class="keywordtype">void</span> extend (<span class="keywordtype">bool</span> value);
<a name="l00367"></a>00367
<a name="l00368"></a>00368 <span class="comment">// Additional Protected Declarations</span>
<a name="l00369"></a>00369
<a name="l00370"></a>00370 <span class="keyword">private</span>:
<a name="l00371"></a>00371 <span class="comment">// Additional Private Declarations</span>
<a name="l00372"></a>00372
<a name="l00373"></a>00373 <span class="keyword">private</span>: <span class="comment">//## implementation</span>
<a name="l00374"></a>00374 <span class="comment">// Data Members for Class Attributes</span>
<a name="l00375"></a>00375 <span class="keywordtype">bool</span> m_simple;
<a name="l00376"></a>00376 <span class="keywordtype">bool</span> m_extend;
<a name="l00377"></a>00377
<a name="l00378"></a>00378 <span class="comment">// Additional Implementation Declarations</span>
<a name="l00379"></a>00379
<a name="l00380"></a>00380 };
<a name="l00381"></a>00381
<a name="l00382"></a>00382 <span class="comment">// Class CCfits::PHDU </span>
<a name="l00383"></a>00383
<a name="l00384"></a>00384 <span class="keyword">inline</span> <span class="keywordtype">bool</span> PHDU::simple ()<span class="keyword"> const</span>
<a name="l00385"></a>00385 <span class="keyword"> </span>{
<a name="l00386"></a>00386 <span class="keywordflow">return</span> m_simple;
<a name="l00387"></a>00387 }
<a name="l00388"></a>00388
<a name="l00389"></a>00389 <span class="keyword">inline</span> <span class="keywordtype">void</span> PHDU::simple (<span class="keywordtype">bool</span> value)
<a name="l00390"></a>00390 {
<a name="l00391"></a>00391 m_simple = value;
<a name="l00392"></a>00392 }
<a name="l00393"></a>00393
<a name="l00394"></a>00394 <span class="keyword">inline</span> <span class="keywordtype">bool</span> PHDU::extend ()<span class="keyword"> const</span>
<a name="l00395"></a>00395 <span class="keyword"> </span>{
<a name="l00396"></a>00396 <span class="keywordflow">return</span> m_extend;
<a name="l00397"></a>00397 }
<a name="l00398"></a>00398
<a name="l00399"></a>00399 <span class="keyword">inline</span> <span class="keywordtype">void</span> PHDU::extend (<span class="keywordtype">bool</span> value)
<a name="l00400"></a>00400 {
<a name="l00401"></a>00401 m_extend = value;
<a name="l00402"></a>00402 }
<a name="l00403"></a>00403
<a name="l00404"></a>00404 } <span class="comment">// namespace CCfits</span>
<a name="l00405"></a>00405
<a name="l00406"></a>00406
<a name="l00407"></a>00407 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 9 11:59:41 2009 for CCfits by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
ecbd8c5b7568e331fe6ea5b9a07a78a0
>
files
>
29
