wcslib (8.2.2)
<!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: fitshdr.h File 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"> 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&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&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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_af99bb3c152a306abd27951285ad1127.html">C</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">fitshdr.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "wcsconfig.h"</code><br />
</div>
<p><a href="fitshdr_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskeyid.html">fitskeyid</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Keyword indexing. <a href="structfitskeyid.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html">fitskey</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Keyword/value information. <a href="structfitskey.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a42bdf2e2f36d1dee9e06732c75a8ff89" id="r_a42bdf2e2f36d1dee9e06732c75a8ff89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a42bdf2e2f36d1dee9e06732c75a8ff89">FITSHDR_KEYWORD</a>   0x01</td></tr>
<tr class="memdesc:a42bdf2e2f36d1dee9e06732c75a8ff89"><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyword syntax. <br /></td></tr>
<tr class="separator:a42bdf2e2f36d1dee9e06732c75a8ff89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5077485c3de4b7bca55698eb66110a76" id="r_a5077485c3de4b7bca55698eb66110a76"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a5077485c3de4b7bca55698eb66110a76">FITSHDR_KEYVALUE</a>   0x02</td></tr>
<tr class="memdesc:a5077485c3de4b7bca55698eb66110a76"><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyvalue syntax. <br /></td></tr>
<tr class="separator:a5077485c3de4b7bca55698eb66110a76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6400ad537ecfd565fb39a574831edf41" id="r_a6400ad537ecfd565fb39a574831edf41"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a6400ad537ecfd565fb39a574831edf41">FITSHDR_COMMENT</a>   0x04</td></tr>
<tr class="memdesc:a6400ad537ecfd565fb39a574831edf41"><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keycomment syntax. <br /></td></tr>
<tr class="separator:a6400ad537ecfd565fb39a574831edf41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9361fbafbbbba777da623fc3b9e96d2e" id="r_a9361fbafbbbba777da623fc3b9e96d2e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a9361fbafbbbba777da623fc3b9e96d2e">FITSHDR_KEYREC</a>   0x08</td></tr>
<tr class="memdesc:a9361fbafbbbba777da623fc3b9e96d2e"><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyrecord. <br /></td></tr>
<tr class="separator:a9361fbafbbbba777da623fc3b9e96d2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a705c7c2c9700367e0e8b82d5033e6fa3" id="r_a705c7c2c9700367e0e8b82d5033e6fa3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a705c7c2c9700367e0e8b82d5033e6fa3">FITSHDR_CARD</a>   0x08</td></tr>
<tr class="memdesc:a705c7c2c9700367e0e8b82d5033e6fa3"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <br /></td></tr>
<tr class="separator:a705c7c2c9700367e0e8b82d5033e6fa3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8393f26f643097bb78326a85b4e2e7a4" id="r_a8393f26f643097bb78326a85b4e2e7a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a8393f26f643097bb78326a85b4e2e7a4">FITSHDR_TRAILER</a>   0x10</td></tr>
<tr class="memdesc:a8393f26f643097bb78326a85b4e2e7a4"><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating keyrecord following a valid END keyrecord. <br /></td></tr>
<tr class="separator:a8393f26f643097bb78326a85b4e2e7a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23868c17c44dc94add97438092d3058c" id="r_a23868c17c44dc94add97438092d3058c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a23868c17c44dc94add97438092d3058c">KEYIDLEN</a>   (sizeof(struct <a class="el" href="structfitskeyid.html">fitskeyid</a>)/sizeof(int))</td></tr>
<tr class="separator:a23868c17c44dc94add97438092d3058c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6ae55940dfdf1155736df656d83a7cd" id="r_ae6ae55940dfdf1155736df656d83a7cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#ae6ae55940dfdf1155736df656d83a7cd">KEYLEN</a>   (sizeof(struct <a class="el" href="structfitskey.html">fitskey</a>)/sizeof(int))</td></tr>
<tr class="separator:ae6ae55940dfdf1155736df656d83a7cd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a88ab82d73e5c2607f0a40af8917fffe1" id="r_a88ab82d73e5c2607f0a40af8917fffe1"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a>[3]</td></tr>
<tr class="memdesc:a88ab82d73e5c2607f0a40af8917fffe1"><td class="mdescLeft"> </td><td class="mdescRight">64-bit signed integer data type. <br /></td></tr>
<tr class="separator:a88ab82d73e5c2607f0a40af8917fffe1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4d7dfa6de37191eb897faa60ce216412" id="r_a4d7dfa6de37191eb897faa60ce216412"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412">fitshdr_errmsg_enum</a> { <br />
  <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412a8f88dbd41c3e1e65e4953e5fc6f2cb51">FITSHDRERR_SUCCESS</a> = 0
