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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
|
<!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: tab.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>tab.h</h1><a href="tab_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: tab.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">* WCSLIB 4.8 - C routines that implement tabular coordinate systems as</span>
<a name="l00035"></a>00035 <span class="comment">* defined by the FITS World Coordinate System (WCS) standard. Refer to</span>
<a name="l00036"></a>00036 <span class="comment">*</span>
<a name="l00037"></a>00037 <span class="comment">* "Representations of world coordinates in FITS",</span>
<a name="l00038"></a>00038 <span class="comment">* Greisen, E.W., & Calabretta, M.R. 2002, A&A, 395, 1061 (paper I)</span>
<a name="l00039"></a>00039 <span class="comment">*</span>
<a name="l00040"></a>00040 <span class="comment">* "Representations of spectral coordinates in FITS",</span>
<a name="l00041"></a>00041 <span class="comment">* Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L.</span>
<a name="l00042"></a>00042 <span class="comment">* 2006, A&A, 446, 747 (Paper III)</span>
<a name="l00043"></a>00043 <span class="comment">*</span>
<a name="l00044"></a>00044 <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span>
<a name="l00045"></a>00045 <span class="comment">* library.</span>
<a name="l00046"></a>00046 <span class="comment">*</span>
<a name="l00047"></a>00047 <span class="comment">*</span>
<a name="l00048"></a>00048 <span class="comment">* Summary of the tab routines</span>
<a name="l00049"></a>00049 <span class="comment">* ---------------------------</span>
<a name="l00050"></a>00050 <span class="comment">* These routines implement the part of the FITS WCS standard that deals with</span>
<a name="l00051"></a>00051 <span class="comment">* tabular coordinates, i.e. coordinates that are defined via a lookup table.</span>
<a name="l00052"></a>00052 <span class="comment">* They define methods to be used for computing tabular world coordinates from</span>
<a name="l00053"></a>00053 <span class="comment">* intermediate world coordinates (a linear transformation of image pixel</span>
<a name="l00054"></a>00054 <span class="comment">* coordinates), and vice versa. They are based on the tabprm struct which</span>
<a name="l00055"></a>00055 <span class="comment">* contains all information needed for the computations. The struct contains</span>
<a name="l00056"></a>00056 <span class="comment">* some members that must be set by the user, and others that are maintained</span>
<a name="l00057"></a>00057 <span class="comment">* by these routines, somewhat like a C++ class but with no encapsulation.</span>
<a name="l00058"></a>00058 <span class="comment">*</span>
<a name="l00059"></a>00059 <span class="comment">* tabini(), tabmem(), tabcpy(), and tabfree() are provided to manage the</span>
<a name="l00060"></a>00060 <span class="comment">* tabprm struct, and another, tabprt(), to print its contents.</span>
<a name="l00061"></a>00061 <span class="comment">*</span>
<a name="l00062"></a>00062 <span class="comment">* A setup routine, tabset(), computes intermediate values in the tabprm struct</span>
<a name="l00063"></a>00063 <span class="comment">* from parameters in it that were supplied by the user. The struct always</span>
<a name="l00064"></a>00064 <span class="comment">* needs to be set up by tabset() but it need not be called explicitly - refer</span>
<a name="l00065"></a>00065 <span class="comment">* to the explanation of tabprm::flag.</span>
<a name="l00066"></a>00066 <span class="comment">*</span>
<a name="l00067"></a>00067 <span class="comment">* tabx2s() and tabs2x() implement the WCS tabular coordinate transformations.</span>
<a name="l00068"></a>00068 <span class="comment">*</span>
<a name="l00069"></a>00069 <span class="comment">* Accuracy:</span>
<a name="l00070"></a>00070 <span class="comment">* ---------</span>
<a name="l00071"></a>00071 <span class="comment">* No warranty is given for the accuracy of these routines (refer to the</span>
<a name="l00072"></a>00072 <span class="comment">* copyright notice); intending users must satisfy for themselves their</span>
<a name="l00073"></a>00073 <span class="comment">* adequacy for the intended purpose. However, closure effectively to within</span>
<a name="l00074"></a>00074 <span class="comment">* double precision rounding error was demonstrated by test routine ttab.c</span>
<a name="l00075"></a>00075 <span class="comment">* which accompanies this software.</span>
<a name="l00076"></a>00076 <span class="comment">*</span>
<a name="l00077"></a>00077 <span class="comment">*</span>
<a name="l00078"></a>00078 <span class="comment">* tabini() - Default constructor for the tabprm struct</span>
<a name="l00079"></a>00079 <span class="comment">* ----------------------------------------------------</span>
<a name="l00080"></a>00080 <span class="comment">* tabini() allocates memory for arrays in a tabprm struct and sets all members</span>
<a name="l00081"></a>00081 <span class="comment">* of the struct to default values.</span>
<a name="l00082"></a>00082 <span class="comment">*</span>
<a name="l00083"></a>00083 <span class="comment">* PLEASE NOTE: every tabprm struct should be initialized by tabini(), possibly</span>
<a name="l00084"></a>00084 <span class="comment">* repeatedly. On the first invokation, and only the first invokation, the</span>
<a name="l00085"></a>00085 <span class="comment">* flag member of the tabprm struct must be set to -1 to initialize memory</span>
<a name="l00086"></a>00086 <span class="comment">* management, regardless of whether tabini() will actually be used to allocate</span>
<a name="l00087"></a>00087 <span class="comment">* memory.</span>
<a name="l00088"></a>00088 <span class="comment">*</span>
<a name="l00089"></a>00089 <span class="comment">* Given:</span>
<a name="l00090"></a>00090 <span class="comment">* alloc int If true, allocate memory unconditionally for arrays in</span>
<a name="l00091"></a>00091 <span class="comment">* the tabprm struct.</span>
<a name="l00092"></a>00092 <span class="comment">*</span>
<a name="l00093"></a>00093 <span class="comment">* If false, it is assumed that pointers to these arrays</span>
<a name="l00094"></a>00094 <span class="comment">* have been set by the user except if they are null</span>
<a name="l00095"></a>00095 <span class="comment">* pointers in which case memory will be allocated for</span>
<a name="l00096"></a>00096 <span class="comment">* them regardless. (In other words, setting alloc true</span>
<a name="l00097"></a>00097 <span class="comment">* saves having to initalize these pointers to zero.)</span>
<a name="l00098"></a>00098 <span class="comment">*</span>
<a name="l00099"></a>00099 <span class="comment">* M int The number of tabular coordinate axes.</span>
<a name="l00100"></a>00100 <span class="comment">*</span>
<a name="l00101"></a>00101 <span class="comment">* K const int[]</span>
<a name="l00102"></a>00102 <span class="comment">* Vector of length M whose elements (K_1, K_2,... K_M)</span>
<a name="l00103"></a>00103 <span class="comment">* record the lengths of the axes of the coordinate array</span>
<a name="l00104"></a>00104 <span class="comment">* and of each indexing vector. M and K[] are used to</span>
<a name="l00105"></a>00105 <span class="comment">* determine the length of the various tabprm arrays and</span>
<a name="l00106"></a>00106 <span class="comment">* therefore the amount of memory to allocate for them.</span>
<a name="l00107"></a>00107 <span class="comment">* Their values are copied into the tabprm struct.</span>
<a name="l00108"></a>00108 <span class="comment">*</span>
<a name="l00109"></a>00109 <span class="comment">* It is permissible to set K (i.e. the address of the</span>
<a name="l00110"></a>00110 <span class="comment">* array) to zero which has the same effect as setting</span>
<a name="l00111"></a>00111 <span class="comment">* each element of K[] to zero. In this case no memory</span>
<a name="l00112"></a>00112 <span class="comment">* will be allocated for the index vectors or coordinate</span>
<a name="l00113"></a>00113 <span class="comment">* array in the tabprm struct. These together with the</span>
<a name="l00114"></a>00114 <span class="comment">* K vector must be set separately before calling</span>
<a name="l00115"></a>00115 <span class="comment">* tabset().</span>
<a name="l00116"></a>00116 <span class="comment">*</span>
<a name="l00117"></a>00117 <span class="comment">* Given and returned:</span>
<a name="l00118"></a>00118 <span class="comment">* tab struct tabprm*</span>
<a name="l00119"></a>00119 <span class="comment">* Tabular transformation parameters. Note that, in</span>
<a name="l00120"></a>00120 <span class="comment">* order to initialize memory management tabprm::flag</span>
<a name="l00121"></a>00121 <span class="comment">* should be set to -1 when tab is initialized for the</span>
<a name="l00122"></a>00122 <span class="comment">* first time (memory leaks may result if it had already</span>
<a name="l00123"></a>00123 <span class="comment">* been initialized).</span>
<a name="l00124"></a>00124 <span class="comment">*</span>
<a name="l00125"></a>00125 <span class="comment">* Function return value:</span>
<a name="l00126"></a>00126 <span class="comment">* int Status return value:</span>
<a name="l00127"></a>00127 <span class="comment">* 0: Success.</span>
<a name="l00128"></a>00128 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00129"></a>00129 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00130"></a>00130 <span class="comment">* 3: Invalid tabular parameters.</span>
<a name="l00131"></a>00131 <span class="comment">*</span>
<a name="l00132"></a>00132 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00133"></a>00133 <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span>
<a name="l00134"></a>00134 <span class="comment">*</span>
<a name="l00135"></a>00135 <span class="comment">*</span>
<a name="l00136"></a>00136 <span class="comment">* tabmem() - Acquire tabular memory</span>
<a name="l00137"></a>00137 <span class="comment">* ---------------------------------</span>
<a name="l00138"></a>00138 <span class="comment">* tabmem() takes control of memory allocated by the user for arrays in the</span>
<a name="l00139"></a>00139 <span class="comment">* tabprm struct.</span>
<a name="l00140"></a>00140 <span class="comment">*</span>
<a name="l00141"></a>00141 <span class="comment">* Given and returned:</span>
<a name="l00142"></a>00142 <span class="comment">* tab struct tabprm*</span>
<a name="l00143"></a>00143 <span class="comment">* Tabular transformation parameters.</span>
<a name="l00144"></a>00144 <span class="comment">*</span>
<a name="l00145"></a>00145 <span class="comment">* Function return value:</span>
<a name="l00146"></a>00146 <span class="comment">* int Status return value:</span>
<a name="l00147"></a>00147 <span class="comment">* 0: Success.</span>
<a name="l00148"></a>00148 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00149"></a>00149 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00150"></a>00150 <span class="comment">*</span>
<a name="l00151"></a>00151 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00152"></a>00152 <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span>
<a name="l00153"></a>00153 <span class="comment">*</span>
<a name="l00154"></a>00154 <span class="comment">*</span>
<a name="l00155"></a>00155 <span class="comment">* tabcpy() - Copy routine for the tabprm struct</span>
<a name="l00156"></a>00156 <span class="comment">* ---------------------------------------------</span>
<a name="l00157"></a>00157 <span class="comment">* tabcpy() does a deep copy of one tabprm struct to another, using tabini() to</span>
<a name="l00158"></a>00158 <span class="comment">* allocate memory for its arrays if required. Only the "information to be</span>
<a name="l00159"></a>00159 <span class="comment">* provided" part of the struct is copied; a call to tabset() is required to</span>
<a name="l00160"></a>00160 <span class="comment">* set up the remainder.</span>
<a name="l00161"></a>00161 <span class="comment">*</span>
<a name="l00162"></a>00162 <span class="comment">* Given:</span>
<a name="l00163"></a>00163 <span class="comment">* alloc int If true, allocate memory unconditionally for arrays in</span>
<a name="l00164"></a>00164 <span class="comment">* the tabprm struct.</span>
<a name="l00165"></a>00165 <span class="comment">*</span>
<a name="l00166"></a>00166 <span class="comment">* If false, it is assumed that pointers to these arrays</span>
<a name="l00167"></a>00167 <span class="comment">* have been set by the user except if they are null</span>
<a name="l00168"></a>00168 <span class="comment">* pointers in which case memory will be allocated for</span>
<a name="l00169"></a>00169 <span class="comment">* them regardless. (In other words, setting alloc true</span>
<a name="l00170"></a>00170 <span class="comment">* saves having to initalize these pointers to zero.)</span>
<a name="l00171"></a>00171 <span class="comment">*</span>
<a name="l00172"></a>00172 <span class="comment">* tabsrc const struct tabprm*</span>
<a name="l00173"></a>00173 <span class="comment">* Struct to copy from.</span>
<a name="l00174"></a>00174 <span class="comment">*</span>
<a name="l00175"></a>00175 <span class="comment">* Given and returned:</span>
<a name="l00176"></a>00176 <span class="comment">* tabdst struct tabprm*</span>
<a name="l00177"></a>00177 <span class="comment">* Struct to copy to. tabprm::flag should be set to -1</span>
<a name="l00178"></a>00178 <span class="comment">* if tabdst was not previously initialized (memory leaks</span>
<a name="l00179"></a>00179 <span class="comment">* may result if it was previously initialized).</span>
<a name="l00180"></a>00180 <span class="comment">*</span>
<a name="l00181"></a>00181 <span class="comment">* Function return value:</span>
<a name="l00182"></a>00182 <span class="comment">* int Status return value:</span>
<a name="l00183"></a>00183 <span class="comment">* 0: Success.</span>
<a name="l00184"></a>00184 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00185"></a>00185 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00186"></a>00186 <span class="comment">*</span>
<a name="l00187"></a>00187 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00188"></a>00188 <span class="comment">* tabprm::err (associated with tabdst) if enabled, see</span>
<a name="l00189"></a>00189 <span class="comment">* wcserr_enable().</span>
<a name="l00190"></a>00190 <span class="comment">*</span>
<a name="l00191"></a>00191 <span class="comment">*</span>
<a name="l00192"></a>00192 <span class="comment">* tabfree() - Destructor for the tabprm struct</span>
<a name="l00193"></a>00193 <span class="comment">* --------------------------------------------</span>
<a name="l00194"></a>00194 <span class="comment">* tabfree() frees memory allocated for the tabprm arrays by tabini().</span>
<a name="l00195"></a>00195 <span class="comment">* tabini() records the memory it allocates and tabfree() will only attempt to</span>
<a name="l00196"></a>00196 <span class="comment">* free this.</span>
<a name="l00197"></a>00197 <span class="comment">*</span>
<a name="l00198"></a>00198 <span class="comment">* PLEASE NOTE: tabfree() must not be invoked on a tabprm struct that was not</span>
<a name="l00199"></a>00199 <span class="comment">* initialized by tabini().</span>
<a name="l00200"></a>00200 <span class="comment">*</span>
<a name="l00201"></a>00201 <span class="comment">* Returned:</span>
<a name="l00202"></a>00202 <span class="comment">* tab struct tabprm*</span>
<a name="l00203"></a>00203 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00204"></a>00204 <span class="comment">*</span>
<a name="l00205"></a>00205 <span class="comment">* Function return value:</span>
<a name="l00206"></a>00206 <span class="comment">* int Status return value:</span>
<a name="l00207"></a>00207 <span class="comment">* 0: Success.</span>
<a name="l00208"></a>00208 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00209"></a>00209 <span class="comment">*</span>
<a name="l00210"></a>00210 <span class="comment">*</span>
<a name="l00211"></a>00211 <span class="comment">* tabprt() - Print routine for the tabprm struct</span>
<a name="l00212"></a>00212 <span class="comment">* ----------------------------------------------</span>
<a name="l00213"></a>00213 <span class="comment">* tabprt() prints the contents of a tabprm struct using wcsprintf(). Mainly</span>
<a name="l00214"></a>00214 <span class="comment">* intended for diagnostic purposes.</span>
<a name="l00215"></a>00215 <span class="comment">*</span>
<a name="l00216"></a>00216 <span class="comment">* Given:</span>
<a name="l00217"></a>00217 <span class="comment">* tab const struct tabprm*</span>
<a name="l00218"></a>00218 <span class="comment">* Tabular transformation parameters.</span>
<a name="l00219"></a>00219 <span class="comment">*</span>
<a name="l00220"></a>00220 <span class="comment">* Function return value:</span>
<a name="l00221"></a>00221 <span class="comment">* int Status return value:</span>
<a name="l00222"></a>00222 <span class="comment">* 0: Success.</span>
<a name="l00223"></a>00223 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00224"></a>00224 <span class="comment">*</span>
<a name="l00225"></a>00225 <span class="comment">*</span>
<a name="l00226"></a>00226 <span class="comment">* tabset() - Setup routine for the tabprm struct</span>
<a name="l00227"></a>00227 <span class="comment">* -----------------------------------------------</span>
<a name="l00228"></a>00228 <span class="comment">* tabset() allocates memory for work arrays in the tabprm struct and sets up</span>
<a name="l00229"></a>00229 <span class="comment">* the struct according to information supplied within it.</span>
<a name="l00230"></a>00230 <span class="comment">*</span>
<a name="l00231"></a>00231 <span class="comment">* Note that this routine need not be called directly; it will be invoked by</span>
<a name="l00232"></a>00232 <span class="comment">* tabx2s() and tabs2x() if tabprm::flag is anything other than a predefined</span>
<a name="l00233"></a>00233 <span class="comment">* magic value.</span>
<a name="l00234"></a>00234 <span class="comment">*</span>
<a name="l00235"></a>00235 <span class="comment">* Given and returned:</span>
<a name="l00236"></a>00236 <span class="comment">* tab struct tabprm*</span>
<a name="l00237"></a>00237 <span class="comment">* Tabular transformation parameters.</span>
<a name="l00238"></a>00238 <span class="comment">*</span>
<a name="l00239"></a>00239 <span class="comment">* Function return value:</span>
<a name="l00240"></a>00240 <span class="comment">* int Status return value:</span>
<a name="l00241"></a>00241 <span class="comment">* 0: Success.</span>
<a name="l00242"></a>00242 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00243"></a>00243 <span class="comment">* 3: Invalid tabular parameters.</span>
<a name="l00244"></a>00244 <span class="comment">*</span>
<a name="l00245"></a>00245 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00246"></a>00246 <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span>
<a name="l00247"></a>00247 <span class="comment">*</span>
<a name="l00248"></a>00248 <span class="comment">*</span>
<a name="l00249"></a>00249 <span class="comment">* tabx2s() - Pixel-to-world transformation</span>
<a name="l00250"></a>00250 <span class="comment">* ----------------------------------------</span>
<a name="l00251"></a>00251 <span class="comment">* tabx2s() transforms intermediate world coordinates to world coordinates</span>
<a name="l00252"></a>00252 <span class="comment">* using coordinate lookup.</span>
<a name="l00253"></a>00253 <span class="comment">*</span>
<a name="l00254"></a>00254 <span class="comment">* Given and returned:</span>
<a name="l00255"></a>00255 <span class="comment">* tab struct tabprm*</span>
<a name="l00256"></a>00256 <span class="comment">* Tabular transformation parameters.</span>
<a name="l00257"></a>00257 <span class="comment">*</span>
<a name="l00258"></a>00258 <span class="comment">* Given:</span>
<a name="l00259"></a>00259 <span class="comment">* ncoord,</span>
<a name="l00260"></a>00260 <span class="comment">* nelem int The number of coordinates, each of vector length</span>
<a name="l00261"></a>00261 <span class="comment">* nelem.</span>
<a name="l00262"></a>00262 <span class="comment">*</span>
<a name="l00263"></a>00263 <span class="comment">* x const double[ncoord][nelem]</span>
<a name="l00264"></a>00264 <span class="comment">* Array of intermediate world coordinates, SI units.</span>
<a name="l00265"></a>00265 <span class="comment">*</span>
<a name="l00266"></a>00266 <span class="comment">* Returned:</span>
<a name="l00267"></a>00267 <span class="comment">* world double[ncoord][nelem]</span>
<a name="l00268"></a>00268 <span class="comment">* Array of world coordinates, in SI units.</span>
<a name="l00269"></a>00269 <span class="comment">*</span>
<a name="l00270"></a>00270 <span class="comment">* stat int[ncoord]</span>
<a name="l00271"></a>00271 <span class="comment">* Status return value status for each coordinate:</span>
<a name="l00272"></a>00272 <span class="comment">* 0: Success.</span>
<a name="l00273"></a>00273 <span class="comment">* 1: Invalid intermediate world coordinate.</span>
<a name="l00274"></a>00274 <span class="comment">*</span>
<a name="l00275"></a>00275 <span class="comment">* Function return value:</span>
<a name="l00276"></a>00276 <span class="comment">* int Status return value:</span>
<a name="l00277"></a>00277 <span class="comment">* 0: Success.</span>
<a name="l00278"></a>00278 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00279"></a>00279 <span class="comment">* 3: Invalid tabular parameters.</span>
<a name="l00280"></a>00280 <span class="comment">* 4: One or more of the x coordinates were invalid,</span>
<a name="l00281"></a>00281 <span class="comment">* as indicated by the stat vector.</span>
<a name="l00282"></a>00282 <span class="comment">*</span>
<a name="l00283"></a>00283 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00284"></a>00284 <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span>
<a name="l00285"></a>00285 <span class="comment">*</span>
<a name="l00286"></a>00286 <span class="comment">*</span>
<a name="l00287"></a>00287 <span class="comment">* tabs2x() - World-to-pixel transformation</span>
<a name="l00288"></a>00288 <span class="comment">* ----------------------------------------</span>
<a name="l00289"></a>00289 <span class="comment">* tabs2x() transforms world coordinates to intermediate world coordinates.</span>
<a name="l00290"></a>00290 <span class="comment">*</span>
<a name="l00291"></a>00291 <span class="comment">* Given and returned:</span>
<a name="l00292"></a>00292 <span class="comment">* tab struct tabprm*</span>
<a name="l00293"></a>00293 <span class="comment">* Tabular transformation parameters.</span>
<a name="l00294"></a>00294 <span class="comment">*</span>
<a name="l00295"></a>00295 <span class="comment">* Given:</span>
<a name="l00296"></a>00296 <span class="comment">* ncoord,</span>
<a name="l00297"></a>00297 <span class="comment">* nelem int The number of coordinates, each of vector length</span>
<a name="l00298"></a>00298 <span class="comment">* nelem.</span>
<a name="l00299"></a>00299 <span class="comment">* world const double[ncoord][nelem]</span>
<a name="l00300"></a>00300 <span class="comment">* Array of world coordinates, in SI units.</span>
<a name="l00301"></a>00301 <span class="comment">*</span>
<a name="l00302"></a>00302 <span class="comment">* Returned:</span>
<a name="l00303"></a>00303 <span class="comment">* x double[ncoord][nelem]</span>
<a name="l00304"></a>00304 <span class="comment">* Array of intermediate world coordinates, SI units.</span>
<a name="l00305"></a>00305 <span class="comment">* stat int[ncoord]</span>
<a name="l00306"></a>00306 <span class="comment">* Status return value status for each vector element:</span>
<a name="l00307"></a>00307 <span class="comment">* 0: Success.</span>
<a name="l00308"></a>00308 <span class="comment">* 1: Invalid world coordinate.</span>
<a name="l00309"></a>00309 <span class="comment">*</span>
<a name="l00310"></a>00310 <span class="comment">* Function return value:</span>
<a name="l00311"></a>00311 <span class="comment">* int Status return value:</span>
<a name="l00312"></a>00312 <span class="comment">* 0: Success.</span>
<a name="l00313"></a>00313 <span class="comment">* 1: Null tabprm pointer passed.</span>
<a name="l00314"></a>00314 <span class="comment">* 3: Invalid tabular parameters.</span>
<a name="l00315"></a>00315 <span class="comment">* 5: One or more of the world coordinates were</span>
<a name="l00316"></a>00316 <span class="comment">* invalid, as indicated by the stat vector.</span>
<a name="l00317"></a>00317 <span class="comment">*</span>
<a name="l00318"></a>00318 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00319"></a>00319 <span class="comment">* tabprm::err if enabled, see wcserr_enable().</span>
<a name="l00320"></a>00320 <span class="comment">*</span>
<a name="l00321"></a>00321 <span class="comment">*</span>
<a name="l00322"></a>00322 <span class="comment">* tabprm struct - Tabular transformation parameters</span>
<a name="l00323"></a>00323 <span class="comment">* -------------------------------------------------</span>
<a name="l00324"></a>00324 <span class="comment">* The tabprm struct contains information required to transform tabular</span>
<a name="l00325"></a>00325 <span class="comment">* coordinates. It consists of certain members that must be set by the user</span>
<a name="l00326"></a>00326 <span class="comment">* ("given") and others that are set by the WCSLIB routines ("returned"). Some</span>
<a name="l00327"></a>00327 <span class="comment">* of the latter are supplied for informational purposes while others are for</span>
<a name="l00328"></a>00328 <span class="comment">* internal use only.</span>
<a name="l00329"></a>00329 <span class="comment">*</span>
<a name="l00330"></a>00330 <span class="comment">* int flag</span>
<a name="l00331"></a>00331 <span class="comment">* (Given and returned) This flag must be set to zero whenever any of the</span>
<a name="l00332"></a>00332 <span class="comment">* following tabprm structure members are set or changed:</span>
<a name="l00333"></a>00333 <span class="comment">*</span>
<a name="l00334"></a>00334 <span class="comment">* - tabprm::M (q.v., not normally set by the user),</span>
<a name="l00335"></a>00335 <span class="comment">* - tabprm::K (q.v., not normally set by the user),</span>
<a name="l00336"></a>00336 <span class="comment">* - tabprm::map,</span>
<a name="l00337"></a>00337 <span class="comment">* - tabprm::crval,</span>
<a name="l00338"></a>00338 <span class="comment">* - tabprm::index,</span>
<a name="l00339"></a>00339 <span class="comment">* - tabprm::coord.</span>
<a name="l00340"></a>00340 <span class="comment">*</span>
<a name="l00341"></a>00341 <span class="comment">* This signals the initialization routine, tabset(), to recompute the</span>
<a name="l00342"></a>00342 <span class="comment">* returned members of the tabprm struct. tabset() will reset flag to</span>
<a name="l00343"></a>00343 <span class="comment">* indicate that this has been done.</span>
<a name="l00344"></a>00344 <span class="comment">*</span>
<a name="l00345"></a>00345 <span class="comment">* PLEASE NOTE: flag should be set to -1 when tabini() is called for the</span>
<a name="l00346"></a>00346 <span class="comment">* first time for a particular tabprm struct in order to initialize memory</span>
<a name="l00347"></a>00347 <span class="comment">* management. It must ONLY be used on the first initialization otherwise</span>
<a name="l00348"></a>00348 <span class="comment">* memory leaks may result.</span>
<a name="l00349"></a>00349 <span class="comment">*</span>
<a name="l00350"></a>00350 <span class="comment">* int M</span>
<a name="l00351"></a>00351 <span class="comment">* (Given or returned) Number of tabular coordinate axes.</span>
<a name="l00352"></a>00352 <span class="comment">*</span>
<a name="l00353"></a>00353 <span class="comment">* If tabini() is used to initialize the linprm struct (as would normally</span>
<a name="l00354"></a>00354 <span class="comment">* be the case) then it will set M from the value passed to it as a</span>
<a name="l00355"></a>00355 <span class="comment">* function argument. The user should not subsequently modify it.</span>
<a name="l00356"></a>00356 <span class="comment">*</span>
<a name="l00357"></a>00357 <span class="comment">* int *K</span>
<a name="l00358"></a>00358 <span class="comment">* (Given or returned) Pointer to the first element of a vector of length</span>
<a name="l00359"></a>00359 <span class="comment">* tabprm::M whose elements (K_1, K_2,... K_M) record the lengths of the</span>
<a name="l00360"></a>00360 <span class="comment">* axes of the coordinate array and of each indexing vector.</span>
<a name="l00361"></a>00361 <span class="comment">*</span>
<a name="l00362"></a>00362 <span class="comment">* If tabini() is used to initialize the linprm struct (as would normally</span>
<a name="l00363"></a>00363 <span class="comment">* be the case) then it will set K from the array passed to it as a</span>
<a name="l00364"></a>00364 <span class="comment">* function argument. The user should not subsequently modify it.</span>
<a name="l00365"></a>00365 <span class="comment">*</span>
<a name="l00366"></a>00366 <span class="comment">* int *map</span>
<a name="l00367"></a>00367 <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M</span>
<a name="l00368"></a>00368 <span class="comment">* that defines the association between axis m in the M-dimensional</span>
<a name="l00369"></a>00369 <span class="comment">* coordinate array (1 <= m <= M) and the indices of the intermediate world</span>
<a name="l00370"></a>00370 <span class="comment">* coordinate and world coordinate arrays, x[] and world[], in the argument</span>
<a name="l00371"></a>00371 <span class="comment">* lists for tabx2s() and tabs2x().</span>
<a name="l00372"></a>00372 <span class="comment">*</span>
<a name="l00373"></a>00373 <span class="comment">* When x[] and world[] contain the full complement of coordinate elements</span>
<a name="l00374"></a>00374 <span class="comment">* in image-order, as will usually be the case, then map[m-1] == i-1 for</span>
<a name="l00375"></a>00375 <span class="comment">* axis i in the N-dimensional image (1 <= i <= N). In terms of the FITS</span>
<a name="l00376"></a>00376 <span class="comment">* keywords</span>
<a name="l00377"></a>00377 <span class="comment">*</span>
<a name="l00378"></a>00378 <span class="comment">* map[PVi_3a - 1] == i - 1.</span>
<a name="l00379"></a>00379 <span class="comment">*</span>
<a name="l00380"></a>00380 <span class="comment">* However, a different association may result if x[], for example, only</span>
<a name="l00381"></a>00381 <span class="comment">* contains a (relevant) subset of intermediate world coordinate elements.</span>
<a name="l00382"></a>00382 <span class="comment">* For example, if M == 1 for an image with N > 1, it is possible to fill</span>
<a name="l00383"></a>00383 <span class="comment">* x[] with the relevant coordinate element with nelem set to 1. In this</span>
<a name="l00384"></a>00384 <span class="comment">* case map[0] = 0 regardless of the value of i.</span>
<a name="l00385"></a>00385 <span class="comment">*</span>
<a name="l00386"></a>00386 <span class="comment">* double *crval</span>
<a name="l00387"></a>00387 <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M</span>
<a name="l00388"></a>00388 <span class="comment">* whose elements contain the index value for the reference pixel for each</span>
<a name="l00389"></a>00389 <span class="comment">* of the tabular coordinate axes.</span>
<a name="l00390"></a>00390 <span class="comment">*</span>
<a name="l00391"></a>00391 <span class="comment">* double **index</span>
<a name="l00392"></a>00392 <span class="comment">* (Given) Pointer to the first element of a vector of length tabprm::M of</span>
<a name="l00393"></a>00393 <span class="comment">* pointers to vectors of lengths (K_1, K_2,... K_M) of 0-relative indexes</span>
<a name="l00394"></a>00394 <span class="comment">* (see tabprm::K).</span>
<a name="l00395"></a>00395 <span class="comment">*</span>
<a name="l00396"></a>00396 <span class="comment">* The address of any or all of these index vectors may be set to zero,</span>
<a name="l00397"></a>00397 <span class="comment">* i.e.</span>
<a name="l00398"></a>00398 <span class="comment">*</span>
<a name="l00399"></a>00399 <span class="comment">= index[m] == 0;</span>
<a name="l00400"></a>00400 <span class="comment">*</span>
<a name="l00401"></a>00401 <span class="comment">* this is interpreted as default indexing, i.e.</span>
<a name="l00402"></a>00402 <span class="comment">*</span>
<a name="l00403"></a>00403 <span class="comment">= index[m][k] = k;</span>
<a name="l00404"></a>00404 <span class="comment">*</span>
<a name="l00405"></a>00405 <span class="comment">* double *coord</span>
<a name="l00406"></a>00406 <span class="comment">* (Given) Pointer to the first element of the tabular coordinate array,</span>
<a name="l00407"></a>00407 <span class="comment">* treated as though it were defined as</span>
<a name="l00408"></a>00408 <span class="comment">*</span>
<a name="l00409"></a>00409 <span class="comment">= double coord[K_M]...[K_2][K_1][M];</span>
<a name="l00410"></a>00410 <span class="comment">*</span>
<a name="l00411"></a>00411 <span class="comment">* (see tabprm::K) i.e. with the M dimension varying fastest so that the</span>
<a name="l00412"></a>00412 <span class="comment">* M elements of a coordinate vector are stored contiguously in memory.</span>
<a name="l00413"></a>00413 <span class="comment">*</span>
<a name="l00414"></a>00414 <span class="comment">* int nc</span>
<a name="l00415"></a>00415 <span class="comment">* (Returned) Total number of coordinate vectors in the coordinate array</span>
<a name="l00416"></a>00416 <span class="comment">* being the product K_1 * K_2 * ... * K_M (see tabprm::K).</span>
<a name="l00417"></a>00417 <span class="comment">*</span>
<a name="l00418"></a>00418 <span class="comment">* int padding</span>
<a name="l00419"></a>00419 <span class="comment">* (An unused variable inserted for alignment purposes only.)</span>
<a name="l00420"></a>00420 <span class="comment">*</span>
<a name="l00421"></a>00421 <span class="comment">* int *sense</span>
<a name="l00422"></a>00422 <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span>
<a name="l00423"></a>00423 <span class="comment">* whose elements indicate whether the corresponding indexing vector is</span>
<a name="l00424"></a>00424 <span class="comment">* monotonic increasing (+1), or decreasing (-1).</span>
<a name="l00425"></a>00425 <span class="comment">*</span>
<a name="l00426"></a>00426 <span class="comment">* int *p0</span>
<a name="l00427"></a>00427 <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span>
<a name="l00428"></a>00428 <span class="comment">* of interpolated indices into the coordinate array such that Upsilon_m,</span>
<a name="l00429"></a>00429 <span class="comment">* as defined in Paper III, is equal to (p0[m] + 1) + tabprm::delta[m].</span>
<a name="l00430"></a>00430 <span class="comment">*</span>
<a name="l00431"></a>00431 <span class="comment">* double *delta</span>
<a name="l00432"></a>00432 <span class="comment">* (Returned) Pointer to the first element of a vector of length tabprm::M</span>
<a name="l00433"></a>00433 <span class="comment">* of interpolated indices into the coordinate array such that Upsilon_m,</span>
<a name="l00434"></a>00434 <span class="comment">* as defined in Paper III, is equal to (tabprm::p0[m] + 1) + delta[m].</span>
<a name="l00435"></a>00435 <span class="comment">*</span>
<a name="l00436"></a>00436 <span class="comment">* double *extrema</span>
<a name="l00437"></a>00437 <span class="comment">* (Returned) Pointer to the first element of an array that records the</span>
<a name="l00438"></a>00438 <span class="comment">* minimum and maximum value of each element of the coordinate vector in</span>
<a name="l00439"></a>00439 <span class="comment">* each row of the coordinate array, treated as though it were defined as</span>
<a name="l00440"></a>00440 <span class="comment">*</span>
<a name="l00441"></a>00441 <span class="comment">= double extrema[K_M]...[K_2][2][M]</span>
<a name="l00442"></a>00442 <span class="comment">*</span>
<a name="l00443"></a>00443 <span class="comment">* (see tabprm::K). The minimum is recorded in the first element of the</span>
<a name="l00444"></a>00444 <span class="comment">* compressed K_1 dimension, then the maximum. This array is used by the</span>
<a name="l00445"></a>00445 <span class="comment">* inverse table lookup function, tabs2x(), to speed up table searches.</span>
<a name="l00446"></a>00446 <span class="comment">*</span>
<a name="l00447"></a>00447 <span class="comment">* struct wcserr *err</span>
<a name="l00448"></a>00448 <span class="comment">* (Returned) If enabled, when an error status is returned this struct</span>
<a name="l00449"></a>00449 <span class="comment">* contains detailed information about the error, see wcserr_enable().</span>
<a name="l00450"></a>00450 <span class="comment">*</span>
<a name="l00451"></a>00451 <span class="comment">* int m_flag</span>
<a name="l00452"></a>00452 <span class="comment">* (For internal use only.)</span>
<a name="l00453"></a>00453 <span class="comment">* int m_M</span>
<a name="l00454"></a>00454 <span class="comment">* (For internal use only.)</span>
<a name="l00455"></a>00455 <span class="comment">* int m_N</span>
<a name="l00456"></a>00456 <span class="comment">* (For internal use only.)</span>
<a name="l00457"></a>00457 <span class="comment">* int set_M</span>
<a name="l00458"></a>00458 <span class="comment">* (For internal use only.)</span>
<a name="l00459"></a>00459 <span class="comment">* int m_K</span>
<a name="l00460"></a>00460 <span class="comment">* (For internal use only.)</span>
<a name="l00461"></a>00461 <span class="comment">* int m_map</span>
<a name="l00462"></a>00462 <span class="comment">* (For internal use only.)</span>
<a name="l00463"></a>00463 <span class="comment">* int m_crval</span>
<a name="l00464"></a>00464 <span class="comment">* (For internal use only.)</span>
<a name="l00465"></a>00465 <span class="comment">* int m_index</span>
<a name="l00466"></a>00466 <span class="comment">* (For internal use only.)</span>
<a name="l00467"></a>00467 <span class="comment">* int m_indxs</span>
<a name="l00468"></a>00468 <span class="comment">* (For internal use only.)</span>
<a name="l00469"></a>00469 <span class="comment">* int m_coord</span>
<a name="l00470"></a>00470 <span class="comment">* (For internal use only.)</span>
<a name="l00471"></a>00471 <span class="comment">*</span>
<a name="l00472"></a>00472 <span class="comment">*</span>
<a name="l00473"></a>00473 <span class="comment">* Global variable: const char *tab_errmsg[] - Status return messages</span>
<a name="l00474"></a>00474 <span class="comment">* ------------------------------------------------------------------</span>
<a name="l00475"></a>00475 <span class="comment">* Error messages to match the status value returned from each function.</span>
<a name="l00476"></a>00476 <span class="comment">*</span>
<a name="l00477"></a>00477 <span class="comment">*===========================================================================*/</span>
<a name="l00478"></a>00478
<a name="l00479"></a>00479 <span class="preprocessor">#ifndef WCSLIB_TAB</span>
<a name="l00480"></a>00480 <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_TAB</span>
<a name="l00481"></a>00481 <span class="preprocessor"></span>
<a name="l00482"></a>00482 <span class="preprocessor">#include "<a class="code" href="wcserr_8h.html">wcserr.h</a>"</span>
<a name="l00483"></a>00483
<a name="l00484"></a>00484 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00485"></a>00485 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00486"></a>00486 <span class="preprocessor">#endif</span>
<a name="l00487"></a>00487 <span class="preprocessor"></span>
<a name="l00488"></a>00488
<a name="l00489"></a>00489 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a>[];
<a name="l00490"></a>00490
<a name="l00491"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed">00491</a> <span class="keyword">enum</span> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed">tab_errmsg_enum</a> {
<a name="l00492"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed42a664a8df3b0a485f49eb0e7c8108cd">00492</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed42a664a8df3b0a485f49eb0e7c8108cd">TABERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span>
<a name="l00493"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2eda0705873598b9fa5bf3b9afbc598a6bc">00493</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2eda0705873598b9fa5bf3b9afbc598a6bc">TABERR_NULL_POINTER</a> = 1, <span class="comment">/* Null tabprm pointer passed. */</span>
<a name="l00494"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed1e503c059ddfe8f4aca37d335f7271f8">00494</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed1e503c059ddfe8f4aca37d335f7271f8">TABERR_MEMORY</a> = 2, <span class="comment">/* Memory allocation failed. */</span>
<a name="l00495"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed09c02b9ffff721d3f2dd64c318d7c38b">00495</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed09c02b9ffff721d3f2dd64c318d7c38b">TABERR_BAD_PARAMS</a> = 3, <span class="comment">/* Invalid tabular parameters. */</span>
<a name="l00496"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2edc6f6b4c9eca2bd36b0bf2f89309f9297">00496</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2edc6f6b4c9eca2bd36b0bf2f89309f9297">TABERR_BAD_X</a> = 4, <span class="comment">/* One or more of the x coordinates were</span>
<a name="l00497"></a>00497 <span class="comment"> invalid. */</span>
<a name="l00498"></a><a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed9d77712eeed3ab7d2bf25e5251c9451b">00498</a> <a class="code" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed9d77712eeed3ab7d2bf25e5251c9451b">TABERR_BAD_WORLD</a> = 5 <span class="comment">/* One or more of the world coordinates were</span>
<a name="l00499"></a>00499 <span class="comment"> invalid. */</span>
<a name="l00500"></a>00500 };
<a name="l00501"></a>00501
<a name="l00502"></a><a class="code" href="structtabprm.html">00502</a> <span class="keyword">struct </span><a class="code" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> {
<a name="l00503"></a>00503 <span class="comment">/* Initialization flag (see the prologue above). */</span>
<a name="l00504"></a>00504 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l00505"></a><a class="code" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">00505</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">flag</a>; <span class="comment">/* Set to zero to force initialization. */</span>
<a name="l00506"></a>00506
<a name="l00507"></a>00507 <span class="comment">/* Parameters to be provided (see the prologue above). */</span>
<a name="l00508"></a>00508 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l00509"></a><a class="code" href="structtabprm.html#64b8a2eaba4116cc647a435108269be3">00509</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#64b8a2eaba4116cc647a435108269be3">M</a>; <span class="comment">/* Number of tabular coordinate axes. */</span>
<a name="l00510"></a><a class="code" href="structtabprm.html#f00d4a4e089737a799fb91e1a68040dc">00510</a> <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#f00d4a4e089737a799fb91e1a68040dc">K</a>; <span class="comment">/* Vector of length M whose elements */</span>
<a name="l00511"></a>00511 <span class="comment">/* (K_1, K_2,... K_M) record the lengths of */</span>
<a name="l00512"></a>00512 <span class="comment">/* the axes of the coordinate array and of */</span>
<a name="l00513"></a>00513 <span class="comment">/* each indexing vector. */</span>
<a name="l00514"></a><a class="code" href="structtabprm.html#29505cdf78fb12ca5951295fc16f4819">00514</a> <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#29505cdf78fb12ca5951295fc16f4819">map</a>; <span class="comment">/* Vector of length M usually such that */</span>
<a name="l00515"></a>00515 <span class="comment">/* map[m-1] == i-1 for coordinate array */</span>
<a name="l00516"></a>00516 <span class="comment">/* axis m and image axis i (see above). */</span>
<a name="l00517"></a><a class="code" href="structtabprm.html#1ef3d0af652bb59fb838a6b01bb133e2">00517</a> <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#1ef3d0af652bb59fb838a6b01bb133e2">crval</a>; <span class="comment">/* Vector of length M containing the index */</span>
<a name="l00518"></a>00518 <span class="comment">/* value for the reference pixel for each */</span>
<a name="l00519"></a>00519 <span class="comment">/* of the tabular coordinate axes. */</span>
<a name="l00520"></a><a class="code" href="structtabprm.html#fa6969fd752bb4e3823e8facf86bbd60">00520</a> <span class="keywordtype">double</span> **<a class="code" href="structtabprm.html#fa6969fd752bb4e3823e8facf86bbd60">index</a>; <span class="comment">/* Vector of pointers to M indexing vectors */</span>
<a name="l00521"></a>00521 <span class="comment">/* of lengths (K_1, K_2,... K_M). */</span>
<a name="l00522"></a><a class="code" href="structtabprm.html#cee8b63d1691f1f531a1bb4854c6bf4c">00522</a> <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#cee8b63d1691f1f531a1bb4854c6bf4c">coord</a>; <span class="comment">/* (1+M)-dimensional tabular coordinate */</span>
<a name="l00523"></a>00523 <span class="comment">/* array (see above). */</span>
<a name="l00524"></a>00524
<a name="l00525"></a>00525 <span class="comment">/* Information derived from the parameters supplied. */</span>
<a name="l00526"></a>00526 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l00527"></a><a class="code" href="structtabprm.html#4263d73c71a9a5e77643f572c483b7ab">00527</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#4263d73c71a9a5e77643f572c483b7ab">nc</a>; <span class="comment">/* Number of coordinate vectors (of length */</span>
<a name="l00528"></a>00528 <span class="comment">/* M) in the coordinate array. */</span>
<a name="l00529"></a><a class="code" href="structtabprm.html#0777c3de4601874221031a8ad37eff95">00529</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#0777c3de4601874221031a8ad37eff95">padding</a>; <span class="comment">/* (Dummy inserted for alignment purposes.) */</span>
<a name="l00530"></a><a class="code" href="structtabprm.html#dc7e170dba47f4e6d40afabfdaecfddd">00530</a> <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#dc7e170dba47f4e6d40afabfdaecfddd">sense</a>; <span class="comment">/* Vector of M flags that indicate whether */</span>
<a name="l00531"></a>00531 <span class="comment">/* the Mth indexing vector is monotonic */</span>
<a name="l00532"></a>00532 <span class="comment">/* increasing, or else decreasing. */</span>
<a name="l00533"></a><a class="code" href="structtabprm.html#48cbe51ee26f0615036308fe72768403">00533</a> <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#48cbe51ee26f0615036308fe72768403">p0</a>; <span class="comment">/* Vector of M indices. */</span>
<a name="l00534"></a><a class="code" href="structtabprm.html#77130658a6e330e0edba348d1dc7edf2">00534</a> <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#77130658a6e330e0edba348d1dc7edf2">delta</a>; <span class="comment">/* Vector of M increments. */</span>
<a name="l00535"></a><a class="code" href="structtabprm.html#ade738f7269d71d34fdf3d52f1c61d88">00535</a> <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#ade738f7269d71d34fdf3d52f1c61d88">extrema</a>; <span class="comment">/* (1+M)-dimensional array of coordinate */</span>
<a name="l00536"></a>00536 <span class="comment">/* extrema. */</span>
<a name="l00537"></a>00537
<a name="l00538"></a>00538 <span class="comment">/* Error handling */</span>
<a name="l00539"></a>00539 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l00540"></a><a class="code" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">00540</a> <span class="keyword">struct </span><a class="code" href="structwcserr.html" title="Error message handling.">wcserr</a> *<a class="code" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">err</a>;
<a name="l00541"></a>00541
<a name="l00542"></a>00542 <span class="comment">/* Private - the remainder are for memory management. */</span>
<a name="l00543"></a>00543 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l00544"></a><a class="code" href="structtabprm.html#36adcba673ae8ede86b80f7e5111e0ec">00544</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#8572ca79676edfe06b3d1df00f93384b">m_flag</a>, <a class="code" href="structtabprm.html#e19ca756ab2190f5d5ced59ad0a1a4bc">m_M</a>, <a class="code" href="structtabprm.html#36adcba673ae8ede86b80f7e5111e0ec">m_N</a>;
<a name="l00545"></a><a class="code" href="structtabprm.html#71057a73168d71019b0caaa203fe5a05">00545</a> <span class="keywordtype">int</span> <a class="code" href="structtabprm.html#71057a73168d71019b0caaa203fe5a05">set_M</a>;
<a name="l00546"></a><a class="code" href="structtabprm.html#9d2c36c4cfb17532ba5f08cbd90a5785">00546</a> <span class="keywordtype">int</span> *<a class="code" href="structtabprm.html#5c62c8fd3dc6e9a3c928be9a1ed81ca1">m_K</a>, *<a class="code" href="structtabprm.html#9d2c36c4cfb17532ba5f08cbd90a5785">m_map</a>;
<a name="l00547"></a><a class="code" href="structtabprm.html#43276034ba8e0954a6e2632117cd0afd">00547</a> <span class="keywordtype">double</span> *<a class="code" href="structtabprm.html#bf7f932bcefad1f0e371167971018965">m_crval</a>, **<a class="code" href="structtabprm.html#1ce970a854c9976d8b3e4e26df102b3b">m_index</a>, **<a class="code" href="structtabprm.html#43276034ba8e0954a6e2632117cd0afd">m_indxs</a>, *<a class="code" href="structtabprm.html#c05f0ad36debbabf441ca8d8aac59a96">m_coord</a>;
<a name="l00548"></a>00548 };
<a name="l00549"></a>00549
<a name="l00550"></a>00550 <span class="comment">/* Size of the tabprm struct in int units, used by the Fortran wrappers. */</span>
<a name="l00551"></a><a class="code" href="tab_8h.html#9c80120944556169d230d4cd051d88cb">00551</a> <span class="preprocessor">#define TABLEN (sizeof(struct tabprm)/sizeof(int))</span>
<a name="l00552"></a>00552 <span class="preprocessor"></span>
<a name="l00553"></a>00553
<a name="l00554"></a>00554 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" 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);
<a name="l00555"></a>00555
<a name="l00556"></a>00556 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#e403ff0b740916989c7386728df001c8" title="Acquire tabular memory.">tabmem</a>(<span class="keyword">struct</span> <a class="code" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> *tab);
<a name="l00557"></a>00557
<a name="l00558"></a>00558 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#87b3a2a84bab396a528af8382ce9ad04" 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);
<a name="l00559"></a>00559
<a name="l00560"></a>00560 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#0f3501cc592c78e0f2cb9922466589f2" 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);
<a name="l00561"></a>00561
<a name="l00562"></a>00562 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#6b3768349e9a5e925aab24effddc584f" 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);
<a name="l00563"></a>00563
<a name="l00564"></a>00564 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f" 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);
<a name="l00565"></a>00565
<a name="l00566"></a>00566 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#006d6e8cb373e0dc3e9ccf128adb9411" 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[],
<a name="l00567"></a>00567 <span class="keywordtype">double</span> world[], <span class="keywordtype">int</span> stat[]);
<a name="l00568"></a>00568
<a name="l00569"></a>00569 <span class="keywordtype">int</span> <a class="code" href="tab_8h.html#aded7db92aa2758198b33f35f5f18d6e" 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[],
<a name="l00570"></a>00570 <span class="keywordtype">double</span> x[], <span class="keywordtype">int</span> stat[]);
<a name="l00571"></a>00571
<a name="l00572"></a>00572
<a name="l00573"></a>00573 <span class="comment">/* Deprecated. */</span>
<a name="l00574"></a><a class="code" href="tab_8h.html#8b57d9bacbabd2b516d77220cdb6167d">00574</a> <span class="preprocessor">#define tabini_errmsg tab_errmsg</span>
<a name="l00575"></a><a class="code" href="tab_8h.html#27460f165fb03a075a1c6c6a48f33c62">00575</a> <span class="preprocessor"></span><span class="preprocessor">#define tabcpy_errmsg tab_errmsg</span>
<a name="l00576"></a><a class="code" href="tab_8h.html#bf96fe5488df6796ec2606b974f330fe">00576</a> <span class="preprocessor"></span><span class="preprocessor">#define tabfree_errmsg tab_errmsg</span>
<a name="l00577"></a><a class="code" href="tab_8h.html#e2ee098afabb7a7d225f930276ffb441">00577</a> <span class="preprocessor"></span><span class="preprocessor">#define tabprt_errmsg tab_errmsg</span>
<a name="l00578"></a><a class="code" href="tab_8h.html#4abf39ca4cfc2ea073bffdbb98caa46d">00578</a> <span class="preprocessor"></span><span class="preprocessor">#define tabset_errmsg tab_errmsg</span>
<a name="l00579"></a><a class="code" href="tab_8h.html#141c3365f0364c01237aeeb93ddb717e">00579</a> <span class="preprocessor"></span><span class="preprocessor">#define tabx2s_errmsg tab_errmsg</span>
<a name="l00580"></a><a class="code" href="tab_8h.html#49872082d67e357c5c68a633824133ae">00580</a> <span class="preprocessor"></span><span class="preprocessor">#define tabs2x_errmsg tab_errmsg</span>
<a name="l00581"></a>00581 <span class="preprocessor"></span>
<a name="l00582"></a>00582 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00583"></a>00583 <span class="preprocessor"></span>}
<a name="l00584"></a>00584 <span class="preprocessor">#endif</span>
<a name="l00585"></a>00585 <span class="preprocessor"></span>
<a name="l00586"></a>00586 <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_TAB */</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>
|
