1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>WCSLIB 4.8.2: fitshdr.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>fitshdr.h File Reference</h1><code>#include "wcsconfig.h"</code><br>
<p>
<a href="fitshdr_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskeyid.html">fitskeyid</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keyword indexing. <a href="structfitskeyid.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskey.html">fitskey</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keyword/value information. <a href="structfitskey.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#42bdf2e2f36d1dee9e06732c75a8ff89">FITSHDR_KEYWORD</a> 0x01</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyword syntax. <a href="#42bdf2e2f36d1dee9e06732c75a8ff89"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#5077485c3de4b7bca55698eb66110a76">FITSHDR_KEYVALUE</a> 0x02</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyvalue syntax. <a href="#5077485c3de4b7bca55698eb66110a76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#6400ad537ecfd565fb39a574831edf41">FITSHDR_COMMENT</a> 0x04</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keycomment syntax. <a href="#6400ad537ecfd565fb39a574831edf41"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#9361fbafbbbba777da623fc3b9e96d2e">FITSHDR_KEYREC</a> 0x08</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating illegal keyrecord. <a href="#9361fbafbbbba777da623fc3b9e96d2e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#705c7c2c9700367e0e8b82d5033e6fa3">FITSHDR_CARD</a> 0x08</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#705c7c2c9700367e0e8b82d5033e6fa3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#8393f26f643097bb78326a85b4e2e7a4">FITSHDR_TRAILER</a> 0x10</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag bit indicating keyrecord following a valid END keyrecord. <a href="#8393f26f643097bb78326a85b4e2e7a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#23868c17c44dc94add97438092d3058c">KEYIDLEN</a> (sizeof(struct <a class="el" href="structfitskeyid.html">fitskeyid</a>)/sizeof(int))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#e6ae55940dfdf1155736df656d83a7cd">KEYLEN</a> (sizeof(struct <a class="el" href="structfitskey.html">fitskey</a>)/sizeof(int))</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#88ab82d73e5c2607f0a40af8917fffe1">int64</a> [3]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">64-bit signed integer data type. <a href="#88ab82d73e5c2607f0a40af8917fffe1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878">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><td class="mdescLeft"> </td><td class="mdescRight">FITS header parser routine. <a href="#ebb4607327b6db35b468517328f67878"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="fitshdr_8h.html#d966ed3fefd26c9546ec078171e3940b">fitshdr_errmsg</a> []</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Status return messages. <a href="#d966ed3fefd26c9546ec078171e3940b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" 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#c75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih()</a> and <a class="el" href="wcshdr_8h.html#dc053d80a9c4da454a52eed34e123633" 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#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> to handle the remainder. <hr><h2>Define Documentation</h2>
<a class="anchor" name="42bdf2e2f36d1dee9e06732c75a8ff89"></a><!-- doxytag: member="fitshdr.h::FITSHDR_KEYWORD" ref="42bdf2e2f36d1dee9e06732c75a8ff89" args="" -->
<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>
Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keyword syntax.
</div>
</div><p>
<a class="anchor" name="5077485c3de4b7bca55698eb66110a76"></a><!-- doxytag: member="fitshdr.h::FITSHDR_KEYVALUE" ref="5077485c3de4b7bca55698eb66110a76" args="" -->
<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>
Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keyvalue syntax.
</div>
</div><p>
<a class="anchor" name="6400ad537ecfd565fb39a574831edf41"></a><!-- doxytag: member="fitshdr.h::FITSHDR_COMMENT" ref="6400ad537ecfd565fb39a574831edf41" args="" -->
<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>
Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating illegal keycomment syntax.
</div>
</div><p>
<a class="anchor" name="9361fbafbbbba777da623fc3b9e96d2e"></a><!-- doxytag: member="fitshdr.h::FITSHDR_KEYREC" ref="9361fbafbbbba777da623fc3b9e96d2e" args="" -->
<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>
Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating an illegal keyrecord, e.g. an END keyrecord with trailing text.
</div>
</div><p>
<a class="anchor" name="705c7c2c9700367e0e8b82d5033e6fa3"></a><!-- doxytag: member="fitshdr.h::FITSHDR_CARD" ref="705c7c2c9700367e0e8b82d5033e6fa3" args="" -->
<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>
<dl compact><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><p>
<a class="anchor" name="8393f26f643097bb78326a85b4e2e7a4"></a><!-- doxytag: member="fitshdr.h::FITSHDR_TRAILER" ref="8393f26f643097bb78326a85b4e2e7a4" args="" -->
<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>
Bit mask for the status flag bit-vector returned by <a class="el" href="fitshdr_8h.html#ebb4607327b6db35b468517328f67878" title="FITS header parser routine.">fitshdr()</a> indicating a keyrecord following a valid END keyrecord.
</div>
</div><p>
<a class="anchor" name="23868c17c44dc94add97438092d3058c"></a><!-- doxytag: member="fitshdr.h::KEYIDLEN" ref="23868c17c44dc94add97438092d3058c" args="" -->
<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">
<p>
</div>
</div><p>
<a class="anchor" name="e6ae55940dfdf1155736df656d83a7cd"></a><!-- doxytag: member="fitshdr.h::KEYLEN" ref="e6ae55940dfdf1155736df656d83a7cd" args="" -->
<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">
<p>
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="88ab82d73e5c2607f0a40af8917fffe1"></a><!-- doxytag: member="fitshdr.h::int64" ref="88ab82d73e5c2607f0a40af8917fffe1" args="[3]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="fitshdr_8h.html#88ab82d73e5c2607f0a40af8917fffe1">int64</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<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"><pre class="fragment"><span class="preprocessor"> #define WCSLIB_INT64 long long int</span>
</pre></div><p>
This is typedef'd in <a class="el" href="fitshdr_8h.html">fitshdr.h</a> as<p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #ifdef WCSLIB_INT64</span>
<span class="preprocessor"></span> <span class="keyword">typedef</span> WCSLIB_INT64 <a class="code" href="fitshdr_8h.html#88ab82d73e5c2607f0a40af8917fffe1" title="64-bit signed integer data type.">int64</a>;
<span class="preprocessor"> #else</span>
<span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> int64[3];
<span class="preprocessor"> #endif</span>
</pre></div><p>
See <a class="el" href="structfitskey.html#dbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ebb4607327b6db35b468517328f67878"></a><!-- doxytag: member="fitshdr.h::fitshdr" ref="ebb4607327b6db35b468517328f67878" args="(const char header[], int nkeyrec, int nkeyids, struct fitskeyid keyids[], int *nreject, struct fitskey **keys)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>header</em> </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 valign="top"><tt>[in]</tt> </td><td valign="top"><em>nkeyrec</em> </td><td>Number of keyrecords in header[]. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nkeyids</em> </td><td>Number of entries in keyids[].</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>keyids</em> </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#9c19a56e7a92c1728bebd92e5370b9c7">fitskeyid::name</a> must be set by the user while <a class="el" href="structfitskeyid.html#b20aa3220d9994d02a1791e35dc91a56">fitskeyid::count</a> and <a class="el" href="structfitskeyid.html#9c19a56e7a92c1728bebd92e5370b9c7">fitskeyid::name</a> are returned by <b>fitshdr</b>(). All matched keywords will have their <a class="el" href="structfitskey.html#43de42050c7e0232c9f7c5a28bfede4b">fitskey::keyno</a> member negated.</td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>nreject</em> </td><td>Number of header keyrecords rejected for syntax errors. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>keys</em> </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 by invoking free() on the array.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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></ul>
</dd></dl>
<b>Notes:</b> <br>
<ol>
<li>
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>
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>
<b>fitshdr</b>() accepts any characters in columns 1-8 but flags keywords that do not conform to standard syntax.<p>
</li>
<li>
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>
</li>
<li>
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>
</li>
<li>
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>
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>
</li>
<li>
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>
</li>
<li>
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 translates 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#dbc83643fe92fd44408a6d62dbaf87b1">fitskey::type</a>).<p>
</li>
<li>
<code><b><code><b>END</b></code></b></code> not followed by 77 blanks is not considered to be a legitimate end keyrecord. </li>
</ol>
<p>
</li>
<li>
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>
it contains the pseudo-keyword <code><b>CONTINUE</b></code>,<p>
</li>
<li>
columns 9 and 10 are both blank,<p>
</li>
<li>
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>
</li>
<li>
the previous keyrecord contained either a valid string keyvalue or a valid <code><b>CONTINUE</b></code> keyrecord. </li>
</ol>
<p>
If any of these conditions is violated, the keyrecord is considered in isolation.<p>
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#935a63ff3aa2c0403ed8eee1a94662e7">fitskey::status</a>).<p>
As for normal strings, trailing blanks in a continued string are not significant.<p>
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. </li>
</ol>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="d966ed3fefd26c9546ec078171e3940b"></a><!-- doxytag: member="fitshdr.h::fitshdr_errmsg" ref="d966ed3fefd26c9546ec078171e3940b" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * <a class="el" href="fitshdr_8h.html#d966ed3fefd26c9546ec078171e3940b">fitshdr_errmsg</a>[] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Error messages to match the status value returned from each function.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:30 2011 for WCSLIB 4.8.2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