, <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412a63a6fb5e1687601e9b4f2788260bbf46">FITSHDRERR_NULL_POINTER</a> = 1
, <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412ab423fa4f6030c2480b8ed78088318bbe">FITSHDRERR_MEMORY</a> = 2
, <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412a303803fdbecabde6bc9bb607cb284242">FITSHDRERR_FLEX_PARSER</a> = 3
, <br />
  <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412a9904089dd772386251e46f4a1f118b0f">FITSHDRERR_DATA_TYPE</a> = 4
<br />
}</td></tr>
<tr class="separator:a4d7dfa6de37191eb897faa60ce216412"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aebb4607327b6db35b468517328f67878" id="r_aebb4607327b6db35b468517328f67878"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878">fitshdr</a> (const char header[], int nkeyrec, int nkeyids, struct <a class="el" href="structfitskeyid.html">fitskeyid</a> keyids[], int *nreject, struct <a class="el" href="structfitskey.html">fitskey</a> **keys)</td></tr>
<tr class="memdesc:aebb4607327b6db35b468517328f67878"><td class="mdescLeft"> </td><td class="mdescRight">FITS header parser routine. <br /></td></tr>
<tr class="separator:aebb4607327b6db35b468517328f67878"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ad966ed3fefd26c9546ec078171e3940b" id="r_ad966ed3fefd26c9546ec078171e3940b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#ad966ed3fefd26c9546ec078171e3940b">fitshdr_errmsg</a> []</td></tr>
<tr class="memdesc:ad966ed3fefd26c9546ec078171e3940b"><td class="mdescLeft"> </td><td class="mdescRight">Status return messages. <br /></td></tr>
<tr class="separator:ad966ed3fefd26c9546ec078171e3940b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The Flexible Image Transport System (FITS), is a data format widely used in astronomy for data interchange and archive. It is described in </p><div class="fragment"><div class="line"><span class="stringliteral">"Definition of the Flexible Image Transport System (FITS), version 3.0"</span>,</div>
<div class="line">Pence, W.D., Chiappetti, L., Page, C.G., Shaw, R.A., & Stobie, E. 2010,</div>
<div class="line">A&A, 524, A42 - http:<span class="comment">//dx.doi.org/10.1051/0004-6361/201015362</span></div>
</div><!-- fragment --><p><b>See also http:</b> <br />
<a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> is a generic FITS header parser provided to handle keyrecords that are ignored by the WCS header parsers, <a class="el" href="wcshdr_8h.html#ac75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih()</a> and <a class="el" href="wcshdr_8h.html#adc053d80a9c4da454a52eed34e123633" title="FITS WCS parser routine for binary table and image headers.">wcsbth()</a>. Typically the latter may be set to remove WCS keyrecords from a header leaving <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> to handle the remainder. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a42bdf2e2f36d1dee9e06732c75a8ff89" name="a42bdf2e2f36d1dee9e06732c75a8ff89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42bdf2e2f36d1dee9e06732c75a8ff89">◆ </a></span>FITSHDR_KEYWORD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_KEYWORD   0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit indicating illegal keyword syntax. </p>
<p>Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keyword syntax. </p>
</div>
</div>
<a id="a5077485c3de4b7bca55698eb66110a76" name="a5077485c3de4b7bca55698eb66110a76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5077485c3de4b7bca55698eb66110a76">◆ </a></span>FITSHDR_KEYVALUE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_KEYVALUE   0x02</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit indicating illegal keyvalue syntax. </p>
<p>Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keyvalue syntax. </p>
</div>
</div>
<a id="a6400ad537ecfd565fb39a574831edf41" name="a6400ad537ecfd565fb39a574831edf41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6400ad537ecfd565fb39a574831edf41">◆ </a></span>FITSHDR_COMMENT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_COMMENT   0x04</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit indicating illegal keycomment syntax. </p>
<p>Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keycomment syntax. </p>
</div>
</div>
<a id="a9361fbafbbbba777da623fc3b9e96d2e" name="a9361fbafbbbba777da623fc3b9e96d2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9361fbafbbbba777da623fc3b9e96d2e">◆ </a></span>FITSHDR_KEYREC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_KEYREC   0x08</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit indicating illegal keyrecord. </p>
<p>Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating an illegal keyrecord, e.g. an END keyrecord with trailing text. </p>
</div>
</div>
<a id="a705c7c2c9700367e0e8b82d5033e6fa3" name="a705c7c2c9700367e0e8b82d5033e6fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a705c7c2c9700367e0e8b82d5033e6fa3">◆ </a></span>FITSHDR_CARD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_CARD   0x08</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <em>FITSHDR_KEYREC</em> instead. </dd></dl>
</div>
</div>
<a id="a8393f26f643097bb78326a85b4e2e7a4" name="a8393f26f643097bb78326a85b4e2e7a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8393f26f643097bb78326a85b4e2e7a4">◆ </a></span>FITSHDR_TRAILER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FITSHDR_TRAILER   0x10</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag bit indicating keyrecord following a valid END keyrecord. </p>
<p>Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating a keyrecord following a valid END keyrecord. </p>
</div>
</div>
<a id="a23868c17c44dc94add97438092d3058c" name="a23868c17c44dc94add97438092d3058c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23868c17c44dc94add97438092d3058c">◆ </a></span>KEYIDLEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEYIDLEN   (sizeof(struct <a class="el" href="structfitskeyid.html">fitskeyid</a>)/sizeof(int))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae6ae55940dfdf1155736df656d83a7cd" name="ae6ae55940dfdf1155736df656d83a7cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ae55940dfdf1155736df656d83a7cd">◆ </a></span>KEYLEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEYLEN   (sizeof(struct <a class="el" href="structfitskey.html">fitskey</a>)/sizeof(int))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a88ab82d73e5c2607f0a40af8917fffe1" name="a88ab82d73e5c2607f0a40af8917fffe1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ab82d73e5c2607f0a40af8917fffe1">◆ </a></span>int64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64</td>
</tr>
</table>
</div><div class="memdoc">
<p>64-bit signed integer data type. </p>
<p>64-bit signed integer data type defined via preprocessor macro WCSLIB_INT64 which may be defined in wcsconfig.h. For example</p>
<div class="fragment"><div class="line"><span class="preprocessor">#define WCSLIB_INT64 long long int</span></div>
</div><!-- fragment --><p>This is typedef'd in <a class="el" href="fitshdr_8h.html">fitshdr.h</a> as</p>
<div class="fragment"><div class="line"><span class="preprocessor">#ifdef WCSLIB_INT64</span></div>
<div class="line"> <span class="keyword">typedef</span> WCSLIB_INT64 <a class="code hl_typedef" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a>;</div>
<div class="line"><span class="preprocessor">#else</span></div>
<div class="line"> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code hl_typedef" href="fitshdr_8h.html#a88ab82d73e5c2607f0a40af8917fffe1">int64</a>[3];</div>
<div class="line"><span class="preprocessor">#endif</span></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>See <a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a>. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a4d7dfa6de37191eb897faa60ce216412" name="a4d7dfa6de37191eb897faa60ce216412"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d7dfa6de37191eb897faa60ce216412">◆ </a></span>fitshdr_errmsg_enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="fitshdr_8h.html#a4d7dfa6de37191eb897faa60ce216412">fitshdr_errmsg_enum</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4d7dfa6de37191eb897faa60ce216412a8f88dbd41c3e1e65e4953e5fc6f2cb51" name="a4d7dfa6de37191eb897faa60ce216412a8f88dbd41c3e1e65e4953e5fc6f2cb51"></a>FITSHDRERR_SUCCESS </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4d7dfa6de37191eb897faa60ce216412a63a6fb5e1687601e9b4f2788260bbf46" name="a4d7dfa6de37191eb897faa60ce216412a63a6fb5e1687601e9b4f2788260bbf46"></a>FITSHDRERR_NULL_POINTER </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4d7dfa6de37191eb897faa60ce216412ab423fa4f6030c2480b8ed78088318bbe" name="a4d7dfa6de37191eb897faa60ce216412ab423fa4f6030c2480b8ed78088318bbe"></a>FITSHDRERR_MEMORY </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4d7dfa6de37191eb897faa60ce216412a303803fdbecabde6bc9bb607cb284242" name="a4d7dfa6de37191eb897faa60ce216412a303803fdbecabde6bc9bb607cb284242"></a>FITSHDRERR_FLEX_PARSER </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4d7dfa6de37191eb897faa60ce216412a9904089dd772386251e46f4a1f118b0f" name="a4d7dfa6de37191eb897faa60ce216412a9904089dd772386251e46f4a1f118b0f"></a>FITSHDRERR_DATA_TYPE </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aebb4607327b6db35b468517328f67878" name="aebb4607327b6db35b468517328f67878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebb4607327b6db35b468517328f67878">◆ </a></span>fitshdr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fitshdr </td>
<td>(</td>
<td class="paramtype">const char </td>
<td class="paramname"><em>header</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nkeyrec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nkeyids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structfitskeyid.html">fitskeyid</a> </td>
<td class="paramname"><em>keyids</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>nreject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structfitskey.html">fitskey</a> ** </td>
<td class="paramname"><em>keys</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FITS header parser routine. </p>
<p><b>fitshdr</b>() parses a character array containing a FITS header, extracting all keywords and their values into an array of <a class="el" href="structfitskey.html" title="Keyword/value information.">fitskey</a> structs.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">header</td><td>Character array containing the (entire) FITS header, for example, as might be obtained conveniently via the CFITSIO routine fits_hdr2str(). <br />
Each header "keyrecord" (formerly "card image") consists of exactly 80 7-bit ASCII printing characters in the range 0x20 to 0x7e (which excludes NUL, BS, TAB, LF, FF and CR) especially noting that the keyrecords are NOT null-terminated. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nkeyrec</td><td>Number of keyrecords in header[]. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nkeyids</td><td>Number of entries in keyids[].</td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">keyids</td><td>While all keywords are extracted from the header, keyids[] provides a convienient way of indexing them. The <a class="el" href="structfitskeyid.html" title="Keyword indexing.">fitskeyid</a> struct contains three members; <a class="el" href="structfitskeyid.html#a9c19a56e7a92c1728bebd92e5370b9c7">fitskeyid::name</a> must be set by the user while <a class="el" href="structfitskeyid.html#ab20aa3220d9994d02a1791e35dc91a56">fitskeyid::count</a> and <a class="el" href="structfitskeyid.html#a8c8c5a6be67ef57333e80e71f320b62e">fitskeyid::idx</a> are returned by <b>fitshdr</b>(). All matched keywords will have their <a class="el" href="structfitskey.html#a43de42050c7e0232c9f7c5a28bfede4b">fitskey::keyno</a> member negated.</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">nreject</td><td>Number of header keyrecords rejected for syntax errors. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">keys</td><td>Pointer to an array of nkeyrec <a class="el" href="structfitskey.html" title="Keyword/value information.">fitskey</a> structs containing all keywords and keyvalues extracted from the header. <br />
Memory for the array is allocated by <b>fitshdr</b>() and this must be freed by the user. See <a class="el" href="wcsutil_8h.html#a6b603ff362203ad122fe67a47d10cb9a" title="free memory allocated by WCSLIB functions.">wcsdealloc()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status return value:<ul>
<li>0: Success.</li>
<li>1: Null <a class="el" href="structfitskey.html" title="Keyword/value information.">fitskey</a> pointer passed.</li>
<li>2: Memory allocation failed.</li>
<li>3: Fatal error returned by Flex parser.</li>
<li>4: Unrecognised data type.</li>
</ul>
</dd></dl>
<p><b>Notes:</b> <br />
</p><ol>
<li>
<p class="startli">Keyword parsing is done in accordance with the syntax defined by NOST 100-2.0, noting the following points in particular:</p>
<ol type="a">
<li>
<p class="startli">Sect. 5.1.2.1 specifies that keywords be left-justified in columns 1-8, blank-filled with no embedded spaces, composed only of the ASCII characters <code><b>ABCDEFGHJKLMNOPQRSTUVWXYZ0123456789-_</b></code></p>
<p class="interli"><b>fitshdr</b>() accepts any characters in columns 1-8 but flags keywords that do not conform to standard syntax.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Sect. 5.1.2.2 defines the "value indicator" as the characters ''<code><b>= </b></code>'' occurring in columns 9 and 10. If these are absent then the keyword has no value and columns 9-80 may contain any ASCII text (but see note 2 for <code><b>CONTINUE</b></code> keyrecords). This is copied to the comment member of the <a class="el" href="structfitskey.html" title="Keyword/value information.">fitskey</a> struct.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Sect. 5.1.2.3 states that a keyword may have a null (undefined) value if the value/comment field, columns 11-80, consists entirely of spaces, possibly followed by a comment.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Sect. 5.1.1 states that trailing blanks in a string keyvalue are not significant and the parser always removes them. A string containing nothing but blanks will be replaced with a single blank.</p>
<p class="interli">Sect. 5.2.1 also states that a quote character (<code><b>'</b></code>) in a string value is to be represented by two successive quote characters and the parser removes the repeated quote.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">The parser recognizes free-format character (NOST 100-2.0, Sect. 5.2.1), integer (Sect. 5.2.3), and floating-point values (Sect. 5.2.4) for all keywords.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Sect. 5.2.3 offers no comment on the size of an integer keyvalue except indirectly in limiting it to 70 digits. The parser will translate an integer keyvalue to a 32-bit signed integer if it lies in the range -2147483648 to +2147483647, otherwise it interprets it as a 64-bit signed integer if possible, or else a "very long" integer (see <a class="el" href="structfitskey.html#adbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a>).</p>
<p class="endli"></p>
</li>
<li>
<code><b>END</b></code> not followed by 77 blanks is not considered to be a legitimate end keyrecord. </li>
</ol>
<p class="endli"></p>
</li>
<li>
<p class="startli">The parser supports a generalization of the OGIP Long String Keyvalue Convention (v1.0) whereby strings may be continued onto successive header keyrecords. A keyrecord contains a segment of a continued string if and only if</p>
<ol type="a">
<li>
<p class="startli">it contains the pseudo-keyword <code><b>CONTINUE</b></code>,</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">columns 9 and 10 are both blank,</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">columns 11 to 80 contain what would be considered a valid string keyvalue, including optional keycomment, if column 9 had contained '<code><b>=</b></code>',</p>
<p class="endli"></p>
</li>
<li>
the previous keyrecord contained either a valid string keyvalue or a valid <code><b>CONTINUE</b></code> keyrecord. </li>
</ol>
<p class="interli">If any of these conditions is violated, the keyrecord is considered in isolation.</p>
<p class="interli">Syntax errors in keycomments in a continued string are treated more permissively than usual; the '<code><b>/</b></code>' delimiter may be omitted provided that parsing of the string keyvalue is not compromised. However, the FITSHDR_COMMENT status bit will be set for the keyrecord (see <a class="el" href="structfitskey.html#a935a63ff3aa2c0403ed8eee1a94662e7">fitskey::status</a>).</p>
<p class="interli">As for normal strings, trailing blanks in a continued string are not significant.</p>
<p class="endli">In the OGIP convention "the '<code><b>&</b></code>' character is used as the last non-blank character of the string to indicate that the string is (probably) continued on the following keyword". This additional syntax is not required by <b>fitshdr</b>(), but if '<code><b>&</b></code>' does occur as the last non-blank character of a continued string keyvalue then it will be removed, along with any trailing blanks. However, blanks that occur before the '<code><b>&</b></code>' will be preserved. </p>
</li>
</ol>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ad966ed3fefd26c9546ec078171e3940b" name="ad966ed3fefd26c9546ec078171e3940b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad966ed3fefd26c9546ec078171e3940b">◆ </a></span>fitshdr_errmsg</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * fitshdr_errmsg[]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Status return messages. </p>
<p>Error messages to match the status value returned from each function. </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 <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>
Browse
Usage
Versions