1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>WCSLIB 4.8.2: wcsutil.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>wcsutil.h</h1><a href="wcsutil_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*============================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> WCSLIB 4.8 - an implementation of the FITS WCS standard.</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 1995-2011, Mark Calabretta</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This file is part of WCSLIB.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> WCSLIB is free software: you can redistribute it and/or modify it under the</span>
<a name="l00009"></a>00009 <span class="comment"> terms of the GNU Lesser General Public License as published by the Free</span>
<a name="l00010"></a>00010 <span class="comment"> Software Foundation, either version 3 of the License, or (at your option)</span>
<a name="l00011"></a>00011 <span class="comment"> any later version.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment"> WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00014"></a>00014 <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00015"></a>00015 <span class="comment"> FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for</span>
<a name="l00016"></a>00016 <span class="comment"> more details.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> along with WCSLIB. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00020"></a>00020 <span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment"> Correspondence concerning WCSLIB may be directed to:</span>
<a name="l00022"></a>00022 <span class="comment"> Internet email: mcalabre@atnf.csiro.au</span>
<a name="l00023"></a>00023 <span class="comment"> Postal address: Dr. Mark Calabretta</span>
<a name="l00024"></a>00024 <span class="comment"> Australia Telescope National Facility, CSIRO</span>
<a name="l00025"></a>00025 <span class="comment"> PO Box 76</span>
<a name="l00026"></a>00026 <span class="comment"> Epping NSW 1710</span>
<a name="l00027"></a>00027 <span class="comment"> AUSTRALIA</span>
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> Author: Mark Calabretta, Australia Telescope National Facility</span>
<a name="l00030"></a>00030 <span class="comment"> http://www.atnf.csiro.au/~mcalabre/index.html</span>
<a name="l00031"></a>00031 <span class="comment"> $Id: wcsutil.h,v 4.8.1.1 2011/08/15 08:07:06 cal103 Exp cal103 $</span>
<a name="l00032"></a>00032 <span class="comment">*=============================================================================</span>
<a name="l00033"></a>00033 <span class="comment">*</span>
<a name="l00034"></a>00034 <span class="comment">* Summary of the wcsutil routines</span>
<a name="l00035"></a>00035 <span class="comment">* -------------------------------</span>
<a name="l00036"></a>00036 <span class="comment">* Simple utility functions for internal use only by WCSLIB. They are</span>
<a name="l00037"></a>00037 <span class="comment">* documented here solely as an aid to understanding the code. They are not</span>
<a name="l00038"></a>00038 <span class="comment">* intended for external use - the API may change without notice!</span>
<a name="l00039"></a>00039 <span class="comment">*</span>
<a name="l00040"></a>00040 <span class="comment">*</span>
<a name="l00041"></a>00041 <span class="comment">* wcsutil_blank_fill() - Fill a character string with blanks</span>
<a name="l00042"></a>00042 <span class="comment">* ----------------------------------------------------------</span>
<a name="l00043"></a>00043 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00044"></a>00044 <span class="comment">*</span>
<a name="l00045"></a>00045 <span class="comment">* wcsutil_blank_fill() pads a character string with blanks starting with the</span>
<a name="l00046"></a>00046 <span class="comment">* terminating NULL character.</span>
<a name="l00047"></a>00047 <span class="comment">*</span>
<a name="l00048"></a>00048 <span class="comment">* Used by the Fortran wrapper functions in translating C character strings</span>
<a name="l00049"></a>00049 <span class="comment">* into Fortran CHARACTER variables.</span>
<a name="l00050"></a>00050 <span class="comment">*</span>
<a name="l00051"></a>00051 <span class="comment">* Given:</span>
<a name="l00052"></a>00052 <span class="comment">* n int Length of the character array, c[].</span>
<a name="l00053"></a>00053 <span class="comment">*</span>
<a name="l00054"></a>00054 <span class="comment">* Given and returned:</span>
<a name="l00055"></a>00055 <span class="comment">* c char[] The character string. It will not be null-terminated</span>
<a name="l00056"></a>00056 <span class="comment">* on return.</span>
<a name="l00057"></a>00057 <span class="comment">*</span>
<a name="l00058"></a>00058 <span class="comment">* Function return value:</span>
<a name="l00059"></a>00059 <span class="comment">* void</span>
<a name="l00060"></a>00060 <span class="comment">*</span>
<a name="l00061"></a>00061 <span class="comment">*</span>
<a name="l00062"></a>00062 <span class="comment">* wcsutil_null_fill() - Fill a character string with NULLs</span>
<a name="l00063"></a>00063 <span class="comment">* --------------------------------------------------------</span>
<a name="l00064"></a>00064 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00065"></a>00065 <span class="comment">*</span>
<a name="l00066"></a>00066 <span class="comment">* wcsutil_null_fill() strips off trailing blanks and pads the character array</span>
<a name="l00067"></a>00067 <span class="comment">* holding the string with NULL characters.</span>
<a name="l00068"></a>00068 <span class="comment">*</span>
<a name="l00069"></a>00069 <span class="comment">* Used mainly to make character strings intelligible in the GNU debugger which</span>
<a name="l00070"></a>00070 <span class="comment">* prints the rubbish following the terminating NULL, obscuring the valid part</span>
<a name="l00071"></a>00071 <span class="comment">* of the string.</span>
<a name="l00072"></a>00072 <span class="comment">*</span>
<a name="l00073"></a>00073 <span class="comment">* Given:</span>
<a name="l00074"></a>00074 <span class="comment">* n int Number of characters.</span>
<a name="l00075"></a>00075 <span class="comment">*</span>
<a name="l00076"></a>00076 <span class="comment">* Given and returned:</span>
<a name="l00077"></a>00077 <span class="comment">* c char[] The character string.</span>
<a name="l00078"></a>00078 <span class="comment">*</span>
<a name="l00079"></a>00079 <span class="comment">* Function return value:</span>
<a name="l00080"></a>00080 <span class="comment">* void</span>
<a name="l00081"></a>00081 <span class="comment">*</span>
<a name="l00082"></a>00082 <span class="comment">*</span>
<a name="l00083"></a>00083 <span class="comment">* wcsutil_allEq() - Test for equality of a particular vector element</span>
<a name="l00084"></a>00084 <span class="comment">* ------------------------------------------------------------------</span>
<a name="l00085"></a>00085 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00086"></a>00086 <span class="comment">*</span>
<a name="l00087"></a>00087 <span class="comment">* wcsutil_allEq() tests for equality of a particular element in a set of</span>
<a name="l00088"></a>00088 <span class="comment">* vectors.</span>
<a name="l00089"></a>00089 <span class="comment">*</span>
<a name="l00090"></a>00090 <span class="comment">* Given:</span>
<a name="l00091"></a>00091 <span class="comment">* nvec int The number of vectors.</span>
<a name="l00092"></a>00092 <span class="comment">*</span>
<a name="l00093"></a>00093 <span class="comment">* nelem int The length of each vector.</span>
<a name="l00094"></a>00094 <span class="comment">*</span>
<a name="l00095"></a>00095 <span class="comment">* first const double*</span>
<a name="l00096"></a>00096 <span class="comment">* Pointer to the first element to test in the array.</span>
<a name="l00097"></a>00097 <span class="comment">* The elements tested for equality are</span>
<a name="l00098"></a>00098 <span class="comment">*</span>
<a name="l00099"></a>00099 <span class="comment">= *first == *(first + nelem)</span>
<a name="l00100"></a>00100 <span class="comment">= == *(first + nelem*2)</span>
<a name="l00101"></a>00101 <span class="comment">= :</span>
<a name="l00102"></a>00102 <span class="comment">= == *(first + nelem*(nvec-1));</span>
<a name="l00103"></a>00103 <span class="comment">*</span>
<a name="l00104"></a>00104 <span class="comment">* The array might be dimensioned as</span>
<a name="l00105"></a>00105 <span class="comment">*</span>
<a name="l00106"></a>00106 <span class="comment">= double v[nvec][nelem];</span>
<a name="l00107"></a>00107 <span class="comment">*</span>
<a name="l00108"></a>00108 <span class="comment">* Function return value:</span>
<a name="l00109"></a>00109 <span class="comment">* int Status return value:</span>
<a name="l00110"></a>00110 <span class="comment">* 0: Not all equal.</span>
<a name="l00111"></a>00111 <span class="comment">* 1: All equal.</span>
<a name="l00112"></a>00112 <span class="comment">*</span>
<a name="l00113"></a>00113 <span class="comment">*</span>
<a name="l00114"></a>00114 <span class="comment">* wcsutil_setAll() - Set a particular vector element</span>
<a name="l00115"></a>00115 <span class="comment">* --------------------------------------------------</span>
<a name="l00116"></a>00116 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00117"></a>00117 <span class="comment">*</span>
<a name="l00118"></a>00118 <span class="comment">* wcsutil_setAll() sets the value of a particular element in a set of vectors.</span>
<a name="l00119"></a>00119 <span class="comment">*</span>
<a name="l00120"></a>00120 <span class="comment">* Given:</span>
<a name="l00121"></a>00121 <span class="comment">* nvec int The number of vectors.</span>
<a name="l00122"></a>00122 <span class="comment">*</span>
<a name="l00123"></a>00123 <span class="comment">* nelem int The length of each vector.</span>
<a name="l00124"></a>00124 <span class="comment">*</span>
<a name="l00125"></a>00125 <span class="comment">* Given and returned:</span>
<a name="l00126"></a>00126 <span class="comment">* first double* Pointer to the first element in the array, the value</span>
<a name="l00127"></a>00127 <span class="comment">* of which is used to set the others</span>
<a name="l00128"></a>00128 <span class="comment">*</span>
<a name="l00129"></a>00129 <span class="comment">= *(first + nelem) = *first;</span>
<a name="l00130"></a>00130 <span class="comment">= *(first + nelem*2) = *first;</span>
<a name="l00131"></a>00131 <span class="comment">= :</span>
<a name="l00132"></a>00132 <span class="comment">= *(first + nelem*(nvec-1)) = *first;</span>
<a name="l00133"></a>00133 <span class="comment">*</span>
<a name="l00134"></a>00134 <span class="comment">* The array might be dimensioned as</span>
<a name="l00135"></a>00135 <span class="comment">*</span>
<a name="l00136"></a>00136 <span class="comment">= double v[nvec][nelem];</span>
<a name="l00137"></a>00137 <span class="comment">*</span>
<a name="l00138"></a>00138 <span class="comment">* Function return value:</span>
<a name="l00139"></a>00139 <span class="comment">* void</span>
<a name="l00140"></a>00140 <span class="comment">*</span>
<a name="l00141"></a>00141 <span class="comment">*</span>
<a name="l00142"></a>00142 <span class="comment">* wcsutil_setAli() - Set a particular vector element</span>
<a name="l00143"></a>00143 <span class="comment">* --------------------------------------------------</span>
<a name="l00144"></a>00144 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00145"></a>00145 <span class="comment">*</span>
<a name="l00146"></a>00146 <span class="comment">* wcsutil_setAli() sets the value of a particular element in a set of vectors.</span>
<a name="l00147"></a>00147 <span class="comment">*</span>
<a name="l00148"></a>00148 <span class="comment">* Given:</span>
<a name="l00149"></a>00149 <span class="comment">* nvec int The number of vectors.</span>
<a name="l00150"></a>00150 <span class="comment">*</span>
<a name="l00151"></a>00151 <span class="comment">* nelem int The length of each vector.</span>
<a name="l00152"></a>00152 <span class="comment">*</span>
<a name="l00153"></a>00153 <span class="comment">* Given and returned:</span>
<a name="l00154"></a>00154 <span class="comment">* first int* Pointer to the first element in the array, the value</span>
<a name="l00155"></a>00155 <span class="comment">* of which is used to set the others</span>
<a name="l00156"></a>00156 <span class="comment">*</span>
<a name="l00157"></a>00157 <span class="comment">= *(first + nelem) = *first;</span>
<a name="l00158"></a>00158 <span class="comment">= *(first + nelem*2) = *first;</span>
<a name="l00159"></a>00159 <span class="comment">= :</span>
<a name="l00160"></a>00160 <span class="comment">= *(first + nelem*(nvec-1)) = *first;</span>
<a name="l00161"></a>00161 <span class="comment">*</span>
<a name="l00162"></a>00162 <span class="comment">* The array might be dimensioned as</span>
<a name="l00163"></a>00163 <span class="comment">*</span>
<a name="l00164"></a>00164 <span class="comment">= int v[nvec][nelem];</span>
<a name="l00165"></a>00165 <span class="comment">*</span>
<a name="l00166"></a>00166 <span class="comment">* Function return value:</span>
<a name="l00167"></a>00167 <span class="comment">* void</span>
<a name="l00168"></a>00168 <span class="comment">*</span>
<a name="l00169"></a>00169 <span class="comment">*</span>
<a name="l00170"></a>00170 <span class="comment">* wcsutil_setBit() - Set bits in selected elements of an array</span>
<a name="l00171"></a>00171 <span class="comment">* ------------------------------------------------------------</span>
<a name="l00172"></a>00172 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00173"></a>00173 <span class="comment">*</span>
<a name="l00174"></a>00174 <span class="comment">* wcsutil_setBit() sets bits in selected elements of an array.</span>
<a name="l00175"></a>00175 <span class="comment">*</span>
<a name="l00176"></a>00176 <span class="comment">* Given:</span>
<a name="l00177"></a>00177 <span class="comment">* nelem int Number of elements in the array.</span>
<a name="l00178"></a>00178 <span class="comment">*</span>
<a name="l00179"></a>00179 <span class="comment">* sel const int*</span>
<a name="l00180"></a>00180 <span class="comment">* Address of a selection array of length nelem. May</span>
<a name="l00181"></a>00181 <span class="comment">* be specified as the null pointer in which case all</span>
<a name="l00182"></a>00182 <span class="comment">* elements are selected.</span>
<a name="l00183"></a>00183 <span class="comment">*</span>
<a name="l00184"></a>00184 <span class="comment">* bits int Bit mask.</span>
<a name="l00185"></a>00185 <span class="comment">*</span>
<a name="l00186"></a>00186 <span class="comment">* Given and returned:</span>
<a name="l00187"></a>00187 <span class="comment">* array int* Address of the array of length nelem.</span>
<a name="l00188"></a>00188 <span class="comment">*</span>
<a name="l00189"></a>00189 <span class="comment">* Function return value:</span>
<a name="l00190"></a>00190 <span class="comment">* void</span>
<a name="l00191"></a>00191 <span class="comment">*</span>
<a name="l00192"></a>00192 <span class="comment">*</span>
<a name="l00193"></a>00193 <span class="comment">* wcsutil_fptr2str() - Translate pointer-to-function to string</span>
<a name="l00194"></a>00194 <span class="comment">* ------------------------------------------------------------</span>
<a name="l00195"></a>00195 <span class="comment">* INTERNAL USE ONLY.</span>
<a name="l00196"></a>00196 <span class="comment">*</span>
<a name="l00197"></a>00197 <span class="comment">* wcsutil_fptr2str() translates a pointer-to-function to hexadecimal string</span>
<a name="l00198"></a>00198 <span class="comment">* representation for output. It is used by the various routines that print</span>
<a name="l00199"></a>00199 <span class="comment">* the contents of WCSLIB structs. Note that it is not strictly legal to</span>
<a name="l00200"></a>00200 <span class="comment">* type-pun a function pointer to void*.</span>
<a name="l00201"></a>00201 <span class="comment">*</span>
<a name="l00202"></a>00202 <span class="comment">* See stackoverflow.com/questions/2741683/how-to-format-a-function-pointer</span>
<a name="l00203"></a>00203 <span class="comment">*</span>
<a name="l00204"></a>00204 <span class="comment">* Given:</span>
<a name="l00205"></a>00205 <span class="comment">* fptr int (*)() Pointer to function.</span>
<a name="l00206"></a>00206 <span class="comment">*</span>
<a name="l00207"></a>00207 <span class="comment">* Returned:</span>
<a name="l00208"></a>00208 <span class="comment">* hext char[] Null-terminated string. Should be at least 19 bytes</span>
<a name="l00209"></a>00209 <span class="comment">* in size to accomodate a 64-bit address (16 bytes in</span>
<a name="l00210"></a>00210 <span class="comment">* hex), plus the leading "0x" and trailing '\0'.</span>
<a name="l00211"></a>00211 <span class="comment">*</span>
<a name="l00212"></a>00212 <span class="comment">* Function return value:</span>
<a name="l00213"></a>00213 <span class="comment">* char * The address of hext.</span>
<a name="l00214"></a>00214 <span class="comment">*</span>
<a name="l00215"></a>00215 <span class="comment">*===========================================================================*/</span>
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="preprocessor">#ifndef WCSLIB_WCSUTIL</span>
<a name="l00218"></a>00218 <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSUTIL</span>
<a name="l00219"></a>00219 <span class="preprocessor"></span>
<a name="l00220"></a>00220 <span class="keywordtype">void</span> <a class="code" href="wcsutil_8h.html#38322fa65b3bad54552d374d873ad037" title="Fill a character string with blanks.">wcsutil_blank_fill</a>(<span class="keywordtype">int</span> n, <span class="keywordtype">char</span> c[]);
<a name="l00221"></a>00221 <span class="keywordtype">void</span> <a class="code" href="wcsutil_8h.html#9d96f343fc444f8c6f1fa01367c4d765" title="Fill a character string with NULLs.">wcsutil_null_fill</a> (<span class="keywordtype">int</span> n, <span class="keywordtype">char</span> c[]);
<a name="l00222"></a>00222
<a name="l00223"></a>00223 <span class="keywordtype">int</span> <a class="code" href="wcsutil_8h.html#4c7c5a686aaa39f511598b32e944ac68" title="Test for equality of a particular vector element.">wcsutil_allEq</a> (<span class="keywordtype">int</span> nvec, <span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">double</span> *first);
<a name="l00224"></a>00224 <span class="keywordtype">void</span> <a class="code" href="wcsutil_8h.html#fe7f963c2038673015bbce204c4a8171" title="Set a particular vector element.">wcsutil_setAll</a>(<span class="keywordtype">int</span> nvec, <span class="keywordtype">int</span> nelem, <span class="keywordtype">double</span> *first);
<a name="l00225"></a>00225 <span class="keywordtype">void</span> <a class="code" href="wcsutil_8h.html#b32722081f8cda184d7ada6d734c637c" title="Set a particular vector element.">wcsutil_setAli</a>(<span class="keywordtype">int</span> nvec, <span class="keywordtype">int</span> nelem, <span class="keywordtype">int</span> *first);
<a name="l00226"></a>00226 <span class="keywordtype">void</span> <a class="code" href="wcsutil_8h.html#0d982911e7f694a751f2887ea38890e4" title="Set bits in selected elements of an array.">wcsutil_setBit</a>(<span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">int</span> *sel, <span class="keywordtype">int</span> bits, <span class="keywordtype">int</span> *array);
<a name="l00227"></a>00227 <span class="keywordtype">char</span> *<a class="code" href="wcsutil_8h.html#9bc774de065f8937aa9bbffa2df6089c">wcsutil_fptr2str</a>(<span class="keywordtype">int</span> (*func)(), <span class="keywordtype">char</span> hext[]);
<a name="l00228"></a>00228
<a name="l00229"></a>00229 <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCSUTIL */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:30 2011 for WCSLIB 4.8.2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
