1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<!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: log.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>log.h File Reference</h1>
<p>
<a href="log_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c36">log_errmsg_enum</a> { <br>
<a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c361f9859b85143e5ddc55744beff6d433c">LOGERR_SUCCESS</a> = 0,
<a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c36a1df3b688a38178c3bb75225c8921259">LOGERR_NULL_POINTER</a> = 1,
<a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c36fd604876bd42694c1a04cdae2be719e6">LOGERR_BAD_LOG_REF_VAL</a> = 2,
<a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c3685932a7f3c52c3090c1a1c5e82ed1c22">LOGERR_BAD_X</a> = 3,
<br>
<a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c3605b7fdbe8fcf799db114f90f04083273">LOGERR_BAD_WORLD</a> = 4
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8h.html#239e115e583af4e67e60de4a4f95f09e">logx2s</a> (double crval, int nx, int sx, int slogc, const double x[], double logc[], int stat[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transform to logarithmic coordinates. <a href="#239e115e583af4e67e60de4a4f95f09e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8h.html#c80fd753e48873cdbd9a332609de150a">logs2x</a> (double crval, int nlogc, int slogc, int sx, const double logc[], double x[], int stat[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transform logarithmic coordinates. <a href="#c80fd753e48873cdbd9a332609de150a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="log_8h.html#8b8e0a071c9539f4be52eaf789f385ea">log_errmsg</a> []</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Status return messages. <a href="#8b8e0a071c9539f4be52eaf789f385ea"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These routines implement the part of the FITS WCS standard that deals with logarithmic coordinates. They define methods to be used for computing logarithmic world coordinates from intermediate world coordinates (a linear transformation of image pixel coordinates), and vice versa.<p>
<a class="el" href="log_8h.html#239e115e583af4e67e60de4a4f95f09e" title="Transform to logarithmic coordinates.">logx2s()</a> and <a class="el" href="log_8h.html#c80fd753e48873cdbd9a332609de150a" title="Transform logarithmic coordinates.">logs2x()</a> implement the WCS logarithmic coordinate transformations.<p>
<b>Argument checking:</b> <br>
The input log-coordinate values are only checked for values that would result in floating point exceptions and the same is true for the log-coordinate reference value.<p>
<b>Accuracy:</b> <br>
No warranty is given for the accuracy of these routines (refer to the copyright notice); intending users must satisfy for themselves their adequacy for the intended purpose. However, closure effectively to within double precision rounding error was demonstrated by test routine tlog.c which accompanies this software. <hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c36"></a><!-- doxytag: member="log.h::log_errmsg_enum" ref="3ca7c9ed3cef9e053e1f32b60a0d0c36" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="log_8h.html#3ca7c9ed3cef9e053e1f32b60a0d0c36">log_errmsg_enum</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c361f9859b85143e5ddc55744beff6d433c"></a><!-- doxytag: member="LOGERR_SUCCESS" ref="3ca7c9ed3cef9e053e1f32b60a0d0c361f9859b85143e5ddc55744beff6d433c" args="" -->LOGERR_SUCCESS</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c36a1df3b688a38178c3bb75225c8921259"></a><!-- doxytag: member="LOGERR_NULL_POINTER" ref="3ca7c9ed3cef9e053e1f32b60a0d0c36a1df3b688a38178c3bb75225c8921259" args="" -->LOGERR_NULL_POINTER</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c36fd604876bd42694c1a04cdae2be719e6"></a><!-- doxytag: member="LOGERR_BAD_LOG_REF_VAL" ref="3ca7c9ed3cef9e053e1f32b60a0d0c36fd604876bd42694c1a04cdae2be719e6" args="" -->LOGERR_BAD_LOG_REF_VAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c3685932a7f3c52c3090c1a1c5e82ed1c22"></a><!-- doxytag: member="LOGERR_BAD_X" ref="3ca7c9ed3cef9e053e1f32b60a0d0c3685932a7f3c52c3090c1a1c5e82ed1c22" args="" -->LOGERR_BAD_X</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3ca7c9ed3cef9e053e1f32b60a0d0c3605b7fdbe8fcf799db114f90f04083273"></a><!-- doxytag: member="LOGERR_BAD_WORLD" ref="3ca7c9ed3cef9e053e1f32b60a0d0c3605b7fdbe8fcf799db114f90f04083273" args="" -->LOGERR_BAD_WORLD</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="239e115e583af4e67e60de4a4f95f09e"></a><!-- doxytag: member="log.h::logx2s" ref="239e115e583af4e67e60de4a4f95f09e" args="(double crval, int nx, int sx, int slogc, const double x[], double logc[], int stat[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int logx2s </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>crval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>slogc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double </td>
<td class="paramname"> <em>x</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>logc</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>stat</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>logx2s</b>() transforms intermediate world coordinates to logarithmic coordinates.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>crval</em> </td><td>Log-coordinate reference value (<code><b>CRVAL</b>ia</code>).</td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nx</em> </td><td>Vector length. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sx</em> </td><td>Vector stride. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>slogc</em> </td><td>Vector stride. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>x</em> </td><td>Intermediate world coordinates, in SI units.</td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>logc</em> </td><td>Logarithmic coordinates, in SI units. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>stat</em> </td><td>Status return value status for each vector element:<ul>
<li>0: Success.</li></ul>
</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>2: Invalid log-coordinate reference value. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="c80fd753e48873cdbd9a332609de150a"></a><!-- doxytag: member="log.h::logs2x" ref="c80fd753e48873cdbd9a332609de150a" args="(double crval, int nlogc, int slogc, int sx, const double logc[], double x[], int stat[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int logs2x </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>crval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nlogc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>slogc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double </td>
<td class="paramname"> <em>logc</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>stat</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>logs2x</b>() transforms logarithmic world coordinates to intermediate world coordinates.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>crval</em> </td><td>Log-coordinate reference value (<code><b>CRVAL</b>ia</code>).</td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nlogc</em> </td><td>Vector length. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>slogc</em> </td><td>Vector stride. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sx</em> </td><td>Vector stride. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>logc</em> </td><td>Logarithmic coordinates, in SI units.</td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>x</em> </td><td>Intermediate world coordinates, in SI units. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>stat</em> </td><td>Status return value status for each vector element:<ul>
<li>0: Success.</li><li>1: Invalid value of logc.</li></ul>
</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>2: Invalid log-coordinate reference value.</li><li>4: One or more of the world-coordinate values are incorrect, as indicated by the stat vector. </li></ul>
</dd></dl>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="8b8e0a071c9539f4be52eaf789f385ea"></a><!-- doxytag: member="log.h::log_errmsg" ref="8b8e0a071c9539f4be52eaf789f385ea" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * <a class="el" href="log_8h.html#8b8e0a071c9539f4be52eaf789f385ea">log_errmsg</a>[] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Error messages to match the status value returned from each function.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:30 2011 for WCSLIB 4.8.2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
