Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > ecbd8c5b7568e331fe6ea5b9a07a78a0 > files > 17

CCfits-docs-2.2-2.fc13.noarch.rpm

<!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: HDUCreator.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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>HDUCreator.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 HDUCREATOR_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define HDUCREATOR_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 &lt;valarray&gt;</span>
<a name="l00017"></a>00017 <span class="comment">// typeinfo</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;typeinfo&gt;</span>
<a name="l00019"></a>00019 <span class="comment">// vector</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00021"></a>00021 <span class="comment">// string</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00023"></a>00023 <span class="comment">// CCfitsHeader</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;CCfits.h&quot;</span>
<a name="l00025"></a>00025 <span class="comment">// FitsError</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &quot;FitsError.h&quot;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">namespace </span>CCfits {
<a name="l00029"></a>00029   <span class="keyword">class </span>FITSBase;
<a name="l00030"></a>00030   <span class="keyword">class </span>HDU;
<a name="l00031"></a>00031   <span class="keyword">class </span>PHDU;
<a name="l00032"></a>00032   <span class="keyword">class </span>ExtHDU;
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 } <span class="comment">// namespace CCfits</span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="keyword">namespace </span>CCfits {
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 
<a name="l00041"></a>00041   <span class="keyword">class </span>HDUCreator 
<a name="l00042"></a>00042   {
<a name="l00043"></a>00043 
<a name="l00044"></a>00044     <span class="keyword">public</span>:
<a name="l00045"></a>00045         HDUCreator (FITSBase* p);
<a name="l00046"></a>00046         ~HDUCreator();
<a name="l00047"></a>00047 
<a name="l00048"></a>00048         <span class="comment">//      Read a specified HDU from given fitsfile and</span>
<a name="l00049"></a>00049         <span class="comment">//      return a pointer to it.</span>
<a name="l00050"></a>00050         HDU * getHdu (<span class="keyword">const</span> String&amp; hduName, <span class="keywordtype">bool</span> readDataFlag = <span class="keyword">false</span>, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys = std::vector&lt;String&gt;(), <span class="keywordtype">bool</span> primary = <span class="keyword">false</span>, <span class="keywordtype">int</span> version = 1);
<a name="l00051"></a>00051         PHDU * createImage (<span class="keywordtype">int</span> bitpix, <span class="keywordtype">long</span> naxis, <span class="keyword">const</span> std::vector&lt;long&gt;&amp; naxes);
<a name="l00052"></a>00052         <span class="keywordtype">void</span> reset ();
<a name="l00053"></a>00053         HDU * Make (<span class="keyword">const</span> String&amp; hduName, <span class="keywordtype">bool</span> readDataFlag, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys, <span class="keywordtype">bool</span> primary, <span class="keywordtype">int</span> version);
<a name="l00054"></a>00054         HDU* createTable (<span class="keyword">const</span> String &amp;name, HduType xtype, <span class="keywordtype">int</span> rows, <span class="keyword">const</span> std::vector&lt;String&gt;&amp; colName, <span class="keyword">const</span> std::vector&lt;String&gt; colFmt, <span class="keyword">const</span> std::vector&lt;String&gt; colUnit, <span class="keywordtype">int</span> version);
<a name="l00055"></a>00055         <span class="comment">//      Read a specified HDU from given fitsfile and</span>
<a name="l00056"></a>00056         <span class="comment">//      return a pointer to it.</span>
<a name="l00057"></a>00057         <span class="comment">//</span>
<a name="l00058"></a>00058         <span class="comment">//      With no arguments this reads the PrimaryHDU.</span>
<a name="l00059"></a>00059         HDU * getHdu (<span class="keywordtype">int</span> index = 0, <span class="keywordtype">bool</span> readDataFlag = <span class="keyword">false</span>, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys = std::vector&lt;String&gt;());
<a name="l00060"></a>00060         ExtHDU * createImage (<span class="keyword">const</span> String &amp;name, <span class="keywordtype">int</span> bitpix, <span class="keywordtype">long</span> naxis, <span class="keyword">const</span> std::vector&lt;long&gt;&amp; naxes, <span class="keywordtype">int</span> version);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062       <span class="comment">// Additional Public Declarations</span>
<a name="l00063"></a>00063 
<a name="l00064"></a>00064     <span class="keyword">protected</span>:
<a name="l00065"></a>00065       <span class="comment">// Additional Protected Declarations</span>
<a name="l00066"></a>00066 
<a name="l00067"></a>00067     <span class="keyword">private</span>:
<a name="l00068"></a>00068         PHDU * MakeImage (<span class="keywordtype">int</span> bpix, <span class="keywordtype">int</span> naxis, <span class="keyword">const</span> std::vector&lt;long&gt;&amp; naxes);
<a name="l00069"></a>00069         HDU* MakeTable (<span class="keyword">const</span> String &amp;name, HduType xtype, <span class="keywordtype">int</span> rows, <span class="keyword">const</span> std::vector&lt;String&gt;&amp; colName, <span class="keyword">const</span> std::vector&lt;String&gt;&amp; colFmt, <span class="keyword">const</span> std::vector&lt;String&gt;&amp; colUnit, <span class="keywordtype">int</span> version);
<a name="l00070"></a>00070         HDU * Make (<span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> readDataFlag, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys);
<a name="l00071"></a>00071         ExtHDU * MakeImage (<span class="keyword">const</span> String &amp;name, <span class="keywordtype">int</span> bpix, <span class="keywordtype">long</span> naxis, <span class="keyword">const</span> std::vector&lt;long&gt;&amp; naxes, <span class="keywordtype">int</span> version);
<a name="l00072"></a>00072         <span class="keywordtype">void</span> getScaling (<span class="keywordtype">long</span>&amp; type, <span class="keywordtype">double</span>&amp; zero, <span class="keywordtype">double</span>&amp; scale) <span class="keyword">const</span>;
<a name="l00073"></a>00073         <span class="keywordtype">void</span> parent (FITSBase* value);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075       <span class="comment">// Data Members for Class Attributes</span>
<a name="l00076"></a>00076         HDU *m_hdu;
<a name="l00077"></a>00077 
<a name="l00078"></a>00078       <span class="comment">// Additional Private Declarations</span>
<a name="l00079"></a>00079 
<a name="l00080"></a>00080     <span class="keyword">private</span>: <span class="comment">//## implementation</span>
<a name="l00081"></a>00081       <span class="comment">// Data Members for Associations</span>
<a name="l00082"></a>00082         FITSBase* m_parent;
<a name="l00083"></a>00083 
<a name="l00084"></a>00084       <span class="comment">// Additional Implementation Declarations</span>
<a name="l00085"></a>00085 
<a name="l00086"></a>00086   };
<a name="l00087"></a>00087 
<a name="l00088"></a>00088   <span class="comment">// Class CCfits::HDUCreator </span>
<a name="l00089"></a>00089 
<a name="l00090"></a>00090   <span class="keyword">inline</span> HDU * HDUCreator::getHdu (<span class="keyword">const</span> String&amp; hduName, <span class="keywordtype">bool</span> readDataFlag, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys, <span class="keywordtype">bool</span> primary, <span class="keywordtype">int</span> version)
<a name="l00091"></a>00091   {
<a name="l00093"></a>00093   <span class="keywordflow">if</span> ( m_hdu == 0 ) m_hdu = Make(hduName,readDataFlag,keys,primary,version);
<a name="l00094"></a>00094   <span class="keywordflow">return</span> m_hdu;
<a name="l00095"></a>00095   }
<a name="l00096"></a>00096 
<a name="l00097"></a>00097   <span class="keyword">inline</span> <span class="keywordtype">void</span> HDUCreator::reset ()
<a name="l00098"></a>00098   {
<a name="l00099"></a>00099   m_hdu = 0;
<a name="l00100"></a>00100   }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102   <span class="keyword">inline</span> HDU* HDUCreator::createTable (<span class="keyword">const</span> String &amp;name, HduType xtype, <span class="keywordtype">int</span> rows, <span class="keyword">const</span> std::vector&lt;String&gt;&amp; colName, <span class="keyword">const</span> std::vector&lt;String&gt; colFmt, <span class="keyword">const</span> std::vector&lt;String&gt; colUnit, <span class="keywordtype">int</span> version)
<a name="l00103"></a>00103   {
<a name="l00105"></a>00105         <span class="keywordflow">if</span> (m_hdu == 0) m_hdu = MakeTable(name,xtype,rows,colName,colFmt,colUnit,version);
<a name="l00106"></a>00106         <span class="keywordflow">return</span> m_hdu;
<a name="l00107"></a>00107   }
<a name="l00108"></a>00108 
<a name="l00109"></a>00109   <span class="keyword">inline</span> HDU * HDUCreator::getHdu (<span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> readDataFlag, <span class="keyword">const</span> std::vector&lt;String&gt; &amp;keys)
<a name="l00110"></a>00110   {
<a name="l00112"></a>00112   <span class="keywordflow">if</span> ( m_hdu == 0 ) m_hdu = Make(index,readDataFlag,keys);
<a name="l00113"></a>00113   <span class="keywordflow">return</span> m_hdu;
<a name="l00114"></a>00114   }
<a name="l00115"></a>00115 
<a name="l00116"></a>00116   <span class="keyword">inline</span> <span class="keywordtype">void</span> HDUCreator::parent (FITSBase* value)
<a name="l00117"></a>00117   {
<a name="l00118"></a>00118     m_parent = value;
<a name="l00119"></a>00119   }
<a name="l00120"></a>00120 
<a name="l00121"></a>00121 } <span class="comment">// namespace CCfits</span>
<a name="l00122"></a>00122 
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 <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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>