<!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: wcsunits.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">wcsunits.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="wcsunits_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: wcsunits.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">* The Flexible Image Transport System (FITS), a data format widely used in</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">* astronomy for data interchange and archive, is described in</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">* "Definition of The Flexible Image Transport System (FITS)",</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">* Hanisch, R.J., Farris, A., Greisen, E.W., et al. 2001, A&A, 376, 359</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">*</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">* which formalizes NOST 100-2.0, a document produced by the NASA/Science</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">* Office of Standards and Technology, see http://fits.gsfc.nasa.gov.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">*</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">* library.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">*</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">* Summary of the wcsunits routines</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* --------------------------------</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* Routines in this suite deal with units specifications and conversions:</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">* - wcsunitse(): given two unit specifications, derive the conversion from</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">* one to the other.</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">* - wcsutrne(): translates certain commonly used but non-standard unit</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">* strings. It is intended to be called before wcsulexe() which only</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">* handles standard FITS units specifications.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">*</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">* - wcsulexe(): parses a standard FITS units specification of arbitrary</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">* complexity, deriving the conversion to canonical units.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">*</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">* wcsunitse() - FITS units specification conversion</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">* -------------------------------------------------</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">* wcsunitse() derives the conversion from one system of units to another.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">*</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">* A deprecated form of this function, wcsunits(), lacks the wcserr**</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">* parameter.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">*</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">* have const char []</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">* FITS units specification to convert from (null-</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">* terminated), with or without surrounding square</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">* brackets (for inline specifications); text following</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">* the closing bracket is ignored.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">*</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">* want const char []</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">* FITS units specification to convert to (null-</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">* terminated), with or without surrounding square</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">* brackets (for inline specifications); text following</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">* the closing bracket is ignored.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">*</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">* Returned:</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">* scale,</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">* offset,</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">* power double* Convert units using</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">*</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">= pow(scale*value + offset, power);</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">*</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">* Normally offset is zero except for log() or ln()</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">* conversions, e.g. "log(MHz)" to "ln(Hz)". Likewise,</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">* power is normally unity except for exp() conversions,</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">* e.g. "exp(ms)" to "exp(/Hz)". Thus conversions</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">* ordinarily consist of</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">*</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">= value *= scale;</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">* err struct wcserr **</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">* If enabled, for function return values > 1, this</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">* struct will contain a detailed error message, see</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">* wcserr_enable(). May be NULL if an error message is</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">* not desired. Otherwise, the user is responsible for</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">* deleting the memory allocated for the wcserr struct.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">*</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">* 1-9: Status return from wcsulexe().</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">* 10: Non-conformant unit specifications.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">* 11: Non-conformant functions.</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">* scale is zeroed on return if an error occurs.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">*</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">*</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">* wcsutrne() - Translation of non-standard unit specifications</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">* wcsutrne() translates certain commonly used but non-standard unit strings,</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">* e.g. "DEG", "MHZ", "KELVIN", that are not recognized by wcsulexe(), refer to</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">* the notes below for a full list. Compounds are also recognized, e.g.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">* "JY/BEAM" and "KM/SEC/SEC". Extraneous embedded blanks are removed.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">*</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">* A deprecated form of this function, wcsutrn(), lacks the wcserr** parameter.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">*</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">* ctrl int Although "S" is commonly used to represent seconds,</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">* its translation to "s" is potentially unsafe since the</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">* standard recognizes "S" formally as Siemens, however</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">* rarely that may be used. The same applies to "H" for</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">* hours (Henry), and "D" for days (Debye). This</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">* bit-flag controls what to do in such cases:</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">* 1: Translate "S" to "s".</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">* 2: Translate "H" to "h".</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">* 4: Translate "D" to "d".</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">* Thus ctrl == 0 doesn't do any unsafe translations,</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">* whereas ctrl == 7 does all of them.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">*</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">* Given and returned:</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">* unitstr char [] Null-terminated character array containing the units</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">* specification to be translated.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">*</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">* Inline units specifications in the a FITS header</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">* keycomment are also handled. If the first non-blank</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">* character in unitstr is '[' then the unit string is</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">* delimited by its matching ']'. Blanks preceding '['</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">* will be stripped off, but text following the closing</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">* bracket will be preserved without modification.</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">*</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">* err struct wcserr **</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">* If enabled, for function return values > 1, this</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">* struct will contain a detailed error message, see</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">* wcserr_enable(). May be NULL if an error message is</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">* not desired. Otherwise, the user is responsible for</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">* deleting the memory allocated for the wcserr struct.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">*</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">* -1: No change was made, other than stripping blanks</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">* (not an error).</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">* 9: Internal parser error.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">* 12: Potentially unsafe translation, whether applied</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">* or not (see notes).</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">* Notes:</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">* Translation of non-standard unit specifications: apart from leading and</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">* trailing blanks, a case-sensitive match is required for the aliases listed</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">* below, in particular the only recognized aliases with metric prefixes are</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">* "KM", "KHZ", "MHZ", and "GHZ". Potentially unsafe translations of "D",</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">* "H", and "S", shown in parentheses, are optional.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">*</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">= Unit Recognized aliases</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">= ---- -------------------------------------------------------------</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">= Angstrom angstrom</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">= arcmin arcmins, ARCMIN, ARCMINS</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">= arcsec arcsecs, ARCSEC, ARCSECS</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">= beam BEAM</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">= byte Byte</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">= d day, days, (D), DAY, DAYS</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">= deg degree, degrees, DEG, DEGREE, DEGREES</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">= GHz GHZ</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">= h hr, (H), HR</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">= Hz hz, HZ</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">= kHz KHZ</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">= Jy JY</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">= K kelvin, kelvins, Kelvin, Kelvins, KELVIN, KELVINS</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">= km KM</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">= m metre, meter, metres, meters, M, METRE, METER, METRES, METERS</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">= min MIN</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">= MHz MHZ</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">= Ohm ohm</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">= Pa pascal, pascals, Pascal, Pascals, PASCAL, PASCALS</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">= pixel pixels, PIXEL, PIXELS</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">= rad radian, radians, RAD, RADIAN, RADIANS</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">= s sec, second, seconds, (S), SEC, SECOND, SECONDS</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">= V volt, volts, Volt, Volts, VOLT, VOLTS</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">= yr year, years, YR, YEAR, YEARS</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">*</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">* The aliases "angstrom", "ohm", and "Byte" for (Angstrom, Ohm, and byte)</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment">* are recognized by wcsulexe() itself as an unofficial extension of the</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">* standard, but they are converted to the standard form here.</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">*</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">*</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">* wcsulexe() - FITS units specification parser</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">* --------------------------------------------</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">* wcsulexe() parses a standard FITS units specification of arbitrary</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">* complexity, deriving the scale factor required to convert to canonical</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">* units - basically SI with degrees and "dimensionless" additions such as</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">* byte, pixel and count.</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">*</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">* A deprecated form of this function, wcsulex(), lacks the wcserr** parameter.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">*</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">* Given:</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">* unitstr const char []</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">* Null-terminated character array containing the units</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">* specification, with or without surrounding square</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">* brackets (for inline specifications); text following</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">* the closing bracket is ignored.</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">* Returned:</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">* func int* Special function type, see note 4:</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">* 0: None</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">* 1: log() ...base 10</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">* 2: ln() ...base e</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">* 3: exp()</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">*</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment">* scale double* Scale factor for the unit specification; multiply a</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">* value expressed in the given units by this factor to</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">* convert it to canonical units.</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">*</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">* units double[WCSUNITS_NTYPE]</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">* A units specification is decomposed into powers of 16</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">* fundamental unit types: angle, mass, length, time,</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">* count, pixel, etc. Preprocessor macro WCSUNITS_NTYPE</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment">* is defined to dimension this vector, and others such</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment">* WCSUNITS_PLANE_ANGLE, WCSUNITS_LENGTH, etc. to access</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">* its elements.</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">*</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">* Corresponding character strings, wcsunits_types[] and</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">* wcsunits_units[], are predefined to describe each</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">* quantity and its canonical units.</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">* err struct wcserr **</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">* If enabled, for function return values > 1, this</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">* struct will contain a detailed error message, see</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment">* wcserr_enable(). May be NULL if an error message is</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment">* not desired. Otherwise, the user is responsible for</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">* deleting the memory allocated for the wcserr struct.</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">*</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment">* Function return value:</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment">* int Status return value:</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment">* 0: Success.</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">* 1: Invalid numeric multiplier.</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">* 2: Dangling binary operator.</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">* 3: Invalid symbol in INITIAL context.</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment">* 4: Function in invalid context.</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">* 5: Invalid symbol in EXPON context.</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">* 6: Unbalanced bracket.</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">* 7: Unbalanced parenthesis.</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment">* 8: Consecutive binary operators.</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">* 9: Internal parser error.</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">*</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment">* scale and units[] are zeroed on return if an error</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">* occurs.</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">* Notes:</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment">* 1: wcsulexe() is permissive in accepting whitespace in all contexts in a</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment">* units specification where it does not create ambiguity (e.g. not</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">* between a metric prefix and a basic unit string), including in strings</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">* like "log (m ** 2)" which is formally disallowed.</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">*</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">* 2: Supported extensions:</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">* - "angstrom" (OGIP usage) is allowed in addition to "Angstrom".</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">* - "ohm" (OGIP usage) is allowed in addition to "Ohm".</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment">* - "Byte" (common usage) is allowed in addition to "byte".</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">*</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment">* 3: Table 6 of WCS Paper I lists eleven units for which metric prefixes are</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">* allowed. However, in this implementation only prefixes greater than</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">* unity are allowed for "a" (annum), "yr" (year), "pc" (parsec), "bit",</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">* and "byte", and only prefixes less than unity are allowed for "mag"</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment">* (stellar magnitude).</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment">*</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment">* Metric prefix "P" (peta) is specifically forbidden for "a" (annum) to</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">* avoid confusion with "Pa" (Pascal, not peta-annum). Note that metric</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment">* prefixes are specifically disallowed for "h" (hour) and "d" (day) so</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment">* that "ph" (photons) cannot be interpreted as pico-hours, nor "cd"</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment">* (candela) as centi-days.</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">*</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment">* 4: Function types log(), ln() and exp() may only occur at the start of the</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment">* units specification. The scale and units[] returned for these refers</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment">* to the string inside the function "argument", e.g. to "MHz" in log(MHz)</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment">* for which a scale of 1e6 will be returned.</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">*</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment">* Global variable: const char *wcsunits_errmsg[] - Status return messages</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment">* -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment">* Error messages to match the status value returned from each function.</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment">*</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">*</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment">* Global variable: const char *wcsunits_types[] - Names of physical quantities</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment">* ----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment">* Names for physical quantities to match the units vector returned by</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment">* wcsulexe():</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment">* - 0: plane angle</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment">* - 1: solid angle</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment">* - 2: charge</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">* - 3: mole</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment">* - 4: temperature</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment">* - 5: luminous intensity</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment">* - 6: mass</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">* - 7: length</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">* - 8: time</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">* - 9: beam</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment">* - 10: bin</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment">* - 11: bit</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment">* - 12: count</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment">* - 13: stellar magnitude</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">* - 14: pixel</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment">* - 15: solar ratio</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment">* - 16: voxel</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment">*</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment">*</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment">* Global variable: const char *wcsunits_units[] - Names of units</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">* --------------------------------------------------------------</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment">* Names for the units (SI) to match the units vector returned by wcsulexe():</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment">* - 0: degree</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">* - 1: steradian</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">* - 2: Coulomb</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">* - 3: mole</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">* - 4: Kelvin</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">* - 5: candela</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">* - 6: kilogram</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">* - 7: metre</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">* - 8: second</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment">*</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment">* The remainder are dimensionless.</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> </div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor">#ifndef WCSLIB_WCSUNITS</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSUNITS</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor">#include "<a class="code" href="wcserr_8h.html">wcserr.h</a>"</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> </div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcsunits_8h.html#a8217718f8c515151dc33ceba922b39ba" title="Status return messages. ">wcsunits_errmsg</a>[];</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> </div>
<div class="line"><a name="l00349"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3ef"> 349</a></span> <span class="keyword">enum</span> <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3ef">wcsunits_errmsg_enum</a> {</div>
<div class="line"><a name="l00350"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efac00b91a489f7273d2733f58201b6a723"> 350</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efac00b91a489f7273d2733f58201b6a723">UNITSERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa4ad61420ee56456d08647b222c4aa8af"> 351</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa4ad61420ee56456d08647b222c4aa8af">UNITSERR_BAD_NUM_MULTIPLIER</a> = 1, <span class="comment">/* Invalid numeric multiplier. */</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa5ceed55803deb4a34266f23cf6d47274"> 352</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa5ceed55803deb4a34266f23cf6d47274">UNITSERR_DANGLING_BINOP</a> = 2, <span class="comment">/* Dangling binary operator. */</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efaf7a5cd4ed90aeef7598875cb5bf57a11"> 353</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efaf7a5cd4ed90aeef7598875cb5bf57a11">UNITSERR_BAD_INITIAL_SYMBOL</a> = 3, <span class="comment">/* Invalid symbol in INITIAL</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> context. */</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa67b504a215f2d34d1be4956b1e9e55b7"> 355</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa67b504a215f2d34d1be4956b1e9e55b7">UNITSERR_FUNCTION_CONTEXT</a> = 4, <span class="comment">/* Function in invalid context. */</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa0c9333946c5918c15c376f12e9afb086"> 356</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa0c9333946c5918c15c376f12e9afb086">UNITSERR_BAD_EXPON_SYMBOL</a> = 5, <span class="comment">/* Invalid symbol in EXPON context. */</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa367f21cd3b49b178d4fdadaf74f2618d"> 357</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa367f21cd3b49b178d4fdadaf74f2618d">UNITSERR_UNBAL_BRACKET</a> = 6, <span class="comment">/* Unbalanced bracket. */</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa49231fa8fbeeca036424cd7df0d5a3a8"> 358</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa49231fa8fbeeca036424cd7df0d5a3a8">UNITSERR_UNBAL_PAREN</a> = 7, <span class="comment">/* Unbalanced parenthesis. */</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa5b8db327b9d6bf09e93e7e0fed910792"> 359</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa5b8db327b9d6bf09e93e7e0fed910792">UNITSERR_CONSEC_BINOPS</a> = 8, <span class="comment">/* Consecutive binary operators. */</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa116bc901282cf346621b9e56e4676b24"> 360</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa116bc901282cf346621b9e56e4676b24">UNITSERR_PARSER_ERROR</a> = 9, <span class="comment">/* Internal parser error. */</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efae9b1b29365d17b25452562f770d44975"> 361</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efae9b1b29365d17b25452562f770d44975">UNITSERR_BAD_UNIT_SPEC</a> = 10, <span class="comment">/* Non-conformant unit</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> specifications. */</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa599ff63ed46928ffb2f5edc07de3ddcc"> 363</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efa599ff63ed46928ffb2f5edc07de3ddcc">UNITSERR_BAD_FUNCS</a> = 11, <span class="comment">/* Non-conformant functions. */</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efaf6fc9ca59d14a8889809c050c01154ff"> 364</a></span>  <a class="code" href="wcsunits_8h.html#a864e6b966575a8c42eb333ba9f14a3efaf6fc9ca59d14a8889809c050c01154ff">UNITSERR_UNSAFE_TRANS</a> = 12 <span class="comment">/* Potentially unsafe translation. */</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> };</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> </div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcsunits_8h.html#aec5892437858120d456503fe38f4031b" title="Names of physical quantities. ">wcsunits_types</a>[];</div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcsunits_8h.html#acd49d777bc04d68cdfdd29f5b6a7252b" title="Names of units. ">wcsunits_units</a>[];</div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> </div>
<div class="line"><a name="l00370"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a6ef9e3ba449b38275c422e454abe3601"> 370</a></span> <span class="preprocessor">#define WCSUNITS_PLANE_ANGLE 0</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a69241e398126a72e5d095ed3aff156c3"> 371</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_SOLID_ANGLE 1</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a45b2d15aa5504b7e7e8b7b345d090f32"> 372</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_CHARGE 2</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a807ef7c93e34207776303badf177fa41"> 373</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_MOLE 3</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a8bb521a40223ec7358f85d719834ad7f"> 374</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_TEMPERATURE 4</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a0967644d30d7f98f21b6bb0e68a637c0"> 375</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_LUMINTEN 5</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a8f84e63b1fa2003f3438e7cd21231b92"> 376</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_MASS 6</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a59e3354bb9908a4841aa478f2dbd3973"> 377</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_LENGTH 7</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a347b88663166b66404cbb2f8aac211bb"> 378</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_TIME 8</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a11a1284e63c7515fd0240ca8f85fc111"> 379</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_BEAM 9</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a84fdca1d2c8647a2f33a760578de62c6"> 380</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_BIN 10</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a7332ce1c3c715011599d4b9d13e7b760"> 381</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_BIT 11</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a27df51b1593f3642bfd9833e71c73a34"> 382</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_COUNT 12</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#ace657c3f971b4ac9004a2639d142f636"> 383</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_MAGNITUDE 13</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a2cf5fc976d2663fed07f1f837245f36b"> 384</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_PIXEL 14</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#ab622892a80194a6a432510665156e4fb"> 385</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_SOLRATIO 15</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a946bca82ae3fb279ad3d86dbc793be07"> 386</a></span> <span class="preprocessor"></span><span class="preprocessor">#define WCSUNITS_VOXEL 16</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00388"></a><span class="lineno"><a class="code" href="wcsunits_8h.html#a7daf2b3a5c7e96f2823bca916554cc4b"> 388</a></span> <span class="preprocessor">#define WCSUNITS_NTYPE 17</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> </div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#a47aa4e0a54f11d7ed5146c00906a3984" title="FITS units specification conversion. ">wcsunitse</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> have[], <span class="keyword">const</span> <span class="keywordtype">char</span> want[], <span class="keywordtype">double</span> *scale,</div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keywordtype">double</span> *offset, <span class="keywordtype">double</span> *power, <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> **err);</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> </div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#a25ba0f0129e88c6e7c74d4562cf796cd" title="Translation of non-standard unit specifications. ">wcsutrne</a>(<span class="keywordtype">int</span> ctrl, <span class="keywordtype">char</span> unitstr[], <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> **err);</div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> </div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#a6c5f3165e687f60176b7f21fdb42fa1c" title="FITS units specification parser. ">wcsulexe</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> unitstr[], <span class="keywordtype">int</span> *func, <span class="keywordtype">double</span> *scale,</div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keywordtype">double</span> units[<a class="code" href="wcsunits_8h.html#a7daf2b3a5c7e96f2823bca916554cc4b" title="Number of entries in the units array. ">WCSUNITS_NTYPE</a>], <span class="keyword">struct</span> <a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> **err);</div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> </div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment">/* Deprecated. */</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#aef5d64e333f758458b1edaa617911513">wcsunits</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> have[], <span class="keyword">const</span> <span class="keywordtype">char</span> want[], <span class="keywordtype">double</span> *scale,</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keywordtype">double</span> *offset, <span class="keywordtype">double</span> *power);</div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#a560462cb2a7fa7eae6b4f325c85e7911">wcsutrn</a>(<span class="keywordtype">int</span> ctrl, <span class="keywordtype">char</span> unitstr[]);</div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="keywordtype">int</span> <a class="code" href="wcsunits_8h.html#aae4248dc69b440673a8221059e5bd0d4">wcsulex</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> unitstr[], <span class="keywordtype">int</span> *func, <span class="keywordtype">double</span> *scale,</div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keywordtype">double</span> units[<a class="code" href="wcsunits_8h.html#a7daf2b3a5c7e96f2823bca916554cc4b" title="Number of entries in the units array. ">WCSUNITS_NTYPE</a>]);</div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> </div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCSUNITS */</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>
