<!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: tab.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">tab.h</div> </div> </div><!--header--> <div class="contents"> <a href="tab_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: tab.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 tabular coordinate systems as</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">* defined by the FITS World Coordinate System (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 spectral coordinates in FITS",</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">* Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L.</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">* 2006, A&A, 446, 747 (Paper III)</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">*</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">* library.</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">*</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">* Summary of the tab routines</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">* These routines implement the part of the FITS WCS standard that deals with</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">* tabular coordinates, i.e. coordinates that are defined via a lookup table.</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">* They define methods to be used for computing tabular world coordinates from</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">* intermediate world coordinates (a linear transformation of image pixel</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">* coordinates), and vice versa. They are based on the tabprm struct which</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">* contains all information needed for the computations. The struct contains</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">* some members that must be set by the user, and others that are maintained</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">* by these routines, somewhat like a C++ class but with no encapsulation.</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">*</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">* tabini(), tabmem(), tabcpy(), and tabfree() are provided to manage the</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">* tabprm struct, and another, tabprt(), to print its contents.</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">* A setup routine, tabset(), computes intermediate values in the tabprm struct</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">* from parameters in it that were supplied by the user. The struct always</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">* needs to be set up by tabset() but it need not be called explicitly - refer</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">* to the explanation of tabprm::flag.</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">* tabx2s() and tabs2x() implement the WCS tabular coordinate transformations.</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">*</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">* Accuracy:</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">* ---------</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">* No warranty is given for the accuracy of these routines (refer to the</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">* copyright notice); intending users must satisfy for themselves their</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">* adequacy for the intended purpose. However, closure effectively to within</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">* double precision rounding error was demonstrated by test routine ttab.c</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">* which accompanies this software.</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">*</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">*</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">* tabini() - Default constructor for the tabprm struct</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">* ----------------------------------------------------</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">* tabini() allocates memory for arrays in a tabprm struct and sets all members</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">* of the struct to default values.</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">* PLEASE NOTE: every tabprm struct should be initialized by tabini(), possibly</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">* repeatedly. On the first invokation, and only the first invokation, the</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">* flag member of the tabprm struct must be set to -1 to initialize memory</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">* management, regardless of whether tabini() will actually be used to allocate</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">* memory.</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">* Given:</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">* alloc int If true, allocate memory unconditionally for arrays in</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">* the tabprm struct.</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">* If false, it is assumed that pointers to these arrays</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">* have been set by the user except if they are null</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">* pointers in which case memory will be allocated for</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">* them regardless. (In other words, setting alloc true</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">* saves having to initalize these pointers to zero.)</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">* M int The number of tabular coordinate axes.</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">* K const int[]</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">* Vector of length M whose elements (K_1, K_2,... K_M)</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">* record the lengths of the axes of the coordinate array</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">* and of each indexing vector. M and K[] are used to</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">* determine the length of the various tabprm arrays and</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">* therefore the amount of memory to allocate for them.</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">* Their values are copied into the tabprm struct.</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">* It is permissible to set K (i.e. the address of the</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">* array) to zero which has the same effect as setting</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">* each element of K[] to zero. In this case no memory</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">* will be allocated for the index vectors or coordinate</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">* array in the tabprm struct. These together with the</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">* K vector must be set separately before calling</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">* tabset().</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 and returned:</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">* Tabular transformation parameters. Note that, in</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">* order to initialize memory management tabprm::flag</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">* should be set to -1 when tab is initialized for the</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">* first time (memory leaks may result if it had already</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">* been initialized).</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">*</span></div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">* 2: Memory allocation failed.</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">* 3: Invalid tabular parameters.</span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">*</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">* tabprm::err if enabled, see wcserr_enable().</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">*</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">* tabmem() - Acquire tabular memory</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">* ---------------------------------</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">* tabmem() takes control of memory allocated by the user for arrays in the</span></div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">* tabprm struct.</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">* Given and returned:</span></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">* Tabular transformation parameters.</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">* Function return value:</span></div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">* 2: Memory allocation failed.</span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">*</span></div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span></div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">*</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">*</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">* tabcpy() - Copy routine for the tabprm struct</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">* ---------------------------------------------</span></div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">* tabcpy() does a deep copy of one tabprm struct to another, using tabini() to</span></div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">* allocate memory for its arrays if required. Only the "information to be</span></div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">* provided" part of the struct is copied; a call to tabset() is required to</span></div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">* set up the remainder.</span></div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">*</span></div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">* Given:</span></div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">* alloc int If true, allocate memory unconditionally for arrays in</span></div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">* the tabprm struct.</span></div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">*</span></div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">* If false, it is assumed that pointers to these arrays</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">* have been set by the user except if they are null</span></div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">* pointers in which case memory will be allocated for</span></div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">* them regardless. (In other words, setting alloc true</span></div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">* saves having to initalize these pointers to zero.)</span></div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">*</span></div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">* tabsrc const struct tabprm*</span></div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">* Struct to copy from.</span></div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">*</span></div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">* Given and returned:</span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">* tabdst struct tabprm*</span></div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">* Struct to copy to. tabprm::flag should be set to -1</span></div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">* if tabdst was not previously initialized (memory leaks</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">* may result if it was previously initialized).</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">*</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">* 2: Memory allocation failed.</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">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">* tabprm::err (associated with tabdst) if enabled, see</span></div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">* wcserr_enable().</span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">*</span></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">*</span></div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">* tabfree() - Destructor for the tabprm struct</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">* --------------------------------------------</span></div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">* tabfree() frees memory allocated for the tabprm arrays by tabini().</span></div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">* tabini() records the memory it allocates and tabfree() will only attempt to</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">* free this.</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">*</span></div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">* PLEASE NOTE: tabfree() must not be invoked on a tabprm struct that was not</span></div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">* initialized by tabini().</span></div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">*</span></div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">* Returned:</span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">* Coordinate transformation parameters.</span></div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment">*</span></div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">* 1: Null tabprm pointer passed.</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">*</span></div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">* tabprt() - Print routine for the tabprm struct</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">* ----------------------------------------------</span></div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">* tabprt() prints the contents of a tabprm struct using wcsprintf(). Mainly</span></div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">* intended for diagnostic purposes.</span></div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">*</span></div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">* Given:</span></div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">* tab const struct tabprm*</span></div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">* Tabular transformation parameters.</span></div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">*</span></div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">*</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">*</span></div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">* tabset() - Setup routine for the tabprm struct</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">* tabset() allocates memory for work arrays in the tabprm struct and sets up</span></div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">* the struct according to information supplied within it.</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">* Note that this routine need not be called directly; it will be invoked by</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">* tabx2s() and tabs2x() if tabprm::flag is anything other than a predefined</span></div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">* magic value.</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">* Given and returned:</span></div> <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">* Tabular transformation parameters.</span></div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">*</span></div> <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">* 3: Invalid tabular parameters.</span></div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">*</span></div> <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span></div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">*</span></div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">*</span></div> <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">* tabx2s() - Pixel-to-world transformation</span></div> <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment">* ----------------------------------------</span></div> <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment">* tabx2s() transforms intermediate world coordinates to world coordinates</span></div> <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">* using coordinate lookup.</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">* Given and returned:</span></div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment">* Tabular transformation parameters.</span></div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">*</span></div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">* Given:</span></div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">* ncoord,</span></div> <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment">* nelem int The number of coordinates, each of vector length</span></div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">* nelem.</span></div> <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">*</span></div> <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">* x const double[ncoord][nelem]</span></div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment">* Array of intermediate world coordinates, SI units.</span></div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">*</span></div> <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">* Returned:</span></div> <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment">* world double[ncoord][nelem]</span></div> <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">* Array of world coordinates, in SI units.</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">* stat int[ncoord]</span></div> <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment">* Status return value status for each coordinate:</span></div> <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">* 1: Invalid intermediate world coordinate.</span></div> <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">*</span></div> <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment">* 3: Invalid tabular parameters.</span></div> <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">* 4: One or more of the x coordinates were invalid,</span></div> <div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment">* as indicated by the stat vector.</span></div> <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">*</span></div> <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span></div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment">*</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">* tabs2x() - World-to-pixel transformation</span></div> <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">* ----------------------------------------</span></div> <div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment">* tabs2x() transforms world coordinates to intermediate world coordinates.</span></div> <div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment">*</span></div> <div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment">* Given and returned:</span></div> <div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">* tab struct tabprm*</span></div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment">* Tabular transformation parameters.</span></div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment">*</span></div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment">* Given:</span></div> <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment">* ncoord,</span></div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment">* nelem int The number of coordinates, each of vector length</span></div> <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment">* nelem.</span></div> <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment">* world const double[ncoord][nelem]</span></div> <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment">* Array of world coordinates, in SI units.</span></div> <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment">*</span></div> <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment">* Returned:</span></div> <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">* x double[ncoord][nelem]</span></div> <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment">* Array of intermediate world coordinates, SI units.</span></div> <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment">* stat int[ncoord]</span></div> <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment">* Status return value status for each vector element:</span></div> <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment">* 1: Invalid world coordinate.</span></div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment">*</span></div> <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment">* Function return value:</span></div> <div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">* int Status return value:</span></div> <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment">* 0: Success.</span></div> <div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment">* 1: Null tabprm pointer passed.</span></div> <div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment">* 3: Invalid tabular parameters.</span></div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">* 5: One or more of the world coordinates were</span></div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">* invalid, as indicated by the stat vector.</span></div> <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">*</span></div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment">* For returns > 1, a detailed error message is set in</span></div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span></div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment">*</span></div> <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment">*</span></div> <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">* tabprm struct - Tabular transformation parameters</span></div> <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment">* -------------------------------------------------</span></div> <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment">* The tabprm struct contains information required to transform tabular</span></div> <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment">* coordinates. It consists of certain members that must be set by the user</span></div> <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment">* ("given") and others that are set by the WCSLIB routines ("returned"). Some</span></div> <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment">* of the latter are supplied for informational purposes while others are for</span></div> <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">* internal use only.</span></div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment">*</span></div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment">* int flag</span></div> <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">* (Given and returned) This flag must be set to zero whenever any of the</span></div> <div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">* following tabprm structure members are set or changed:</span></div> <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">*</span></div> <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">* - tabprm::M (q.v., not normally set by the user),</span></div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">* - tabprm::K (q.v., not normally set by the user),</span></div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">* - tabprm::map,</span></div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">* - tabprm::crval,</span></div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">* - tabprm::index,</span></div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment">* - tabprm::coord.</span></div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment">*</span></div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment">* This signals the initialization routine, tabset(), to recompute the</span></div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment">* returned members of the tabprm struct. tabset() will reset flag to</span></div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment">* indicate that this has been done.</span></div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment">*</span></div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment">* PLEASE NOTE: flag should be set to -1 when tabini() is called for the</span></div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment">* first time for a particular tabprm struct in order to initialize memory</span></div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment">* management. It must ONLY be used on the first initialization otherwise</span></div> <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment">* memory leaks may result.</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">* int M</span></div> <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment">* (Given or returned) Number of tabular coordinate axes.</span></div> <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">*</span></div> <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment">* If tabini() is used to initialize the linprm struct (as would normally</span></div> <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment">* be the case) then it will set M from the value passed to it as a</span></div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment">* function argument. The user should not subsequently modify it.</span></div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment">*</span></div> <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment">* int *K</span></div> <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment">* (Given or returned) Pointer to the first element of a vector of length</span></div> <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment">* tabprm::M whose elements (K_1, K_2,... K_M) record the lengths of the</span></div> <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment">* axes of the coordinate array and of each indexing vector.</span></div> <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment">*</span></div> <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment">* If tabini() is used to initialize the linprm struct (as would normally</span></div> <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment">* be the case) then it will set K from the array passed to it as a</span></div> <div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment">* function argument. The user should not subsequently modify it.</span></div> <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment">*</span></div> <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment">* int *map</span></div> <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M</span></div> <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">* that defines the association between axis m in the M-dimensional</span></div> <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment">* coordinate array (1 <= m <= M) and the indices of the intermediate world</span></div> <div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment">* coordinate and world coordinate arrays, x[] and world[], in the argument</span></div> <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment">* lists for tabx2s() and tabs2x().</span></div> <div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment">*</span></div> <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment">* When x[] and world[] contain the full complement of coordinate elements</span></div> <div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment">* in image-order, as will usually be the case, then map[m-1] == i-1 for</span></div> <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment">* axis i in the N-dimensional image (1 <= i <= N). In terms of the FITS</span></div> <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment">* keywords</span></div> <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">*</span></div> <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment">* map[PVi_3a - 1] == i - 1.</span></div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment">*</span></div> <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment">* However, a different association may result if x[], for example, only</span></div> <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment">* contains a (relevant) subset of intermediate world coordinate elements.</span></div> <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">* For example, if M == 1 for an image with N > 1, it is possible to fill</span></div> <div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment">* x[] with the relevant coordinate element with nelem set to 1. In this</span></div> <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment">* case map[0] = 0 regardless of the value of i.</span></div> <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment">*</span></div> <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment">* double *crval</span></div> <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M</span></div> <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment">* whose elements contain the index value for the reference pixel for each</span></div> <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment">* of the tabular coordinate axes.</span></div> <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment">*</span></div> <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment">* double **index</span></div> <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M of</span></div> <div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment">* pointers to vectors of lengths (K_1, K_2,... K_M) of 0-relative indexes</span></div> <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment">* (see tabprm::K).</span></div> <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment">*</span></div> <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment">* The address of any or all of these index vectors may be set to zero,</span></div> <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment">* i.e.</span></div> <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment">*</span></div> <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment">= index[m] == 0;</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">* this is interpreted as default indexing, i.e.</span></div> <div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment">*</span></div> <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment">= index[m][k] = k;</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">* double *coord</span></div> <div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment">* (Given) Pointer to the first element of the tabular coordinate array,</span></div> <div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment">* treated as though it were defined as</span></div> <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment">*</span></div> <div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment">= double coord[K_M]...[K_2][K_1][M];</span></div> <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment">*</span></div> <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment">* (see tabprm::K) i.e. with the M dimension varying fastest so that the</span></div> <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment">* M elements of a coordinate vector are stored contiguously in memory.</span></div> <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment">*</span></div> <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment">* int nc</span></div> <div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment">* (Returned) Total number of coordinate vectors in the coordinate array</span></div> <div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment">* being the product K_1 * K_2 * ... * K_M (see tabprm::K).</span></div> <div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment">*</span></div> <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment">* int padding</span></div> <div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment">* (An unused variable inserted for alignment purposes only.)</span></div> <div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment">*</span></div> <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment">* int *sense</span></div> <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span></div> <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment">* whose elements indicate whether the corresponding indexing vector is</span></div> <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment">* monotonic increasing (+1), or decreasing (-1).</span></div> <div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment">*</span></div> <div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">* int *p0</span></div> <div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span></div> <div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment">* of interpolated indices into the coordinate array such that Upsilon_m,</span></div> <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment">* as defined in Paper III, is equal to (p0[m] + 1) + tabprm::delta[m].</span></div> <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">*</span></div> <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">* double *delta</span></div> <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span></div> <div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment">* of interpolated indices into the coordinate array such that Upsilon_m,</span></div> <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment">* as defined in Paper III, is equal to (tabprm::p0[m] + 1) + delta[m].</span></div> <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment">*</span></div> <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment">* double *extrema</span></div> <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment">* (Returned) Pointer to the first element of an array that records the</span></div> <div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">* minimum and maximum value of each element of the coordinate vector in</span></div> <div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment">* each row of the coordinate array, treated as though it were defined as</span></div> <div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment">*</span></div> <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment">= double extrema[K_M]...[K_2][2][M]</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">* (see tabprm::K). The minimum is recorded in the first element of the</span></div> <div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment">* compressed K_1 dimension, then the maximum. This array is used by the</span></div> <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">* inverse table lookup function, tabs2x(), to speed up table searches.</span></div> <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment">*</span></div> <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment">* struct wcserr *err</span></div> <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment">* (Returned) If enabled, when an error status is returned this struct</span></div> <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment">* contains detailed information about the error, see wcserr_enable().</span></div> <div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment">*</span></div> <div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment">* int m_flag</span></div> <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment">* int m_M</span></div> <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment">* int m_N</span></div> <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment">* int set_M</span></div> <div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment">* int m_K</span></div> <div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment">* int m_map</span></div> <div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment">* int m_crval</span></div> <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment">* int m_index</span></div> <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment">* int m_indxs</span></div> <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment">* int m_coord</span></div> <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment">* (For internal use only.)</span></div> <div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment">*</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">* Global variable: const char *tab_errmsg[] - Status return messages</span></div> <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment">* ------------------------------------------------------------------</span></div> <div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment">* Error messages to match the status value returned from each function.</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">*===========================================================================*/</span></div> <div class="line"><a name="l00472"></a><span class="lineno"> 472</span> </div> <div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="preprocessor">#ifndef WCSLIB_TAB</span></div> <div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_TAB</span></div> <div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="preprocessor">#include "<a class="code" href="wcserr_8h.html">wcserr.h</a>"</span></div> <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> </div> <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> </div> <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="tab_8h.html#a824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages. ">tab_errmsg</a>[];</div> <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> </div> <div class="line"><a name="l00485"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2ed"> 485</a></span> <span class="keyword">enum</span> <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2ed">tab_errmsg_enum</a> {</div> <div class="line"><a name="l00486"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda42a664a8df3b0a485f49eb0e7c8108cd"> 486</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda42a664a8df3b0a485f49eb0e7c8108cd">TABERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span></div> <div class="line"><a name="l00487"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2edaa0705873598b9fa5bf3b9afbc598a6bc"> 487</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2edaa0705873598b9fa5bf3b9afbc598a6bc">TABERR_NULL_POINTER</a> = 1, <span class="comment">/* Null tabprm pointer passed. */</span></div> <div class="line"><a name="l00488"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda1e503c059ddfe8f4aca37d335f7271f8"> 488</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda1e503c059ddfe8f4aca37d335f7271f8">TABERR_MEMORY</a> = 2, <span class="comment">/* Memory allocation failed. */</span></div> <div class="line"><a name="l00489"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda09c02b9ffff721d3f2dd64c318d7c38b"> 489</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda09c02b9ffff721d3f2dd64c318d7c38b">TABERR_BAD_PARAMS</a> = 3, <span class="comment">/* Invalid tabular parameters. */</span></div> <div class="line"><a name="l00490"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2edac6f6b4c9eca2bd36b0bf2f89309f9297"> 490</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2edac6f6b4c9eca2bd36b0bf2f89309f9297">TABERR_BAD_X</a> = 4, <span class="comment">/* One or more of the x coordinates were</span></div> <div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> invalid. */</span></div> <div class="line"><a name="l00492"></a><span class="lineno"><a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda9d77712eeed3ab7d2bf25e5251c9451b"> 492</a></span>  <a class="code" href="tab_8h.html#abd68f3b717dcf0fcd0078b9a4204f2eda9d77712eeed3ab7d2bf25e5251c9451b">TABERR_BAD_WORLD</a> = 5 <span class="comment">/* One or more of the world coordinates were</span></div> <div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> invalid. */</span></div> <div class="line"><a name="l00494"></a><span class="lineno"> 494</span> };</div> <div class="line"><a name="l00495"></a><span class="lineno"> 495</span> </div> <div class="line"><a name="l00496"></a><span class="lineno"><a class="code" href="structtabprm.html"> 496</a></span> <span class="keyword">struct </span><a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> {</div> <div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  <span class="comment">/* Initialization flag (see the prologue above). */</span></div> <div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="comment">/*------------------------------------------------------------------------*/</span></div> <div class="line"><a name="l00499"></a><span class="lineno"><a class="code" href="structtabprm.html#a27a7b0b12492e1b5f19242ec0eff8e08"> 499</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a27a7b0b12492e1b5f19242ec0eff8e08">flag</a>; <span class="comment">/* Set to zero to force initialization. */</span></div> <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> </div> <div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="comment">/* Parameters to be provided (see the prologue above). */</span></div> <div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  <span class="comment">/*------------------------------------------------------------------------*/</span></div> <div class="line"><a name="l00503"></a><span class="lineno"><a class="code" href="structtabprm.html#a64b8a2eaba4116cc647a435108269be3"> 503</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a64b8a2eaba4116cc647a435108269be3">M</a>; <span class="comment">/* Number of tabular coordinate axes. */</span></div> <div class="line"><a name="l00504"></a><span class="lineno"><a class="code" href="structtabprm.html#af00d4a4e089737a799fb91e1a68040dc"> 504</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#af00d4a4e089737a799fb91e1a68040dc">K</a>; <span class="comment">/* Vector of length M whose elements */</span></div> <div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  <span class="comment">/* (K_1, K_2,... K_M) record the lengths of */</span></div> <div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  <span class="comment">/* the axes of the coordinate array and of */</span></div> <div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  <span class="comment">/* each indexing vector. */</span></div> <div class="line"><a name="l00508"></a><span class="lineno"><a class="code" href="structtabprm.html#a29505cdf78fb12ca5951295fc16f4819"> 508</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#a29505cdf78fb12ca5951295fc16f4819">map</a>; <span class="comment">/* Vector of length M usually such that */</span></div> <div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="comment">/* map[m-1] == i-1 for coordinate array */</span></div> <div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  <span class="comment">/* axis m and image axis i (see above). */</span></div> <div class="line"><a name="l00511"></a><span class="lineno"><a class="code" href="structtabprm.html#a1ef3d0af652bb59fb838a6b01bb133e2"> 511</a></span>  <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#a1ef3d0af652bb59fb838a6b01bb133e2">crval</a>; <span class="comment">/* Vector of length M containing the index */</span></div> <div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  <span class="comment">/* value for the reference pixel for each */</span></div> <div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  <span class="comment">/* of the tabular coordinate axes. */</span></div> <div class="line"><a name="l00514"></a><span class="lineno"><a class="code" href="structtabprm.html#afa6969fd752bb4e3823e8facf86bbd60"> 514</a></span>  <span class="keywordtype">double</span> **<a class="code" href="structtabprm.html#afa6969fd752bb4e3823e8facf86bbd60">index</a>; <span class="comment">/* Vector of pointers to M indexing vectors */</span></div> <div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  <span class="comment">/* of lengths (K_1, K_2,... K_M). */</span></div> <div class="line"><a name="l00516"></a><span class="lineno"><a class="code" href="structtabprm.html#acee8b63d1691f1f531a1bb4854c6bf4c"> 516</a></span>  <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#acee8b63d1691f1f531a1bb4854c6bf4c">coord</a>; <span class="comment">/* (1+M)-dimensional tabular coordinate */</span></div> <div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  <span class="comment">/* array (see above). */</span></div> <div class="line"><a name="l00518"></a><span class="lineno"> 518</span> </div> <div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  <span class="comment">/* Information derived from the parameters supplied. */</span></div> <div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="comment">/*------------------------------------------------------------------------*/</span></div> <div class="line"><a name="l00521"></a><span class="lineno"><a class="code" href="structtabprm.html#a4263d73c71a9a5e77643f572c483b7ab"> 521</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a4263d73c71a9a5e77643f572c483b7ab">nc</a>; <span class="comment">/* Number of coordinate vectors (of length */</span></div> <div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  <span class="comment">/* M) in the coordinate array. */</span></div> <div class="line"><a name="l00523"></a><span class="lineno"><a class="code" href="structtabprm.html#a0777c3de4601874221031a8ad37eff95"> 523</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a0777c3de4601874221031a8ad37eff95">padding</a>; <span class="comment">/* (Dummy inserted for alignment purposes.) */</span></div> <div class="line"><a name="l00524"></a><span class="lineno"><a class="code" href="structtabprm.html#adc7e170dba47f4e6d40afabfdaecfddd"> 524</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#adc7e170dba47f4e6d40afabfdaecfddd">sense</a>; <span class="comment">/* Vector of M flags that indicate whether */</span></div> <div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  <span class="comment">/* the Mth indexing vector is monotonic */</span></div> <div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  <span class="comment">/* increasing, or else decreasing. */</span></div> <div class="line"><a name="l00527"></a><span class="lineno"><a class="code" href="structtabprm.html#a48cbe51ee26f0615036308fe72768403"> 527</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#a48cbe51ee26f0615036308fe72768403">p0</a>; <span class="comment">/* Vector of M indices. */</span></div> <div class="line"><a name="l00528"></a><span class="lineno"><a class="code" href="structtabprm.html#a77130658a6e330e0edba348d1dc7edf2"> 528</a></span>  <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#a77130658a6e330e0edba348d1dc7edf2">delta</a>; <span class="comment">/* Vector of M increments. */</span></div> <div class="line"><a name="l00529"></a><span class="lineno"><a class="code" href="structtabprm.html#aade738f7269d71d34fdf3d52f1c61d88"> 529</a></span>  <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#aade738f7269d71d34fdf3d52f1c61d88">extrema</a>; <span class="comment">/* (1+M)-dimensional array of coordinate */</span></div> <div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  <span class="comment">/* extrema. */</span></div> <div class="line"><a name="l00531"></a><span class="lineno"> 531</span> </div> <div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="comment">/* Error handling */</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"><a class="code" href="structtabprm.html#a3df12930fa5f38dcfc71aece8aed816c"> 534</a></span>  <span class="keyword">struct </span><a class="code" href="structwcserr.html" title="Error message handling. ">wcserr</a> *<a class="code" href="structtabprm.html#a3df12930fa5f38dcfc71aece8aed816c">err</a>;</div> <div class="line"><a name="l00535"></a><span class="lineno"> 535</span> </div> <div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="comment">/* Private - the remainder are for memory management. */</span></div> <div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  <span class="comment">/*------------------------------------------------------------------------*/</span></div> <div class="line"><a name="l00538"></a><span class="lineno"><a class="code" href="structtabprm.html#a36adcba673ae8ede86b80f7e5111e0ec"> 538</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a8572ca79676edfe06b3d1df00f93384b">m_flag</a>, <a class="code" href="structtabprm.html#ae19ca756ab2190f5d5ced59ad0a1a4bc">m_M</a>, <a class="code" href="structtabprm.html#a36adcba673ae8ede86b80f7e5111e0ec">m_N</a>;</div> <div class="line"><a name="l00539"></a><span class="lineno"><a class="code" href="structtabprm.html#a71057a73168d71019b0caaa203fe5a05"> 539</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#a71057a73168d71019b0caaa203fe5a05">set_M</a>;</div> <div class="line"><a name="l00540"></a><span class="lineno"><a class="code" href="structtabprm.html#a9d2c36c4cfb17532ba5f08cbd90a5785"> 540</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#a5c62c8fd3dc6e9a3c928be9a1ed81ca1">m_K</a>, *<a class="code" href="structtabprm.html#a9d2c36c4cfb17532ba5f08cbd90a5785">m_map</a>;</div> <div class="line"><a name="l00541"></a><span class="lineno"><a class="code" href="structtabprm.html#a43276034ba8e0954a6e2632117cd0afd"> 541</a></span>  <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#abf7f932bcefad1f0e371167971018965">m_crval</a>, **<a class="code" href="structtabprm.html#a1ce970a854c9976d8b3e4e26df102b3b">m_index</a>, **<a class="code" href="structtabprm.html#a43276034ba8e0954a6e2632117cd0afd">m_indxs</a>, *<a class="code" href="structtabprm.html#ac05f0ad36debbabf441ca8d8aac59a96">m_coord</a>;</div> <div class="line"><a name="l00542"></a><span class="lineno"> 542</span> };</div> <div class="line"><a name="l00543"></a><span class="lineno"> 543</span> </div> <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment">/* Size of the tabprm struct in int units, used by the Fortran wrappers. */</span></div> <div class="line"><a name="l00545"></a><span class="lineno"><a class="code" href="tab_8h.html#a9c80120944556169d230d4cd051d88cb"> 545</a></span> <span class="preprocessor">#define TABLEN (sizeof(struct tabprm)/sizeof(int))</span></div> <div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00547"></a><span class="lineno"> 547</span> </div> <div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#abb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct. ">tabini</a>(<span class="keywordtype">int</span> alloc, <span class="keywordtype">int</span> M, <span class="keyword">const</span> <span class="keywordtype">int</span> K[], <span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab);</div> <div class="line"><a name="l00549"></a><span class="lineno"> 549</span> </div> <div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#ae403ff0b740916989c7386728df001c8" title="Acquire tabular memory. ">tabmem</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab);</div> <div class="line"><a name="l00551"></a><span class="lineno"> 551</span> </div> <div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#a87b3a2a84bab396a528af8382ce9ad04" title="Copy routine for the tabprm struct. ">tabcpy</a>(<span class="keywordtype">int</span> alloc, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tabsrc, <span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tabdst);</div> <div class="line"><a name="l00553"></a><span class="lineno"> 553</span> </div> <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#a0f3501cc592c78e0f2cb9922466589f2" title="Destructor for the tabprm struct. ">tabfree</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab);</div> <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> </div> <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#a6b3768349e9a5e925aab24effddc584f" title="Print routine for the tabprm struct. ">tabprt</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab);</div> <div class="line"><a name="l00557"></a><span class="lineno"> 557</span> </div> <div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#a519e8e4503f7c41c0f99e8597171c97f" title="Setup routine for the tabprm struct. ">tabset</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab);</div> <div class="line"><a name="l00559"></a><span class="lineno"> 559</span> </div> <div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#a006d6e8cb373e0dc3e9ccf128adb9411" title="Pixel-to-world transformation. ">tabx2s</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab, <span class="keywordtype">int</span> ncoord, <span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">double</span> x[],</div> <div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  <span class="keywordtype">double</span> world[], <span class="keywordtype">int</span> stat[]);</div> <div class="line"><a name="l00562"></a><span class="lineno"> 562</span> </div> <div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#aaded7db92aa2758198b33f35f5f18d6e" title="World-to-pixel transformation. ">tabs2x</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters. ">tabprm</a> *tab, <span class="keywordtype">int</span> ncoord, <span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">double</span> world[],</div> <div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <span class="keywordtype">double</span> x[], <span class="keywordtype">int</span> stat[]);</div> <div class="line"><a name="l00565"></a><span class="lineno"> 565</span> </div> <div class="line"><a name="l00566"></a><span class="lineno"> 566</span> </div> <div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment">/* Deprecated. */</span></div> <div class="line"><a name="l00568"></a><span class="lineno"><a class="code" href="tab_8h.html#a8b57d9bacbabd2b516d77220cdb6167d"> 568</a></span> <span class="preprocessor">#define tabini_errmsg tab_errmsg</span></div> <div class="line"><a name="l00569"></a><span class="lineno"><a class="code" href="tab_8h.html#a27460f165fb03a075a1c6c6a48f33c62"> 569</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabcpy_errmsg tab_errmsg</span></div> <div class="line"><a name="l00570"></a><span class="lineno"><a class="code" href="tab_8h.html#abf96fe5488df6796ec2606b974f330fe"> 570</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabfree_errmsg tab_errmsg</span></div> <div class="line"><a name="l00571"></a><span class="lineno"><a class="code" href="tab_8h.html#ae2ee098afabb7a7d225f930276ffb441"> 571</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabprt_errmsg tab_errmsg</span></div> <div class="line"><a name="l00572"></a><span class="lineno"><a class="code" href="tab_8h.html#a4abf39ca4cfc2ea073bffdbb98caa46d"> 572</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabset_errmsg tab_errmsg</span></div> <div class="line"><a name="l00573"></a><span class="lineno"><a class="code" href="tab_8h.html#a141c3365f0364c01237aeeb93ddb717e"> 573</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabx2s_errmsg tab_errmsg</span></div> <div class="line"><a name="l00574"></a><span class="lineno"><a class="code" href="tab_8h.html#a49872082d67e357c5c68a633824133ae"> 574</a></span> <span class="preprocessor"></span><span class="preprocessor">#define tabs2x_errmsg tab_errmsg</span></div> <div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_TAB */</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>