<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>WCSLIB 4.18: wcshdr.h Source File</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="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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WCSLIB 4.18
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</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="headertitle">
<div class="title">wcshdr.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="wcshdr_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*============================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> WCSLIB 4.18 - an implementation of the FITS WCS standard.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (C) 1995-2013, Mark Calabretta</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This file is part of WCSLIB.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> WCSLIB is free software: you can redistribute it and/or modify it under the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> terms of the GNU Lesser General Public License as published by the Free</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Software Foundation, either version 3 of the License, or (at your option)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> any later version.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> more details.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> along with WCSLIB. If not, see http://www.gnu.org/licenses.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> Direct correspondence concerning WCSLIB to mark@calabretta.id.au</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> http://www.atnf.csiro.au/people/Mark.Calabretta</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> $Id: wcshdr.h,v 4.18 2013/07/13 10:00:04 mcalabre Exp $</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">*=============================================================================</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">* WCSLIB 4.18 - C routines that implement the FITS World Coordinate System</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">* (WCS) standard. Refer to</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">* "Representations of world coordinates in FITS",</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">* Greisen, E.W., & Calabretta, M.R. 2002, A&A, 395, 1061 (Paper I)</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">*</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">* "Representations of celestial coordinates in FITS",</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">* Calabretta, M.R., & Greisen, E.W. 2002, A&A, 395, 1077 (Paper II)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">*</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">* "Representations of spectral coordinates in FITS",</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">* Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">* 2006, A&A, 446, 747 (Paper III)</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">*</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">* library.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">*</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">*</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">* Summary of the wcshdr routines</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">* ------------------------------</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">* Routines in this suite are aimed at extracting WCS information from a FITS</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* file. They provide the high-level interface between the FITS file and the</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* WCS coordinate transformation routines.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">*</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">* Additionally, function wcshdo() is provided to write out the contents of a</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">* wcsprm struct as a FITS header.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">*</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">* Briefly, the anticipated sequence of operations is as follows:</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">*</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">* - 1: Open the FITS file and read the image or binary table header, e.g.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">* using CFITSIO routine fits_hdr2str().</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">*</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">* - 2: Parse the header using wcspih() or wcsbth(); they will automatically</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">* interpret 'TAB' header keywords using wcstab().</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">*</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">* - 3: Allocate memory for, and read 'TAB' arrays from the binary table</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">* extension, e.g. using CFITSIO routine fits_read_wcstab() - refer to</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">* the prologue of getwcstab.h. wcsset() will automatically take</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">* control of this allocated memory, in particular causing it to be</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">* free'd by wcsfree().</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">*</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">* - 4: Translate non-standard WCS usage using wcsfix(), see wcsfix.h.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">*</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">* - 5: Initialize wcsprm struct(s) using wcsset() and calculate coordinates</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">* using wcsp2s() and/or wcss2p(). Refer to the prologue of wcs.h for a</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">* description of these and other high-level WCS coordinate</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">* transformation routines.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">*</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">* - 6: Clean up by freeing memory with wcsvfree().</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">*</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">* In detail:</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">*</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">* - wcspih() is a high-level FITS WCS routine that parses an image header. It</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">* returns an array of up to 27 wcsprm structs on each of which it invokes</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">* wcstab().</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">*</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">* - wcsbth() is the analogue of wcspih() for use with binary tables; it</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">* handles image array and pixel list keywords. As an extension of the FITS</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">* WCS standard, it also recognizes image header keywords which may be used</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">* to provide default values via an inheritance mechanism.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">*</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">* - wcstab() assists in filling in members of the wcsprm struct associated</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">* with coordinate lookup tables ('TAB'). These are based on arrays stored</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">* in a FITS binary table extension (BINTABLE) that are located by PVi_ma</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">* keywords in the image header.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">*</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">* - wcsidx() and wcsbdx() are utility routines that return the index for a</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">* specified alternate coordinate descriptor in the array of wcsprm structs</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">* returned by wcspih() or wcsbth().</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">*</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">* - wcsvfree() deallocates memory for an array of wcsprm structs, such as</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">* returned by wcspih() or wcsbth().</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">*</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">* - wcshdo() writes out a wcsprm struct as a FITS header.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">*</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">*</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">* wcspih() - FITS WCS parser routine for image headers</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">* ----------------------------------------------------</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">* wcspih() is a high-level FITS WCS routine that parses an image header,</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">* either that of a primary HDU or of an image extension. All WCS keywords</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">* defined in Papers I, II, and III are recognized, and also those used by the</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">* AIPS convention and certain other keywords that existed in early drafts of</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">* the WCS papers as explained in wcsbth() note 5.</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">*</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">* Given a character array containing a FITS image header, wcspih() identifies</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">* and reads all WCS keywords for the primary coordinate representation and up</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">* to 26 alternate representations. It returns this information as an array of</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">* wcsprm structs.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">*</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">* wcspih() invokes wcstab() on each of the wcsprm structs that it returns.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">*</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">* Use wcsbth() in preference to wcspih() for FITS headers of unknown type;</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">* wcsbth() can parse image headers as well as binary table and pixel list</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">* headers.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">*</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">* header char[] Character array containing the (entire) FITS image</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">* header from which to identify and construct the</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">* coordinate representations, for example, as might be</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">* obtained conveniently via the CFITSIO routine</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">* fits_hdr2str().</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">*</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">* Each header "keyrecord" (formerly "card image")</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">* consists of exactly 80 7-bit ASCII printing characters</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">* in the range 0x20 to 0x7e (which excludes NUL, BS,</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">* TAB, LF, FF and CR) especially noting that the</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">* keyrecords are NOT null-terminated.</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">*</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">* For negative values of ctrl (see below), header[] is</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">* modified so that WCS keyrecords processed by wcspih()</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">* are removed from it.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">*</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">* nkeyrec int Number of keyrecords in header[].</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">*</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">* relax int Degree of permissiveness:</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">* 0: Recognize only FITS keywords defined by the</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">* published WCS standard.</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">* WCSHDR_all: Admit all recognized informal</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">* extensions of the WCS standard.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">* Fine-grained control of the degree of permissiveness</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">* is also possible as explained in wcsbth() note 5.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">*</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">* ctrl int Error reporting and other control options for invalid</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">* WCS and other header keyrecords:</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">* 0: Do not report any rejected header keyrecords.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">* 1: Produce a one-line message stating the number</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">* of WCS keyrecords rejected (nreject).</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">* 2: Report each rejected keyrecord and the reason</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">* why it was rejected.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">* 3: As above, but also report all non-WCS</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">* keyrecords that were discarded, and the number</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">* of coordinate representations (nwcs) found.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">* The report is written to stderr by default, or the</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">* stream set by wcsprintf_set().</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">*</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">* For ctrl < 0, WCS keyrecords processed by wcspih()</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">* are removed from header[]:</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">* -1: Remove only valid WCS keyrecords whose values</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">* were successfully extracted, nothing is</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">* reported.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">* -2: Also remove WCS keyrecords that were rejected,</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">* reporting each one and the reason that it was</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">* rejected.</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">* -3: As above, and also report the number of</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">* coordinate representations (nwcs) found.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">* -11: Same as -1 but preserving the basic keywords</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">* '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">* If any keyrecords are removed from header[] it will</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">* be null-terminated (NUL not being a legal FITS header</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">* character), otherwise it will contain its original</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">* complement of nkeyrec keyrecords and possibly not be</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">* null-terminated.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">*</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">* nreject int* Number of WCS keywords rejected for syntax errors,</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">* illegal values, etc. Keywords not recognized as WCS</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">* keywords are simply ignored. Refer also to wcsbth()</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">* note 5.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">*</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">* nwcs int* Number of coordinate representations found.</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">*</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">* wcs struct wcsprm**</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">* Pointer to an array of wcsprm structs containing up to</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">* 27 coordinate representations.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">*</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">* Memory for the array is allocated by wcspih() which</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">* also invokes wcsini() for each struct to allocate</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">* memory for internal arrays and initialize their</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">* members to default values. Refer also to wcsbth()</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">* note 8. Note that wcsset() is not invoked on these</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment">* structs.</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">*</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">* This allocated memory must be freed by the user, first</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">* by invoking wcsfree() for each struct, and then by</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">* freeing the array itself. A routine, wcsvfree(), is</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">* provided to do this (see below).</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">*</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">* 2: Memory allocation failed.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">* 4: Fatal error returned by Flex parser.</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">*</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">* Notes:</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">* Refer to wcsbth() notes 1, 2, 3, 5, 7, and 8.</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">*</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">*</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">* wcsbth() - FITS WCS parser routine for binary table and image headers</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">* ---------------------------------------------------------------------</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">* wcsbth() is a high-level FITS WCS routine that parses a binary table header.</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">* It handles image array and pixel list WCS keywords which may be present</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">* together in one header.</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">*</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">* As an extension of the FITS WCS standard, wcsbth() also recognizes image</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">* header keywords in a binary table header. These may be used to provide</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">* default values via an inheritance mechanism discussed in note 5 (c.f.</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment">* WCSHDR_AUXIMG and WCSHDR_ALLIMG), or may instead result in wcsprm structs</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">* that are not associated with any particular column. Thus wcsbth() can</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">* handle primary image and image extension headers in addition to binary table</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">* headers (it ignores NAXIS and does not rely on the presence of the TFIELDS</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">* keyword).</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">*</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">* All WCS keywords defined in Papers I, II, and III are recognized, and also</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">* those used by the AIPS convention and certain other keywords that existed in</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment">* early drafts of the WCS papers as explained in note 5 below.</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment">*</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">* wcsbth() sets the colnum or colax[] members of the wcsprm structs that it</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">* returns with the column number of an image array or the column numbers</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">* associated with each pixel coordinate element in a pixel list. wcsprm</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">* structs that are not associated with any particular column, as may be</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">* derived from image header keywords, have colnum == 0.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">*</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">* Note 6 below discusses the number of wcsprm structs returned by wcsbth(),</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">* and the circumstances in which image header keywords cause a struct to be</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">* created. See also note 9 concerning the number of separate images that may</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment">* be stored in a pixel list.</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment">*</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">* The API to wcsbth() is similar to that of wcspih() except for the addition</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">* of extra arguments that may be used to restrict its operation. Like</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment">* wcspih(), wcsbth() invokes wcstab() on each of the wcsprm structs that it</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment">* returns.</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment">*</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">* header char[] Character array containing the (entire) FITS binary</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">* table, primary image, or image extension header from</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment">* which to identify and construct the coordinate</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">* representations, for example, as might be obtained</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">* conveniently via the CFITSIO routine fits_hdr2str().</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">*</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment">* Each header "keyrecord" (formerly "card image")</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">* consists of exactly 80 7-bit ASCII printing</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">* characters in the range 0x20 to 0x7e (which excludes</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment">* NUL, BS, TAB, LF, FF and CR) especially noting that</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">* the keyrecords are NOT null-terminated.</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment">*</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">* For negative values of ctrl (see below), header[] is</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment">* modified so that WCS keyrecords processed by wcsbth()</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment">* are removed from it.</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">*</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">* nkeyrec int Number of keyrecords in header[].</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">*</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">* relax int Degree of permissiveness:</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">* 0: Recognize only FITS keywords defined by the</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment">* published WCS standard.</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">* WCSHDR_all: Admit all recognized informal</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment">* extensions of the WCS standard.</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">* Fine-grained control of the degree of permissiveness</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">* is also possible, as explained in note 5 below.</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">*</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment">* ctrl int Error reporting and other control options for invalid</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment">* WCS and other header keyrecords:</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment">* 0: Do not report any rejected header keyrecords.</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">* 1: Produce a one-line message stating the number</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment">* of WCS keyrecords rejected (nreject).</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment">* 2: Report each rejected keyrecord and the reason</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment">* why it was rejected.</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">* 3: As above, but also report all non-WCS</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment">* keyrecords that were discarded, and the number</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment">* of coordinate representations (nwcs) found.</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment">* The report is written to stderr by default, or the</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment">* stream set by wcsprintf_set().</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment">*</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment">* For ctrl < 0, WCS keyrecords processed by wcsbth()</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment">* are removed from header[]:</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment">* -1: Remove only valid WCS keyrecords whose values</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment">* were successfully extracted, nothing is</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment">* reported.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">* -2: Also remove WCS keyrecords that were rejected,</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment">* reporting each one and the reason that it was</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment">* rejected.</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment">* -3: As above, and also report the number of</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment">* coordinate representations (nwcs) found.</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment">* -11: Same as -1 but preserving the basic keywords</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment">* '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'.</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment">* If any keyrecords are removed from header[] it will</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">* be null-terminated (NUL not being a legal FITS header</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment">* character), otherwise it will contain its original</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment">* complement of nkeyrec keyrecords and possibly not be</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment">* null-terminated.</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">*</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">* keysel int Vector of flag bits that may be used to restrict the</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">* keyword types considered:</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment">* WCSHDR_IMGHEAD: Image header keywords.</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment">* WCSHDR_BIMGARR: Binary table image array.</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment">* WCSHDR_PIXLIST: Pixel list keywords.</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment">* If zero, there is no restriction.</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">*</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment">* Keywords such as EQUIna or RFRQna that are common to</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment">* binary table image arrays and pixel lists (including</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment">* WCSNna and TWCSna, as explained in note 4 below) are</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment">* selected by both WCSHDR_BIMGARR and WCSHDR_PIXLIST.</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment">* Thus if inheritance via WCSHDR_ALLIMG is enabled as</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">* discussed in note 5 and one of these shared keywords</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment">* is present, then WCSHDR_IMGHEAD and WCSHDR_PIXLIST</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment">* alone may be sufficient to cause the construction of</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">* coordinate descriptions for binary table image arrays.</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">*</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">* colsel int* Pointer to an array of table column numbers used to</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">* restrict the keywords considered by wcsbth().</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">*</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">* A null pointer may be specified to indicate that there</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">* is no restriction. Otherwise, the magnitude of</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">* cols[0] specifies the length of the array:</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment">* cols[0] > 0: the columns are included,</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment">* cols[0] < 0: the columns are excluded.</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment">*</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment">* For the pixel list keywords TPn_ka and TCn_ka (and</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment">* TPCn_ka and TCDn_ka if WCSHDR_LONGKEY is enabled), it</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment">* is an error for one column to be selected but not the</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment">* other. This is unlike the situation with invalid</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment">* keyrecords, which are simply rejected, because the</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment">* error is not intrinsic to the header itself but</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment">* arises in the way that it is processed.</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment">*</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment">* nreject int* Number of WCS keywords rejected for syntax errors,</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">* illegal values, etc. Keywords not recognized as WCS</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment">* keywords are simply ignored, refer also to note 5</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment">* below.</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment">*</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment">* nwcs int* Number of coordinate representations found.</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment">*</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment">* wcs struct wcsprm**</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment">* Pointer to an array of wcsprm structs containing up</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment">* to 27027 coordinate representations, refer to note 6</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment">* below.</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment">*</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment">* Memory for the array is allocated by wcsbth() which</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment">* also invokes wcsini() for each struct to allocate</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment">* memory for internal arrays and initialize their</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment">* members to default values. Refer also to note 8</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment">* below. Note that wcsset() is not invoked on these</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">* structs.</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment">*</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment">* This allocated memory must be freed by the user, first</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment">* by invoking wcsfree() for each struct, and then by</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment">* freeing the array itself. A routine, wcsvfree(), is</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment">* provided to do this (see below).</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment">*</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment">* 2: Memory allocation failed.</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment">* 3: Invalid column selection.</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment">* 4: Fatal error returned by Flex parser.</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">*</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment">* Notes:</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment">* 1: wcspih() determines the number of coordinate axes independently for</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment">* each alternate coordinate representation (denoted by the "a" value in</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment">* keywords like CTYPEia) from the higher of</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment">*</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment">* a: NAXIS,</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment">* b: WCSAXESa,</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment">* c: The highest axis number in any parameterized WCS keyword. The</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment">* keyvalue, as well as the keyword, must be syntactically valid</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">* otherwise it will not be considered.</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment">*</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment">* If none of these keyword types is present, i.e. if the header only</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment">* contains auxiliary WCS keywords for a particular coordinate</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment">* representation, then no coordinate description is constructed for it.</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment">*</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment">* wcsbth() is similar except that it ignores the NAXIS keyword if given</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment">* an image header to process.</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment">*</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment">* The number of axes, which is returned as a member of the wcsprm</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment">* struct, may differ for different coordinate representations of the</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment">* same image.</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment">*</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment">* 2: wcspih() and wcsbth() enforce correct FITS "keyword = value" syntax</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment">* with regard to "= " occurring in columns 9 and 10.</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment">*</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment">* However, they do recognize free-format character (NOST 100-2.0,</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment">* Sect. 5.2.1), integer (Sect. 5.2.3), and floating-point values</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment">* (Sect. 5.2.4) for all keywords.</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment">*</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment">* 3: Where CROTAn, CDi_ja, and PCi_ja occur together in one header wcspih()</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment">* and wcsbth() treat them as described in the prologue to wcs.h.</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment">*</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment">* 4: WCS Paper I mistakenly defined the pixel list form of WCSNAMEa as</span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment">* TWCSna instead of WCSNna; the 'T' is meant to substitute for the axis</span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment">* number in the binary table form of the keyword - note that keywords</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment">* defined in WCS Papers II and III that are not parameterised by axis</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment">* number have identical forms for binary tables and pixel lists.</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment">* Consequently wcsbth() always treats WCSNna and TWCSna as equivalent.</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment">*</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment">* 5: wcspih() and wcsbth() interpret the "relax" argument as a vector of</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment">* flag bits to provide fine-grained control over what non-standard WCS</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment">* keywords to accept. The flag bits are subject to change in future and</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment">* should be set by using the preprocessor macros (see below) for the</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">* purpose.</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment">*</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment">* - WCSHDR_none: Don't accept any extensions (not even those in the</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment">* errata). Treat non-conformant keywords in the same way as</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">* non-WCS keywords in the header, i.e. simply ignore them.</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">*</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment">* - WCSHDR_all: Accept all extensions recognized by the parser.</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment">*</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment">* - WCSHDR_reject: Reject non-standard keywords (that are not otherwise</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment">* accepted). A message will optionally be printed on stderr by</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment">* default, or the stream set by wcsprintf_set(), as determined by</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment">* the ctrl argument, and nreject will be incremented.</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">*</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment">* This flag may be used to signal the presence of non-standard</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment">* keywords, otherwise they are simply passed over as though they</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment">* did not exist in the header.</span></div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment">*</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment">* Useful for testing conformance of a FITS header to the WCS</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment">* standard.</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">*</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment">* - WCSHDR_CROTAia: Accept CROTAia (wcspih()),</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment">* iCROTna (wcsbth()),</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment">* TCROTna (wcsbth()).</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment">* - WCSHDR_EPOCHa: Accept EPOCHa.</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment">* - WCSHDR_VELREFa: Accept VELREFa.</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment">* wcspih() always recognizes the AIPS-convention keywords,</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment">* CROTAn, EPOCH, and VELREF for the primary representation</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment">* (a = ' ') but alternates are non-standard.</span></div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment">*</span></div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment">* wcsbth() accepts EPOCHa and VELREFa only if WCSHDR_AUXIMG is</span></div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment">* also enabled.</span></div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment">*</span></div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment">* - WCSHDR_CD00i00j: Accept CD00i00j (wcspih()).</span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment">* - WCSHDR_PC00i00j: Accept PC00i00j (wcspih()).</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment">* - WCSHDR_PROJPn: Accept PROJPn (wcspih()).</span></div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment">* These appeared in early drafts of WCS Paper I+II (before they</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment">* were split) and are equivalent to CDi_ja, PCi_ja, and PVi_ma</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment">* for the primary representation (a = ' '). PROJPn is</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment">* equivalent to PVi_ma with m = n <= 9, and is associated</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment">* exclusively with the latitude axis.</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment">*</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment">* - WCSHDR_RADECSYS: Accept RADECSYS. This appeared in early drafts of</span></div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment">* WCS Paper I+II and was subsequently replaced by RADESYSa.</span></div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment">*</span></div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment">* wcsbth() accepts RADECSYS only if WCSHDR_AUXIMG is also</span></div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment">* enabled.</span></div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment">*</span></div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment">* - WCSHDR_VSOURCE: Accept VSOURCEa or VSOUna (wcsbth()). This appeared</span></div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment">* in early drafts of WCS Paper III and was subsequently dropped</span></div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment">* in favour of ZSOURCEa and ZSOUna.</span></div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment">*</span></div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment">* wcsbth() accepts VSOURCEa only if WCSHDR_AUXIMG is also</span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment">* enabled.</span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment">*</span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment">* - WCSHDR_DOBSn (wcsbth() only): Allow DOBSn, the column-specific analogue</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment">* of DATE-OBS. By an oversight this was never formally defined</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment">* in the standard.</span></div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment">*</span></div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment">* - WCSHDR_LONGKEY (wcsbth() only): Accept long forms of the alternate</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment">* binary table and pixel list WCS keywords, i.e. with "a" non-</span></div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment">* blank. Specifically</span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment">*</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"># jCRPXna TCRPXna : jCRPXn jCRPna TCRPXn TCRPna CRPIXja</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"># - TPCn_ka : - ijPCna - TPn_ka PCi_ja</span></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"># - TCDn_ka : - ijCDna - TCn_ka CDi_ja</span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"># iCDLTna TCDLTna : iCDLTn iCDEna TCDLTn TCDEna CDELTia</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"># iCUNIna TCUNIna : iCUNIn iCUNna TCUNIn TCUNna CUNITia</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"># iCTYPna TCTYPna : iCTYPn iCTYna TCTYPn TCTYna CTYPEia</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"># iCRVLna TCRVLna : iCRVLn iCRVna TCRVLn TCRVna CRVALia</span></div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"># iPVn_ma TPVn_ma : - iVn_ma - TVn_ma PVi_ma</span></div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"># iPSn_ma TPSn_ma : - iSn_ma - TSn_ma PSi_ma</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment">*</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment">* where the primary and standard alternate forms together with</span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment">* the image-header equivalent are shown rightwards of the colon.</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment">*</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment">* The long form of these keywords could be described as quasi-</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment">* standard. TPCn_ka, iPVn_ma, and TPVn_ma appeared by mistake</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment">* in the examples in WCS Paper II and subsequently these and</span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment">* also TCDn_ka, iPSn_ma and TPSn_ma were legitimized by the</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment">* errata to the WCS papers.</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment">*</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment">* Strictly speaking, the other long forms are non-standard and</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment">* in fact have never appeared in any draft of the WCS papers nor</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment">* in the errata. However, as natural extensions of the primary</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment">* form they are unlikely to be written with any other intention.</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment">* Thus it should be safe to accept them provided, of course,</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment">* that the resulting keyword does not exceed the 8-character</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment">* limit.</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment">*</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment">* If WCSHDR_CNAMn is enabled then also accept</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment">*</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"># iCNAMna TCNAMna : --- iCNAna --- TCNAna CNAMEia</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"># iCRDEna TCRDEna : --- iCRDna --- TCRDna CRDERia</span></div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"># iCSYEna TCSYEna : --- iCSYna --- TCSYna CSYERia</span></div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment">*</span></div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment">* Note that CNAMEia, CRDERia, CSYERia, and their variants are</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment">* not used by WCSLIB but are stored in the wcsprm struct as</span></div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment">* auxiliary information.</span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment">*</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment">* - WCSHDR_CNAMn (wcsbth() only): Accept iCNAMn, iCRDEn, iCSYEn, TCNAMn,</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment">* TCRDEn, and TCSYEn, i.e. with "a" blank. While non-standard,</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment">* these are the obvious analogues of iCTYPn, TCTYPn, etc.</span></div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment">*</span></div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment">* - WCSHDR_AUXIMG (wcsbth() only): Allow the image-header form of an</span></div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment">* auxiliary WCS keyword with representation-wide scope to</span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment">* provide a default value for all images. This default may be</span></div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment">* overridden by the column-specific form of the keyword.</span></div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment">*</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment">* For example, a keyword like EQUINOXa would apply to all image</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment">* arrays in a binary table, or all pixel list columns with</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment">* alternate representation "a" unless overridden by EQUIna.</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment">*</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment">* Specifically the keywords are:</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment">*</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"># LATPOLEa for LATPna</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"># LONPOLEa for LONPna</span></div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"># RESTFREQ for RFRQna</span></div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"># RESTFRQa for RFRQna</span></div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"># RESTWAVa for RWAVna</span></div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment">*</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment">* whose keyvalues are actually used by WCSLIB, and also keywords</span></div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment">* that provide auxiliary information that is simply stored in</span></div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment">* the wcsprm struct:</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment">*</span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"># EPOCH - ... (No column-specific form.)</span></div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"># EPOCHa - ... Only if WCSHDR_EPOCHa is set.</span></div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"># EQUINOXa for EQUIna</span></div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"># RADESYSa for RADEna</span></div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"># RADECSYS for RADEna ... Only if WCSHDR_RADECSYS is set.</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"># SPECSYSa for SPECna</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"># SSYSOBSa for SOBSna</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"># SSYSSRCa for SSRCna</span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"># VELOSYSa for VSYSna</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"># VELANGLa for VANGna</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"># VELREF - ... (No column-specific form.)</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"># VELREFa - ... Only if WCSHDR_VELREFa is set.</span></div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"># VSOURCEa for VSOUna ... Only if WCSHDR_VSOURCE is set.</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"># WCSNAMEa for WCSNna ... Or TWCSna (see below).</span></div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"># ZSOURCEa for ZSOUna</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment">*</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"># DATE-AVG for DAVGn</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"># DATE-OBS for DOBSn</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"># MJD-AVG for MJDAn</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"># MJD-OBS for MJDOBn</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"># OBSGEO-X for OBSGXn</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"># OBSGEO-Y for OBSGYn</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"># OBSGEO-Z for OBSGZn</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment">*</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment">* where the image-header keywords on the left provide default</span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment">* values for the column specific keywords on the right.</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment">*</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment">* Keywords in the last group, such as MJD-OBS, apply to all</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment">* alternate representations, so MJD-OBS would provide a default</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment">* value for all images in the header.</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment">*</span></div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment">* This auxiliary inheritance mechanism applies to binary table</span></div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment">* image arrays and pixel lists alike. Most of these keywords</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment">* have no default value, the exceptions being LONPOLEa and</span></div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment">* LATPOLEa, and also RADESYSa and EQUINOXa which provide</span></div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment">* defaults for each other. Thus the only potential difficulty</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment">* in using WCSHDR_AUXIMG is that of erroneously inheriting one</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment">* of these four keywords.</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment">*</span></div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment">* Unlike WCSHDR_ALLIMG, the existence of one (or all) of these</span></div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment">* auxiliary WCS image header keywords will not by itself cause a</span></div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment">* wcsprm struct to be created for alternate representation "a".</span></div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment">* This is because they do not provide sufficient information to</span></div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment">* create a non-trivial coordinate representation when used in</span></div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment">* conjunction with the default values of those keywords, such as</span></div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment">* CTYPEia, that are parameterized by axis number.</span></div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment">*</span></div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment">* - WCSHDR_ALLIMG (wcsbth() only): Allow the image-header form of *all*</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment">* image header WCS keywords to provide a default value for all</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment">* image arrays in a binary table (n.b. not pixel list). This</span></div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment">* default may be overridden by the column-specific form of the</span></div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment">* keyword.</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment">*</span></div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment">* For example, a keyword like CRPIXja would apply to all image</span></div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment">* arrays in a binary table with alternate representation "a"</span></div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment">* unless overridden by jCRPna.</span></div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment">*</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment">* Specifically the keywords are those listed above for</span></div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment">* WCSHDR_AUXIMG plus</span></div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment">*</span></div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"># WCSAXESa for WCAXna</span></div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment">*</span></div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment">* which defines the coordinate dimensionality, and the following</span></div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment">* keywords which are parameterized by axis number:</span></div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment">*</span></div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"># CRPIXja for jCRPna</span></div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"># PCi_ja for ijPCna</span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"># CDi_ja for ijCDna</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"># CDELTia for iCDEna</span></div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"># CROTAi for iCROTn</span></div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"># CROTAia - ... Only if WCSHDR_CROTAia is set.</span></div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"># CUNITia for iCUNna</span></div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"># CTYPEia for iCTYna</span></div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"># CRVALia for iCRVna</span></div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"># PVi_ma for iVn_ma</span></div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"># PSi_ma for iSn_ma</span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment">*</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"># CNAMEia for iCNAna</span></div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"># CRDERia for iCRDna</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"># CSYERia for iCSYna</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment">*</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment">* where the image-header keywords on the left provide default</span></div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment">* values for the column specific keywords on the right.</span></div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment">*</span></div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment">* This full inheritance mechanism only applies to binary table</span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment">* image arrays, not pixel lists, because in the latter case</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment">* there is no well-defined association between coordinate axis</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment">* number and column number.</span></div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment">*</span></div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment">* Note that CNAMEia, CRDERia, CSYERia, and their variants are</span></div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment">* not used by WCSLIB but are stored in the wcsprm struct as</span></div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment">* auxiliary information.</span></div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment">*</span></div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment">* Note especially that at least one wcsprm struct will be</span></div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment">* returned for each "a" found in one of the image header</span></div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment">* keywords listed above:</span></div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment">*</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment">* - If the image header keywords for "a" ARE NOT inherited by a</span></div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment">* binary table, then the struct will not be associated with</span></div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment">* any particular table column number and it is up to the user</span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment">* to provide an association.</span></div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment">*</span></div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment">* - If the image header keywords for "a" ARE inherited by a</span></div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment">* binary table image array, then those keywords are considered</span></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment">* to be "exhausted" and do not result in a separate wcsprm</span></div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment">* struct.</span></div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment">*</span></div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment">* For example, to accept CD00i00j and PC00i00j and reject all other</span></div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment">* extensions, use</span></div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment">*</span></div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment">= relax = WCSHDR_reject | WCSHDR_CD00i00j | WCSHDR_PC00i00j;</span></div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment">*</span></div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment">* The parser always treats EPOCH as subordinate to EQUINOXa if both are</span></div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment">* present, and VSOURCEa is always subordinate to ZSOURCEa.</span></div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment">*</span></div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment">* Likewise, VELREF is subordinate to the formalism of WCS Paper III, see</span></div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment">* spcaips().</span></div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment">*</span></div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment">* Neither wcspih() nor wcsbth() currently recognize the AIPS-convention</span></div>
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment">* keywords ALTRPIX or ALTRVAL which effectively define an alternative</span></div>
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment">* representation for a spectral axis.</span></div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment">*</span></div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment">* 6: Depending on what flags have been set in its "relax" argument,</span></div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment">* wcsbth() could return as many as 27027 wcsprm structs:</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment">*</span></div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment">* - Up to 27 unattached representations derived from image header</span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment">* keywords.</span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment">*</span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment">* - Up to 27 structs for each of up to 999 columns containing an image</span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment">* arrays.</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment">*</span></div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment">* - Up to 27 structs for a pixel list.</span></div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment">*</span></div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment">* Note that it is considered legitimate for a column to contain an image</span></div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment">* array and also form part of a pixel list, and in particular that</span></div>
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment">* wcsbth() does not check the TFORM keyword for a pixel list column to</span></div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment">* check that it is scalar.</span></div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment">*</span></div>
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment">* In practice, of course, a realistic binary table header is unlikely to</span></div>
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment">* contain more than a handful of images.</span></div>
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment">*</span></div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment">* In order for wcsbth() to create a wcsprm struct for a particular</span></div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment">* coordinate representation, at least one WCS keyword that defines an</span></div>
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment">* axis number must be present, either directly or by inheritance if</span></div>
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment">* WCSHDR_ALLIMG is set.</span></div>
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment">*</span></div>
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment">* When the image header keywords for an alternate representation are</span></div>
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment">* inherited by a binary table image array via WCSHDR_ALLIMG, those</span></div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment">* keywords are considered to be "exhausted" and do not result in a</span></div>
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment">* separate wcsprm struct. Otherwise they do.</span></div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment">*</span></div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment">* 7: Neither wcspih() nor wcsbth() check for duplicated keywords, in most</span></div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment">* cases they accept the last encountered.</span></div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment">*</span></div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment">* 8: wcspih() and wcsbth() use wcsnpv() and wcsnps() (refer to the prologue</span></div>
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment">* of wcs.h) to match the size of the pv[] and ps[] arrays in the wcsprm</span></div>
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment">* structs to the number in the header. Consequently there are no unused</span></div>
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment">* elements in the pv[] and ps[] arrays, indeed they will often be of</span></div>
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment">* zero length.</span></div>
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment">*</span></div>
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment">* 9: The FITS WCS standard for pixel lists assumes that a pixel list</span></div>
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment">* defines one and only one image, i.e. that each row of the binary table</span></div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment">* refers to just one event, e.g. the detection of a single photon or</span></div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment">* neutrino.</span></div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment">*</span></div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment">* In the absence of a formal mechanism for identifying the columns</span></div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment">* containing pixel coordinates (as opposed to pixel values or ancillary</span></div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment">* data recorded at the time the photon or neutrino was detected),</span></div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment">* Paper I discusses how the WCS keywords themselves may be used to</span></div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment">* identify them.</span></div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment">*</span></div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment">* In practice, however, pixel lists have been used to store multiple</span></div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment">* images. Besides not specifying how to identify columns, the pixel</span></div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment">* list convention is also silent on the method to be used to associate</span></div>
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment">* table columns with image axes.</span></div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment">*</span></div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment">* wcsbth() simply collects all WCS keywords for a particular coordinate</span></div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment">* representation (i.e. the "a" value in TCTYna) into one wcsprm struct.</span></div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment">* However, these alternates need not be associated with the same table</span></div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment">* columns and this allows a pixel list to contain up to 27 separate</span></div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment">* images. As usual, if one of these representations happened to contain</span></div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment">* more than two celestial axes, for example, then an error would result</span></div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment">* when wcsset() is invoked on it. In this case the "colsel" argument</span></div>
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment">* could be used to restrict the columns used to construct the</span></div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment">* representation so that it only contained one pair of celestial axes.</span></div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment">*</span></div>
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment">*</span></div>
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment">* wcstab() - Tabular construction routine</span></div>
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment">* ---------------------------------------</span></div>
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment">* wcstab() assists in filling in the information in the wcsprm struct relating</span></div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment">* to coordinate lookup tables.</span></div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment">*</span></div>
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment">* Tabular coordinates ('TAB') present certain difficulties in that the main</span></div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment">* components of the lookup table - the multidimensional coordinate array plus</span></div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="comment">* an index vector for each dimension - are stored in a FITS binary table</span></div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="comment">* extension (BINTABLE). Information required to locate these arrays is stored</span></div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment">* in PVi_ma and PSi_ma keywords in the image header.</span></div>
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="comment">*</span></div>
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span> <span class="comment">* wcstab() parses the PVi_ma and PSi_ma keywords associated with each 'TAB'</span></div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment">* axis and allocates memory in the wcsprm struct for the required number of</span></div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment">* tabprm structs. It sets as much of the tabprm struct as can be gleaned from</span></div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment">* the image header, and also sets up an array of wtbarr structs (described in</span></div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment">* the prologue of wcs.h) to assist in extracting the required arrays from the</span></div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment">* BINTABLE extension(s).</span></div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment">*</span></div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment">* It is then up to the user to allocate memory for, and copy arrays from the</span></div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment">* BINTABLE extension(s) into the tabprm structs. A CFITSIO routine,</span></div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment">* fits_read_wcstab(), has been provided for this purpose, see getwcstab.h.</span></div>
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment">* wcsset() will automatically take control of this allocated memory, in</span></div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment">* particular causing it to be free'd by wcsfree(); the user must not attempt</span></div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment">* to free it after wcsset() has been called.</span></div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment">*</span></div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment">* Note that wcspih() and wcsbth() automatically invoke wcstab() on each of the</span></div>
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment">* wcsprm structs that they return.</span></div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment">*</span></div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment">* wcs struct wcsprm*</span></div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment">* Coordinate transformation parameters (see below).</span></div>
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment">*</span></div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment">* wcstab() sets ntab, tab, nwtb and wtb, allocating</span></div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment">* memory for the tab and wtb arrays. This allocated</span></div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment">* memory will be free'd automatically by wcsfree().</span></div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment">*</span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment">* 2: Memory allocation failed.</span></div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment">* 3: Invalid tabular parameters.</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment">*</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span></div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment">*</span></div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment">*</span></div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment">* wcsidx() - Index alternate coordinate representations</span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment">* -----------------------------------------------------</span></div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment">* wcsidx() returns an array of 27 indices for the alternate coordinate</span></div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span> <span class="comment">* representations in the array of wcsprm structs returned by wcspih(). For</span></div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment">* the array returned by wcsbth() it returns indices for the unattached</span></div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment">* (colnum == 0) representations derived from image header keywords - use</span></div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment">* wcsbdx() for those derived from binary table image arrays or pixel lists</span></div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment">* keywords.</span></div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment">*</span></div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment">* nwcs int Number of coordinate representations in the array.</span></div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment">*</span></div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment">* wcs const struct wcsprm**</span></div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment">* Pointer to an array of wcsprm structs returned by</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment">* wcspih() or wcsbth().</span></div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment">*</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment">* alts int[27] Index of each alternate coordinate representation in</span></div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="comment">* the array: alts[0] for the primary, alts[1] for 'A',</span></div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment">* etc., set to -1 if not present.</span></div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="comment">*</span></div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment">* For example, if there was no 'P' representation then</span></div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="comment">*</span></div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment">= alts['P'-'A'+1] == -1;</span></div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment">*</span></div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment">* Otherwise, the address of its wcsprm struct would be</span></div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment">*</span></div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment">= wcs + alts['P'-'A'+1];</span></div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment">*</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment">*</span></div>
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment">*</span></div>
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment">* wcsbdx() - Index alternate coordinate representions</span></div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment">* ---------------------------------------------------</span></div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment">* wcsbdx() returns an array of 999 x 27 indices for the alternate coordinate</span></div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment">* representions for binary table image arrays xor pixel lists in the array of</span></div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment">* wcsprm structs returned by wcsbth(). Use wcsidx() for the unattached</span></div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment">* representations derived from image header keywords.</span></div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment">*</span></div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="comment">* nwcs int Number of coordinate representations in the array.</span></div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment">*</span></div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment">* wcs const struct wcsprm**</span></div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment">* Pointer to an array of wcsprm structs returned by</span></div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment">* wcsbth().</span></div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="comment">*</span></div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment">* type int Select the type of coordinate representation:</span></div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment">* 0: binary table image arrays,</span></div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment">* 1: pixel lists.</span></div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment">*</span></div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="comment">* alts short[1000][28]</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="comment">* Index of each alternate coordinate represention in the</span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="comment">* array: alts[col][0] for the primary, alts[col][1] for</span></div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment">* 'A', to alts[col][26] for 'Z', where col is the</span></div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment">* 1-relative column number, and col == 0 is used for</span></div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment">* unattached image headers. Set to -1 if not present.</span></div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment">*</span></div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment">* alts[col][27] counts the number of coordinate</span></div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment">* representations of the chosen type for each column.</span></div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment">*</span></div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment">* For example, if there was no 'P' represention for</span></div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment">* column 13 then</span></div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment">*</span></div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="comment">= alts[13]['P'-'A'+1] == -1;</span></div>
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span> <span class="comment">*</span></div>
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment">* Otherwise, the address of its wcsprm struct would be</span></div>
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span> <span class="comment">*</span></div>
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span> <span class="comment">= wcs + alts[13]['P'-'A'+1];</span></div>
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment">*</span></div>
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment">*</span></div>
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment">*</span></div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment">* wcsvfree() - Free the array of wcsprm structs</span></div>
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment">* ---------------------------------------------</span></div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment">* wcsvfree() frees the memory allocated by wcspih() or wcsbth() for the array</span></div>
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span> <span class="comment">* of wcsprm structs, first invoking wcsfree() on each of the array members.</span></div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment">*</span></div>
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment">* nwcs int* Number of coordinate representations found; set to 0</span></div>
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment">* on return.</span></div>
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment">*</span></div>
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment">* wcs struct wcsprm**</span></div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment">* Pointer to the array of wcsprm structs; set to 0 on</span></div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment">* return.</span></div>
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment">*</span></div>
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span> <span class="comment">*</span></div>
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="comment">*</span></div>
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment">* wcshdo() - Write out a wcsprm struct as a FITS header</span></div>
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment">* -----------------------------------------------------</span></div>
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment">* wcshdo() translates a wcsprm struct into a FITS header. If the colnum</span></div>
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment">* member of the struct is non-zero then a binary table image array header will</span></div>
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment">* be produced. Otherwise, if the colax[] member of the struct is set non-zero</span></div>
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment">* then a pixel list header will be produced. Otherwise, a primary image or</span></div>
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment">* image extension header will be produced.</span></div>
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment">*</span></div>
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment">* If the struct was originally constructed from a header, e.g. by wcspih(),</span></div>
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment">* the output header will almost certainly differ in a number of respects:</span></div>
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="comment">*</span></div>
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="comment">* - The output header only contains WCS-related keywords. In particular, it</span></div>
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment">* does not contain syntactically-required keywords such as SIMPLE, NAXIS,</span></div>
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment">* BITPIX, or END.</span></div>
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment">*</span></div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment">* - Deprecated (e.g. CROTAn) or non-standard usage will be translated to</span></div>
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment">* standard (this is partially dependent on whether wcsfix() was applied).</span></div>
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment">*</span></div>
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment">* - Quantities will be converted to the units used internally, basically SI</span></div>
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="comment">* with the addition of degrees.</span></div>
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment">*</span></div>
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment">* - Floating-point quantities may be given to a different decimal precision.</span></div>
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment">*</span></div>
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment">* - Elements of the PCi_ja matrix will be written if and only if they differ</span></div>
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="comment">* from the unit matrix. Thus, if the matrix is unity then no elements</span></div>
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="comment">* will be written.</span></div>
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span> <span class="comment">*</span></div>
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="comment">* - Additional keywords such as WCSAXESa, CUNITia, LONPOLEa and LATPOLEa may</span></div>
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="comment">* appear.</span></div>
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="comment">*</span></div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="comment">* - The original keycomments will be lost, although wcshdo() tries hard to</span></div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="comment">* write meaningful comments.</span></div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="comment">*</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="comment">* - Keyword order may be changed.</span></div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment">*</span></div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment">* Keywords can be translated between the image array, binary table, and pixel</span></div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment">* lists forms by manipulating the colnum or colax[] members of the wcsprm</span></div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment">* struct.</span></div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="comment">*</span></div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="comment">* relax int Degree of permissiveness:</span></div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> <span class="comment">* 0: Recognize only FITS keywords defined by the</span></div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="comment">* published WCS standard.</span></div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="comment">* -1: Admit all informal extensions of the WCS</span></div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="comment">* standard.</span></div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="comment">* Fine-grained control of the degree of permissiveness</span></div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment">* is also possible as explained in the notes below.</span></div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment">*</span></div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment">* wcs struct wcsprm*</span></div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment">* Pointer to a wcsprm struct containing coordinate</span></div>
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment">* transformation parameters. Will be initialized if</span></div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment">* necessary.</span></div>
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment">*</span></div>
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment">* nkeyrec int* Number of FITS header keyrecords returned in the</span></div>
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment">* "header" array.</span></div>
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment">*</span></div>
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment">* header char** Pointer to an array of char holding the header.</span></div>
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment">* Storage for the array is allocated by wcshdo() in</span></div>
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment">* blocks of 2880 bytes (32 x 80-character keyrecords)</span></div>
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment">* and must be free'd by the user to avoid memory leaks.</span></div>
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment">*</span></div>
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment">* Each keyrecord is 80 characters long and is *NOT*</span></div>
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment">* null-terminated, so the first keyrecord starts at</span></div>
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment">* (*header)[0], the second at (*header)[80], etc.</span></div>
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment">*</span></div>
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span> <span class="comment">* int Status return value (associated with wcs_errmsg[]):</span></div>
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment">* 1: Null wcsprm pointer passed.</span></div>
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment">* 2: Memory allocation failed.</span></div>
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment">* 3: Linear transformation matrix is singular.</span></div>
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span></div>
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment">* types.</span></div>
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment">* 5: Invalid parameter value.</span></div>
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment">* 6: Invalid coordinate transformation parameters.</span></div>
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment">* 7: Ill-conditioned coordinate transformation</span></div>
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment">* parameters.</span></div>
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment">*</span></div>
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div>
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span></div>
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span> <span class="comment">*</span></div>
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span> <span class="comment">* Notes:</span></div>
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment">* wcshdo() interprets the "relax" argument as a vector of flag bits to</span></div>
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment">* provide fine-grained control over what non-standard WCS keywords to write.</span></div>
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment">* The flag bits are subject to change in future and should be set by using</span></div>
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment">* the preprocessor macros (see below) for the purpose.</span></div>
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment">*</span></div>
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment">* - WCSHDO_none: Don't use any extensions.</span></div>
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment">*</span></div>
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment">* - WCSHDO_all: Write all recognized extensions, equivalent to setting each</span></div>
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span> <span class="comment">* flag bit.</span></div>
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment">*</span></div>
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment">* - WCSHDO_safe: Write all extensions that are considered to be safe and</span></div>
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment">* recommended.</span></div>
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment">*</span></div>
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment">* - WCSHDO_DOBSn: Write DOBSn, the column-specific analogue of DATE-OBS for</span></div>
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment">* use in binary tables and pixel lists. WCS Paper III introduced</span></div>
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment">* DATE-AVG and DAVGn but by an oversight DOBSn (the obvious analogy)</span></div>
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment">* was never formally defined by the standard. The alternative to</span></div>
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment">* using DOBSn is to write DATE-OBS which applies to the whole table.</span></div>
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment">* This usage is considered to be safe and is recommended.</span></div>
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment">*</span></div>
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment">* - WCSHDO_TPCn_ka: WCS Paper I defined</span></div>
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment">*</span></div>
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment">* - TPn_ka and TCn_ka for pixel lists</span></div>
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment">*</span></div>
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment">* but WCS Paper II uses TPCn_ka in one example and subsequently the</span></div>
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment">* errata for the WCS papers legitimized the use of</span></div>
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment">*</span></div>
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span> <span class="comment">* - TPCn_ka and TCDn_ka for pixel lists</span></div>
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span> <span class="comment">*</span></div>
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span> <span class="comment">* provided that the keyword does not exceed eight characters. This</span></div>
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span> <span class="comment">* usage is considered to be safe and is recommended because of the</span></div>
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span> <span class="comment">* non-mnemonic terseness of the shorter forms.</span></div>
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span> <span class="comment">*</span></div>
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span> <span class="comment">* - WCSHDO_PVn_ma: WCS Paper I defined</span></div>
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span> <span class="comment">*</span></div>
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span> <span class="comment">* - iVn_ma and iSn_ma for bintables and</span></div>
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span> <span class="comment">* - TVn_ma and TSn_ma for pixel lists</span></div>
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span> <span class="comment">*</span></div>
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment">* but WCS Paper II uses iPVn_ma and TPVn_ma in the examples and</span></div>
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment">* subsequently the errata for the WCS papers legitimized the use of</span></div>
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment">*</span></div>
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment">* - iPVn_ma and iPSn_ma for bintables and</span></div>
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> <span class="comment">* - TPVn_ma and TPSn_ma for pixel lists</span></div>
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> <span class="comment">*</span></div>
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment">* provided that the keyword does not exceed eight characters. This</span></div>
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment">* usage is considered to be safe and is recommended because of the</span></div>
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment">* non-mnemonic terseness of the shorter forms.</span></div>
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment">*</span></div>
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span> <span class="comment">* - WCSHDO_CRPXna: For historical reasons WCS Paper I defined</span></div>
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span> <span class="comment">*</span></div>
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> <span class="comment">* - jCRPXn, iCDLTn, iCUNIn, iCTYPn, and iCRVLn for bintables and</span></div>
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span> <span class="comment">* - TCRPXn, TCDLTn, TCUNIn, TCTYPn, and TCRVLn for pixel lists</span></div>
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span> <span class="comment">*</span></div>
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span> <span class="comment">* for use without an alternate version specifier. However, because</span></div>
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span> <span class="comment">* of the eight-character keyword constraint, in order to accommodate</span></div>
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span> <span class="comment">* column numbers greater than 99 WCS Paper I also defined</span></div>
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> <span class="comment">*</span></div>
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span> <span class="comment">* - jCRPna, iCDEna, iCUNna, iCTYna and iCRVna for bintables and</span></div>
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span> <span class="comment">* - TCRPna, TCDEna, TCUNna, TCTYna and TCRVna for pixel lists</span></div>
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> <span class="comment">*</span></div>
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment">* for use with an alternate version specifier (the "a"). Like the</span></div>
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment">* PC, CD, PV, and PS keywords there is an obvious tendency to</span></div>
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment">* confuse these two forms for column numbers up to 99. It is very</span></div>
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment">* unlikely that any parser would reject keywords in the first set</span></div>
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment">* with a non-blank alternate version specifier so this usage is</span></div>
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment">* considered to be safe and is recommended.</span></div>
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span> <span class="comment">*</span></div>
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> <span class="comment">* - WCSHDO_CNAMna: WCS Papers I and III defined</span></div>
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> <span class="comment">*</span></div>
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> <span class="comment">* - iCNAna, iCRDna, and iCSYna for bintables and</span></div>
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment">* - TCNAna, TCRDna, and TCSYna for pixel lists</span></div>
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment">*</span></div>
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span> <span class="comment">* By analogy with the above, the long forms would be</span></div>
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span> <span class="comment">*</span></div>
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span> <span class="comment">* - iCNAMna, iCRDEna, and iCSYEna for bintables and</span></div>
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> <span class="comment">* - TCNAMna, TCRDEna, and TCSYEna for pixel lists</span></div>
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> <span class="comment">*</span></div>
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> <span class="comment">* Note that these keywords provide auxiliary information only, none</span></div>
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span> <span class="comment">* of them are needed to compute world coordinates. This usage is</span></div>
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> <span class="comment">* potentially unsafe and is not recommended at this time.</span></div>
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span> <span class="comment">*</span></div>
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> <span class="comment">* - WCSHDO_WCSNna: In light of wcsbth() note 4, write WCSNna instead of</span></div>
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment">* TWCSna for pixel lists. While wcsbth() treats WCSNna and TWCSna</span></div>
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment">* as equivalent, other parsers may not. Consequently, this usage</span></div>
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment">* is potentially unsafe and is not recommended at this time.</span></div>
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment">*</span></div>
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment">*</span></div>
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment">* Global variable: const char *wcshdr_errmsg[] - Status return messages</span></div>
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> <span class="comment">* ---------------------------------------------------------------------</span></div>
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="comment">* Error messages to match the status value returned from each function.</span></div>
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment">* Use wcs_errmsg[] for status returns from wcshdo().</span></div>
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span> <span class="comment">*</span></div>
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span> <span class="comment">*===========================================================================*/</span></div>
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> </div>
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span> <span class="preprocessor">#ifndef WCSLIB_WCSHDR</span></div>
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span> <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSHDR</span></div>
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span> <span class="preprocessor">#include "<a class="code" href="wcs_8h.html">wcs.h</a>"</span></div>
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> </div>
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01063"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a92a0007f672a5498ab1b6ccc6a4a002b"> 1063</a></span> <span class="preprocessor">#define WCSHDR_none 0x00000000</span></div>
<div class="line"><a name="l01064"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a0b9b53e5cfd05653cbca75cf1aa8b2ed"> 1064</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_all 0x000FFFFF</span></div>
<div class="line"><a name="l01065"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#afd6d52bed79bd48230f651ac48eb5ca6"> 1065</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_reject 0x10000000</span></div>
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01067"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a017f1e817bdb2114ba765e7a9ef73bac"> 1067</a></span> <span class="preprocessor">#define WCSHDR_CROTAia 0x00000001</span></div>
<div class="line"><a name="l01068"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a5feeef18919b1cbb79729bbfa75976ec"> 1068</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_EPOCHa 0x00000002</span></div>
<div class="line"><a name="l01069"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#afc0a5a6b475a8e50b77d4be099790985"> 1069</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_VELREFa 0x00000004</span></div>
<div class="line"><a name="l01070"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a63eb554461f3df5dc64a25f71891b9f1"> 1070</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_CD00i00j 0x00000008</span></div>
<div class="line"><a name="l01071"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a3dea9d7548bdbc9a7cc8d0a04cdd46fb"> 1071</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PC00i00j 0x00000010</span></div>
<div class="line"><a name="l01072"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#aee4fe41274945f9e34009d2eb309c922"> 1072</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PROJPn 0x00000020</span></div>
<div class="line"><a name="l01073"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a1d506ef2ad493a963426e0732a6328ca"> 1073</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_RADECSYS 0x00000040</span></div>
<div class="line"><a name="l01074"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a1b66d50d7f1927222a170bc88f9db51e"> 1074</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_VSOURCE 0x00000080</span></div>
<div class="line"><a name="l01075"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#adff9a101a373a634f3a1baab29e92534"> 1075</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_DOBSn 0x00000100</span></div>
<div class="line"><a name="l01076"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae8a768f544fe3ae81436b73dca3099fb"> 1076</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_LONGKEY 0x00000200</span></div>
<div class="line"><a name="l01077"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#adf57a609a5c3f7288452cce86210260e"> 1077</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_CNAMn 0x00000400</span></div>
<div class="line"><a name="l01078"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a0e8eb873389e9c15bd6079a96c41ad60"> 1078</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_AUXIMG 0x00000800</span></div>
<div class="line"><a name="l01079"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a33d67fd81c52448aead9e09f32ba9cca"> 1079</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_ALLIMG 0x00001000</span></div>
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01081"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ab65e929c7d525d735ae240046d4f0d9c"> 1081</a></span> <span class="preprocessor">#define WCSHDR_IMGHEAD 0x00010000</span></div>
<div class="line"><a name="l01082"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#aa7c5021293b0db20ece0e82c3702a159"> 1082</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_BIMGARR 0x00020000</span></div>
<div class="line"><a name="l01083"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a7bf13ab87b23ecdbbb4b4847d4944070"> 1083</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PIXLIST 0x00040000</span></div>
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01085"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a54634ed49425e8842874e9e2b77899df"> 1085</a></span> <span class="preprocessor">#define WCSHDO_none 0x00</span></div>
<div class="line"><a name="l01086"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a5592649ee4c25e118559c6d283c51930"> 1086</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_all 0xFF</span></div>
<div class="line"><a name="l01087"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a446914676e0b3f55ac6a080015a52b43"> 1087</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_safe 0x0F</span></div>
<div class="line"><a name="l01088"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a6779d48001260a0011b3dcffdcb64cb6"> 1088</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_DOBSn 0x01</span></div>
<div class="line"><a name="l01089"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a96b787f84207faa42599e50e6e078d21"> 1089</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_TPCn_ka 0x02</span></div>
<div class="line"><a name="l01090"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a222a5bd7659f3e1ea1a9ed21f54c50ef"> 1090</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_PVn_ma 0x04</span></div>
<div class="line"><a name="l01091"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#aace96fb8c1499616dd1333af3e8340b0"> 1091</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_CRPXna 0x08</span></div>
<div class="line"><a name="l01092"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a95325b53ebd8d7d0a371a65b27b3d04a"> 1092</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_CNAMna 0x10</span></div>
<div class="line"><a name="l01093"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#a9a70ad2a355a9736711d8017535bf72b"> 1093</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_WCSNna 0x20</span></div>
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> </div>
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcshdr_8h.html#a06cd9297f8315235ba1cf13d1cc115e1" title="Status return messages. ">wcshdr_errmsg</a>[];</div>
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> </div>
<div class="line"><a name="l01098"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdae"> 1098</a></span> <span class="keyword">enum</span> <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdae">wcshdr_errmsg_enum</a> {</div>
<div class="line"><a name="l01099"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaeabfe69dd9e4c486f856a5dc44b02e79a1"> 1099</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaeabfe69dd9e4c486f856a5dc44b02e79a1">WCSHDRERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span></div>
<div class="line"><a name="l01100"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea99dd31e274ec97542e650ff89357cded"> 1100</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea99dd31e274ec97542e650ff89357cded">WCSHDRERR_NULL_POINTER</a> = 1, <span class="comment">/* Null wcsprm pointer passed. */</span></div>
<div class="line"><a name="l01101"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea0a858638ef0dd0dc9b529f98b14cc46f"> 1101</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea0a858638ef0dd0dc9b529f98b14cc46f">WCSHDRERR_MEMORY</a> = 2, <span class="comment">/* Memory allocation failed. */</span></div>
<div class="line"><a name="l01102"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea0c926e2cc98a8c39585aa0e212423459"> 1102</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea0c926e2cc98a8c39585aa0e212423459">WCSHDRERR_BAD_COLUMN</a> = 3, <span class="comment">/* Invalid column selection. */</span></div>
<div class="line"><a name="l01103"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea218297c7a2a4d405c251e9ed239e615b"> 1103</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaea218297c7a2a4d405c251e9ed239e615b">WCSHDRERR_PARSER</a> = 4, <span class="comment">/* Fatal error returned by Flex</span></div>
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span> <span class="comment"> parser. */</span></div>
<div class="line"><a name="l01105"></a><span class="lineno"><a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaeaeae58359638c0c631e6c7c573a343508"> 1105</a></span>  <a class="code" href="wcshdr_8h.html#ae2dfc36c150d3a16a5e83131d32ecdaeaeae58359638c0c631e6c7c573a343508">WCSHDRERR_BAD_TABULAR_PARAMS</a> = 5 <span class="comment">/* Invalid tabular parameters. */</span></div>
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> };</div>
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span> </div>
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#ac75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers. ">wcspih</a>(<span class="keywordtype">char</span> *header, <span class="keywordtype">int</span> nkeyrec, <span class="keywordtype">int</span> relax, <span class="keywordtype">int</span> ctrl, <span class="keywordtype">int</span> *nreject,</div>
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>  <span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> **wcs);</div>
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span> </div>
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#adc053d80a9c4da454a52eed34e123633" title="FITS WCS parser routine for binary table and image headers. ">wcsbth</a>(<span class="keywordtype">char</span> *header, <span class="keywordtype">int</span> nkeyrec, <span class="keywordtype">int</span> relax, <span class="keywordtype">int</span> ctrl, <span class="keywordtype">int</span> keysel,</div>
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span>  <span class="keywordtype">int</span> *colsel, <span class="keywordtype">int</span> *nreject, <span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> **wcs);</div>
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> </div>
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#a6dd857f7b61a5b349cc8af5a4b6d8a1c" title="Tabular construction routine. ">wcstab</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> *wcs);</div>
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> </div>
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#a6174a483baad91dae3fa1c30b0e4cde5" title="Index alternate coordinate representations. ">wcsidx</a>(<span class="keywordtype">int</span> nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> **wcs, <span class="keywordtype">int</span> alts[27]);</div>
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> </div>
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#a16e35904c64fe6b0aab144bd022c722f" title="Index alternate coordinate representions. ">wcsbdx</a>(<span class="keywordtype">int</span> nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> **wcs, <span class="keywordtype">int</span> type, <span class="keywordtype">short</span> alts[1000][28]);</div>
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span> </div>
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#a27465844aaeea0623133f8151ca4fd9b" title="Free the array of wcsprm structs. ">wcsvfree</a>(<span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> **wcs);</div>
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> </div>
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#a0b8372e555a2e2bcc63a11f3dc7a1bf6" title="Write out a wcsprm struct as a FITS header. ">wcshdo</a>(<span class="keywordtype">int</span> relax, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters. ">wcsprm</a> *wcs, <span class="keywordtype">int</span> *nkeyrec, <span class="keywordtype">char</span> **header);</div>
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> </div>
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> </div>
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCSHDR */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jul 13 2013 20:00:26 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
