wcslib (8.2.2)

(root)/
share/
doc/
wcslib-8.2.2/
html/
structfitskey.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WCSLIB: fitskey Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">WCSLIB<span id="projectnumber">&#160;8.2.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">fitskey Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Keyword/value information.  
 <a href="structfitskey.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="fitshdr_8h_source.html">fitshdr.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a43de42050c7e0232c9f7c5a28bfede4b" id="r_a43de42050c7e0232c9f7c5a28bfede4b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#a43de42050c7e0232c9f7c5a28bfede4b">keyno</a></td></tr>
<tr class="separator:a43de42050c7e0232c9f7c5a28bfede4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5bd77eb6d318c562bfe650f6784eb5f" id="r_af5bd77eb6d318c562bfe650f6784eb5f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#af5bd77eb6d318c562bfe650f6784eb5f">keyid</a></td></tr>
<tr class="separator:af5bd77eb6d318c562bfe650f6784eb5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a935a63ff3aa2c0403ed8eee1a94662e7" id="r_a935a63ff3aa2c0403ed8eee1a94662e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#a935a63ff3aa2c0403ed8eee1a94662e7">status</a></td></tr>
<tr class="separator:a935a63ff3aa2c0403ed8eee1a94662e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48b4ff24100b6ada4fd184d5c3d55eec" id="r_a48b4ff24100b6ada4fd184d5c3d55eec"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#a48b4ff24100b6ada4fd184d5c3d55eec">keyword</a> [12]</td></tr>
<tr class="separator:a48b4ff24100b6ada4fd184d5c3d55eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbc83643fe92fd44408a6d62dbaf87b1" id="r_adbc83643fe92fd44408a6d62dbaf87b1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">type</a></td></tr>
<tr class="separator:adbc83643fe92fd44408a6d62dbaf87b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42413fd1f1f3117a4bc4c0599c2c3889" id="r_a42413fd1f1f3117a4bc4c0599c2c3889"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#a42413fd1f1f3117a4bc4c0599c2c3889">padding</a></td></tr>
<tr class="separator:a42413fd1f1f3117a4bc4c0599c2c3889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa914a7430a2746de8ceb641321842784" id="r_aa914a7430a2746de8ceb641321842784"><td class="memItemLeft" >union {&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bfaf2d325b4272e53bbd12720648acd" id="r_a1bfaf2d325b4272e53bbd12720648acd"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structfitskey.html#a88e62afbb23808ae484b8734bb1685b9">i</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a1bfaf2d325b4272e53bbd12720648acd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35801d1e15d53a0d5b5d0cfa1c507bd2" id="r_a35801d1e15d53a0d5b5d0cfa1c507bd2"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a>&#160;&#160;&#160;<a class="el" href="structfitskey.html#af1a8fb88bc5d4ba60f9f12d0885c360e">k</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a35801d1e15d53a0d5b5d0cfa1c507bd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0f5e6c1b823c21ccd31e040b43f920c" id="r_af0f5e6c1b823c21ccd31e040b43f920c"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structfitskey.html#a68ab074cc13a9e0be1583ee93aa0db6b">l</a> [8]&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:af0f5e6c1b823c21ccd31e040b43f920c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac61160cfce6e632f4d843744b4907321" id="r_ac61160cfce6e632f4d843744b4907321"><td class="memItemLeft" >&#160;&#160;&#160;double&#160;&#160;&#160;<a class="el" href="structfitskey.html#ae6f81da89b09d92db5258191a1a9354b">f</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:ac61160cfce6e632f4d843744b4907321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace79b3ff94171d8928ca338ac0a0427b" id="r_ace79b3ff94171d8928ca338ac0a0427b"><td class="memItemLeft" >&#160;&#160;&#160;double&#160;&#160;&#160;<a class="el" href="structfitskey.html#a413484cd565be07b4adc75ed53c4ace7">c</a> [2]&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:ace79b3ff94171d8928ca338ac0a0427b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b1857a53d88b56805180f266cd1867e" id="r_a6b1857a53d88b56805180f266cd1867e"><td class="memItemLeft" >&#160;&#160;&#160;char&#160;&#160;&#160;<a class="el" href="structfitskey.html#aaa0b63820fb73086d2f55ea9687d8126">s</a> [72]&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a6b1857a53d88b56805180f266cd1867e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa914a7430a2746de8ceb641321842784" id="r_aa914a7430a2746de8ceb641321842784"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:aa914a7430a2746de8ceb641321842784"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50ff3c9166c43e1fe0542b18a216ee1" id="r_ad50ff3c9166c43e1fe0542b18a216ee1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#ad50ff3c9166c43e1fe0542b18a216ee1">ulen</a></td></tr>
<tr class="separator:ad50ff3c9166c43e1fe0542b18a216ee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe936ed7df47a073c049f4fe1528ba2" id="r_a4fe936ed7df47a073c049f4fe1528ba2"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html#a4fe936ed7df47a073c049f4fe1528ba2">comment</a> [84]</td></tr>
<tr class="separator:a4fe936ed7df47a073c049f4fe1528ba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Keyword/value information. </p>
<p><a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> returns an array of <b>fitskey</b> structs, each of which contains the result of parsing one FITS header keyrecord. All members of the <b>fitskey</b> struct are returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a>, none are given by the user. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a43de42050c7e0232c9f7c5a28bfede4b" name="a43de42050c7e0232c9f7c5a28bfede4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43de42050c7e0232c9f7c5a28bfede4b">&#9670;&#160;</a></span>keyno</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::keyno</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Keyrecord number (1-relative) in the array passed as input to <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a>. This will be negated if the keyword matched any specified in the keyids[] index. </p>

</div>
</div>
<a id="af5bd77eb6d318c562bfe650f6784eb5f" name="af5bd77eb6d318c562bfe650f6784eb5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5bd77eb6d318c562bfe650f6784eb5f">&#9670;&#160;</a></span>keyid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::keyid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Index into the first entry in keyids[] with which the keyrecord matches, else -1. </p>

</div>
</div>
<a id="a935a63ff3aa2c0403ed8eee1a94662e7" name="a935a63ff3aa2c0403ed8eee1a94662e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a935a63ff3aa2c0403ed8eee1a94662e7">&#9670;&#160;</a></span>status</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::status</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Status flag bit-vector for the header keyrecord employing the following bit masks defined as preprocessor macros:</p>
<ul>
<li>
FITSHDR_KEYWORD: Illegal keyword syntax. </li>
<li>
FITSHDR_KEYVALUE: Illegal keyvalue syntax. </li>
<li>
FITSHDR_COMMENT: Illegal keycomment syntax. </li>
<li>
FITSHDR_KEYREC: Illegal keyrecord, e.g. an <code><b>END</b></code> keyrecord with trailing text. </li>
<li>
FITSHDR_TRAILER: Keyrecord following a valid <code><b>END</b></code> keyrecord. </li>
</ul>
<p>The header keyrecord is syntactically correct if no bits are set. </p>

</div>
</div>
<a id="a48b4ff24100b6ada4fd184d5c3d55eec" name="a48b4ff24100b6ada4fd184d5c3d55eec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48b4ff24100b6ada4fd184d5c3d55eec">&#9670;&#160;</a></span>keyword</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char fitskey::keyword</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Keyword name, null-filled for keywords of less than eight characters (trailing blanks replaced by nulls).</p>
<p>Use </p><div class="fragment"><div class="line">sprintf(dst, <span class="stringliteral">&quot;%.8s&quot;</span>, <a class="code hl_variable" href="structfitskey.html#a48b4ff24100b6ada4fd184d5c3d55eec">keyword</a>)</div>
<div class="ttc" id="astructfitskey_html_a48b4ff24100b6ada4fd184d5c3d55eec"><div class="ttname"><a href="structfitskey.html#a48b4ff24100b6ada4fd184d5c3d55eec">fitskey::keyword</a></div><div class="ttdeci">char keyword[12]</div><div class="ttdef"><b>Definition</b> fitshdr.h:422</div></div>
</div><!-- fragment --><p>to copy it to a character array with null-termination, or </p><div class="fragment"><div class="line">sprintf(dst, <span class="stringliteral">&quot;%8.8s&quot;</span>, <a class="code hl_variable" href="structfitskey.html#a48b4ff24100b6ada4fd184d5c3d55eec">keyword</a>)</div>
</div><!-- fragment --><p>to blank-fill to eight characters followed by null-termination. </p>

</div>
</div>
<a id="adbc83643fe92fd44408a6d62dbaf87b1" name="adbc83643fe92fd44408a6d62dbaf87b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbc83643fe92fd44408a6d62dbaf87b1">&#9670;&#160;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Keyvalue data type: </p><ul>
<li>
0: No keyvalue (both the value and type are undefined). </li>
<li>
1: Logical, represented as int. </li>
<li>
2: 32-bit signed integer. </li>
<li>
3: 64-bit signed integer (see below). </li>
<li>
4: Very long integer (see below). </li>
<li>
5: Floating point (stored as double). </li>
<li>
6: Integer complex (stored as double[2]). </li>
<li>
7: Floating point complex (stored as double[2]). </li>
<li>
8: String. </li>
<li>
8+10*n: Continued string (described below and in <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> note 2). </li>
</ul>
<p>A negative type indicates that a syntax error was encountered when attempting to parse a keyvalue of the particular type.</p>
<p>Comments on particular data types: </p><ul>
<li>
<p class="startli">64-bit signed integers lie in the range </p><div class="fragment"><div class="line">(-9223372036854775808 &lt;= <a class="code hl_typedef" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a> &lt;  -2147483648) ||</div>
<div class="line">         (+2147483647 &lt;  <a class="code hl_typedef" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a> &lt;= +9223372036854775807)</div>
<div class="ttc" id="afitshdr_8h_html_a88ab82d73e5c2607f0a40af8917fffe1"><div class="ttname"><a href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a></div><div class="ttdeci">int int64[3]</div><div class="ttdoc">64-bit signed integer data type.</div><div class="ttdef"><b>Definition</b> fitshdr.h:402</div></div>
</div><!-- fragment --><p class="interli">A native 64-bit data type may be defined via preprocessor macro WCSLIB_INT64 defined in wcsconfig.h, e.g. as 'long long int'; this will be typedef'd to 'int64' here. If WCSLIB_INT64 is not set, then int64 is typedef'd to int[3] instead and <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> is to be computed as </p><div class="fragment"><div class="line">((<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[2]) * 1000000000 +</div>
<div class="line">  <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[1]) * 1000000000 +</div>
<div class="line">  <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[0]</div>
<div class="ttc" id="astructfitskey_html_aa914a7430a2746de8ceb641321842784"><div class="ttname"><a href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a></div><div class="ttdeci">union fitskey::@1 keyvalue</div></div>
</div><!-- fragment --><p class="interli">and may reported via </p><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[2]) {</div>
<div class="line">  printf(<span class="stringliteral">&quot;%d%09d%09d&quot;</span>, <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[2], abs(<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[1]),</div>
<div class="line">                       abs(<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[0]));</div>
<div class="line">} <span class="keywordflow">else</span> {</div>
<div class="line">  printf(<span class="stringliteral">&quot;%d%09d&quot;</span>, <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[1], abs(<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.k[0]));</div>
<div class="line">}</div>
</div><!-- fragment --><p class="interli">where keyvalue.k[0] and keyvalue.k[1] range from -999999999 to +999999999.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Very long integers, up to 70 decimal digits in length, are encoded in keyvalue.l as an array of int[8], each of which stores 9 decimal digits. <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> is to be computed as </p><div class="fragment"><div class="line">(((((((<a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[7]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[6]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[5]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[4]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[3]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[2]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[1]) * 1000000000 +</div>
<div class="line">       <a class="code hl_variable" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">keyvalue</a>.l[0]</div>
</div><!-- fragment --><p class="endli"></p>
</li>
<li>
Continued strings are not reconstructed, they remain split over successive <b>fitskey</b> structs in the keys[] array returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a>. <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> data type, 8 + 10n, indicates the segment number, n, in the continuation. </li>
</ul>

</div>
</div>
<a id="a42413fd1f1f3117a4bc4c0599c2c3889" name="a42413fd1f1f3117a4bc4c0599c2c3889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42413fd1f1f3117a4bc4c0599c2c3889">&#9670;&#160;</a></span>padding</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::padding</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(An unused variable inserted for alignment purposes only.) </p>

</div>
</div>
<a id="a88e62afbb23808ae484b8734bb1685b9" name="a88e62afbb23808ae484b8734bb1685b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88e62afbb23808ae484b8734bb1685b9">&#9670;&#160;</a></span>i</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::i</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Logical (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 1) and 32-bit signed integer (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 2) data types in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="af1a8fb88bc5d4ba60f9f12d0885c360e" name="af1a8fb88bc5d4ba60f9f12d0885c360e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1a8fb88bc5d4ba60f9f12d0885c360e">&#9670;&#160;</a></span>k</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a> fitskey::k</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) 64-bit signed integer (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 3) data type in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="a68ab074cc13a9e0be1583ee93aa0db6b" name="a68ab074cc13a9e0be1583ee93aa0db6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68ab074cc13a9e0be1583ee93aa0db6b">&#9670;&#160;</a></span>l</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::l</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Very long integer (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 4) data type in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="ae6f81da89b09d92db5258191a1a9354b" name="ae6f81da89b09d92db5258191a1a9354b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6f81da89b09d92db5258191a1a9354b">&#9670;&#160;</a></span>f</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double fitskey::f</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Floating point (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 5) data type in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="a413484cd565be07b4adc75ed53c4ace7" name="a413484cd565be07b4adc75ed53c4ace7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413484cd565be07b4adc75ed53c4ace7">&#9670;&#160;</a></span>c</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double fitskey::c</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Integer and floating point complex (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 6 || 7) data types in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="aaa0b63820fb73086d2f55ea9687d8126" name="aaa0b63820fb73086d2f55ea9687d8126"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa0b63820fb73086d2f55ea9687d8126">&#9670;&#160;</a></span>s</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char fitskey::s</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Null-terminated string (<a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a> == 8) data type in the <a class="el" href="structfitskey.html#aa914a7430a2746de8ceb641321842784">fitskey::keyvalue</a> union. </p>

</div>
</div>
<a id="aa914a7430a2746de8ceb641321842784" name="aa914a7430a2746de8ceb641321842784"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa914a7430a2746de8ceb641321842784">&#9670;&#160;</a></span>keyvalue</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union fitskey::keyvalue</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) A union comprised of</p>
<ul>
<li>
<a class="el" href="structfitskey.html#a88e62afbb23808ae484b8734bb1685b9">fitskey::i</a>, </li>
<li>
<a class="el" href="structfitskey.html#af1a8fb88bc5d4ba60f9f12d0885c360e">fitskey::k</a>, </li>
<li>
<a class="el" href="structfitskey.html#a68ab074cc13a9e0be1583ee93aa0db6b">fitskey::l</a>, </li>
<li>
<a class="el" href="structfitskey.html#ae6f81da89b09d92db5258191a1a9354b">fitskey::f</a>, </li>
<li>
<a class="el" href="structfitskey.html#a413484cd565be07b4adc75ed53c4ace7">fitskey::c</a>, </li>
<li>
<a class="el" href="structfitskey.html#aaa0b63820fb73086d2f55ea9687d8126">fitskey::s</a>, </li>
</ul>
<p>used by the <b>fitskey</b> struct to contain the value associated with a keyword. </p>

</div>
</div>
<a id="ad50ff3c9166c43e1fe0542b18a216ee1" name="ad50ff3c9166c43e1fe0542b18a216ee1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad50ff3c9166c43e1fe0542b18a216ee1">&#9670;&#160;</a></span>ulen</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fitskey::ulen</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Where a keycomment contains a units string in the standard form, e.g. [m/s], the ulen member indicates its length, inclusive of square brackets. Otherwise ulen is zero. </p>

</div>
</div>
<a id="a4fe936ed7df47a073c049f4fe1528ba2" name="a4fe936ed7df47a073c049f4fe1528ba2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fe936ed7df47a073c049f4fe1528ba2">&#9670;&#160;</a></span>comment</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char fitskey::comment</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Keycomment, i.e. comment associated with the keyword or, for keyrecords rejected because of syntax errors, the compete keyrecord itself with null-termination.</p>
<p>Comments are null-terminated with trailing spaces removed. Leading spaces are also removed from keycomments (i.e. those immediately following the '<code><b>/</b></code>' character), but not from <code><b>COMMENT</b></code> or <code><b>HISTORY</b></code> keyrecords or keyrecords without a value indicator (''<code><b>= </b></code>'' in columns 9-80). </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 29 2023 19:09:57 for WCSLIB by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>