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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
|
<!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 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>tab.h File Reference</h1><code>#include "<a class="el" href="wcserr_8h-source.html">wcserr.h</a>"</code><br>
<p>
<a href="tab_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>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structtabprm.html">tabprm</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tabular transformation parameters. <a href="structtabprm.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#9c80120944556169d230d4cd051d88cb">TABLEN</a> (sizeof(struct <a class="el" href="structtabprm.html">tabprm</a>)/sizeof(int))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct in <em>int</em> units. <a href="#9c80120944556169d230d4cd051d88cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#8b57d9bacbabd2b516d77220cdb6167d">tabini_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#8b57d9bacbabd2b516d77220cdb6167d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#27460f165fb03a075a1c6c6a48f33c62">tabcpy_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#27460f165fb03a075a1c6c6a48f33c62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#bf96fe5488df6796ec2606b974f330fe">tabfree_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#bf96fe5488df6796ec2606b974f330fe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#e2ee098afabb7a7d225f930276ffb441">tabprt_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#e2ee098afabb7a7d225f930276ffb441"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#4abf39ca4cfc2ea073bffdbb98caa46d">tabset_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#4abf39ca4cfc2ea073bffdbb98caa46d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#141c3365f0364c01237aeeb93ddb717e">tabx2s_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#141c3365f0364c01237aeeb93ddb717e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#49872082d67e357c5c68a633824133ae">tabs2x_errmsg</a> <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#49872082d67e357c5c68a633824133ae"></a><br></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="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed">tab_errmsg_enum</a> { <br>
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed42a664a8df3b0a485f49eb0e7c8108cd">TABERR_SUCCESS</a> = 0,
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2eda0705873598b9fa5bf3b9afbc598a6bc">TABERR_NULL_POINTER</a> = 1,
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed1e503c059ddfe8f4aca37d335f7271f8">TABERR_MEMORY</a> = 2,
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed09c02b9ffff721d3f2dd64c318d7c38b">TABERR_BAD_PARAMS</a> = 3,
<br>
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2edc6f6b4c9eca2bd36b0bf2f89309f9297">TABERR_BAD_X</a> = 4,
<a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed9d77712eeed3ab7d2bf25e5251c9451b">TABERR_BAD_WORLD</a> = 5
<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="tab_8h.html#bb7920acdfb83179d3bac65035144c02">tabini</a> (int alloc, int M, const int K[], struct <a class="el" href="structtabprm.html">tabprm</a> *tab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <a href="#bb7920acdfb83179d3bac65035144c02"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#e403ff0b740916989c7386728df001c8">tabmem</a> (struct <a class="el" href="structtabprm.html">tabprm</a> *tab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire tabular memory. <a href="#e403ff0b740916989c7386728df001c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#87b3a2a84bab396a528af8382ce9ad04">tabcpy</a> (int alloc, const struct <a class="el" href="structtabprm.html">tabprm</a> *tabsrc, struct <a class="el" href="structtabprm.html">tabprm</a> *tabdst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy routine for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <a href="#87b3a2a84bab396a528af8382ce9ad04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#0f3501cc592c78e0f2cb9922466589f2">tabfree</a> (struct <a class="el" href="structtabprm.html">tabprm</a> *tab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <a href="#0f3501cc592c78e0f2cb9922466589f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#6b3768349e9a5e925aab24effddc584f">tabprt</a> (const struct <a class="el" href="structtabprm.html">tabprm</a> *tab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print routine for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <a href="#6b3768349e9a5e925aab24effddc584f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f">tabset</a> (struct <a class="el" href="structtabprm.html">tabprm</a> *tab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setup routine for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <a href="#519e8e4503f7c41c0f99e8597171c97f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#006d6e8cb373e0dc3e9ccf128adb9411">tabx2s</a> (struct <a class="el" href="structtabprm.html">tabprm</a> *tab, int ncoord, int nelem, const double x[], double world[], int stat[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pixel-to-world transformation. <a href="#006d6e8cb373e0dc3e9ccf128adb9411"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="tab_8h.html#aded7db92aa2758198b33f35f5f18d6e">tabs2x</a> (struct <a class="el" href="structtabprm.html">tabprm</a> *tab, int ncoord, int nelem, const double world[], double x[], int stat[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">World-to-pixel transformation. <a href="#aded7db92aa2758198b33f35f5f18d6e"></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="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> []</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Status return messages. <a href="#824d1e7c8fea5e5918a8555df39aa5b7"></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 tabular coordinates, i.e. coordinates that are defined via a lookup table. They define methods to be used for computing tabular world coordinates from intermediate world coordinates (a linear transformation of image pixel coordinates), and vice versa. They are based on the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct which contains all information needed for the computations. The struct contains some members that must be set by the user, and others that are maintained by these routines, somewhat like a C++ class but with no encapsulation.<p>
<a class="el" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct.">tabini()</a>, <a class="el" href="tab_8h.html#e403ff0b740916989c7386728df001c8" title="Acquire tabular memory.">tabmem()</a>, <a class="el" href="tab_8h.html#87b3a2a84bab396a528af8382ce9ad04" title="Copy routine for the tabprm struct.">tabcpy()</a>, and <a class="el" href="tab_8h.html#0f3501cc592c78e0f2cb9922466589f2" title="Destructor for the tabprm struct.">tabfree()</a> are provided to manage the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct, and another, <a class="el" href="tab_8h.html#6b3768349e9a5e925aab24effddc584f" title="Print routine for the tabprm struct.">tabprt()</a>, to print its contents.<p>
A setup routine, <a class="el" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f" title="Setup routine for the tabprm struct.">tabset()</a>, computes intermediate values in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct from parameters in it that were supplied by the user. The struct always needs to be set up by <a class="el" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f" title="Setup routine for the tabprm struct.">tabset()</a> but it need not be called explicitly - refer to the explanation of <a class="el" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">tabprm::flag</a>.<p>
<a class="el" href="tab_8h.html#006d6e8cb373e0dc3e9ccf128adb9411" title="Pixel-to-world transformation.">tabx2s()</a> and <a class="el" href="tab_8h.html#aded7db92aa2758198b33f35f5f18d6e" title="World-to-pixel transformation.">tabs2x()</a> implement the WCS tabular coordinate transformations.<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 ttab.c which accompanies this software. <hr><h2>Define Documentation</h2>
<a class="anchor" name="9c80120944556169d230d4cd051d88cb"></a><!-- doxytag: member="tab.h::TABLEN" ref="9c80120944556169d230d4cd051d88cb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TABLEN (sizeof(struct <a class="el" href="structtabprm.html">tabprm</a>)/sizeof(int)) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Size of the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct in <em>int</em> units, used by the Fortran wrappers.
</div>
</div><p>
<a class="anchor" name="8b57d9bacbabd2b516d77220cdb6167d"></a><!-- doxytag: member="tab.h::tabini_errmsg" ref="8b57d9bacbabd2b516d77220cdb6167d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabini_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000024">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="27460f165fb03a075a1c6c6a48f33c62"></a><!-- doxytag: member="tab.h::tabcpy_errmsg" ref="27460f165fb03a075a1c6c6a48f33c62" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabcpy_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000025">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="bf96fe5488df6796ec2606b974f330fe"></a><!-- doxytag: member="tab.h::tabfree_errmsg" ref="bf96fe5488df6796ec2606b974f330fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabfree_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000026">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e2ee098afabb7a7d225f930276ffb441"></a><!-- doxytag: member="tab.h::tabprt_errmsg" ref="e2ee098afabb7a7d225f930276ffb441" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabprt_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000027">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4abf39ca4cfc2ea073bffdbb98caa46d"></a><!-- doxytag: member="tab.h::tabset_errmsg" ref="4abf39ca4cfc2ea073bffdbb98caa46d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabset_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000028">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="141c3365f0364c01237aeeb93ddb717e"></a><!-- doxytag: member="tab.h::tabx2s_errmsg" ref="141c3365f0364c01237aeeb93ddb717e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabx2s_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000029">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="49872082d67e357c5c68a633824133ae"></a><!-- doxytag: member="tab.h::tabs2x_errmsg" ref="49872082d67e357c5c68a633824133ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define tabs2x_errmsg <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_errmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000030">Deprecated:</a></b></dt><dd>Added for backwards compatibility, use <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7" title="Status return messages.">tab_errmsg</a> directly now instead. </dd></dl>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2ed"></a><!-- doxytag: member="tab.h::tab_errmsg_enum" ref="bd68f3b717dcf0fcd0078b9a4204f2ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="tab_8h.html#bd68f3b717dcf0fcd0078b9a4204f2ed">tab_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="bd68f3b717dcf0fcd0078b9a4204f2ed42a664a8df3b0a485f49eb0e7c8108cd"></a><!-- doxytag: member="TABERR_SUCCESS" ref="bd68f3b717dcf0fcd0078b9a4204f2ed42a664a8df3b0a485f49eb0e7c8108cd" args="" -->TABERR_SUCCESS</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2eda0705873598b9fa5bf3b9afbc598a6bc"></a><!-- doxytag: member="TABERR_NULL_POINTER" ref="bd68f3b717dcf0fcd0078b9a4204f2eda0705873598b9fa5bf3b9afbc598a6bc" args="" -->TABERR_NULL_POINTER</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2ed1e503c059ddfe8f4aca37d335f7271f8"></a><!-- doxytag: member="TABERR_MEMORY" ref="bd68f3b717dcf0fcd0078b9a4204f2ed1e503c059ddfe8f4aca37d335f7271f8" args="" -->TABERR_MEMORY</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2ed09c02b9ffff721d3f2dd64c318d7c38b"></a><!-- doxytag: member="TABERR_BAD_PARAMS" ref="bd68f3b717dcf0fcd0078b9a4204f2ed09c02b9ffff721d3f2dd64c318d7c38b" args="" -->TABERR_BAD_PARAMS</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2edc6f6b4c9eca2bd36b0bf2f89309f9297"></a><!-- doxytag: member="TABERR_BAD_X" ref="bd68f3b717dcf0fcd0078b9a4204f2edc6f6b4c9eca2bd36b0bf2f89309f9297" args="" -->TABERR_BAD_X</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="bd68f3b717dcf0fcd0078b9a4204f2ed9d77712eeed3ab7d2bf25e5251c9451b"></a><!-- doxytag: member="TABERR_BAD_WORLD" ref="bd68f3b717dcf0fcd0078b9a4204f2ed9d77712eeed3ab7d2bf25e5251c9451b" args="" -->TABERR_BAD_WORLD</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="bb7920acdfb83179d3bac65035144c02"></a><!-- doxytag: member="tab.h::tabini" ref="bb7920acdfb83179d3bac65035144c02" args="(int alloc, int M, const int K[], struct tabprm *tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabini </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>alloc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>M</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>K</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabini</b>() allocates memory for arrays in a <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct and sets all members of the struct to default values.<p>
<b>PLEASE NOTE:</b> every <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct should be initialized by <b>tabini</b>(), possibly repeatedly. On the first invokation, and only the first invokation, the flag member of the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct must be set to -1 to initialize memory management, regardless of whether <b>tabini</b>() will actually be used to allocate memory.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>alloc</em> </td><td>If true, allocate memory unconditionally for arrays in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <br>
If false, it is assumed that pointers to these arrays have been set by the user except if they are null pointers in which case memory will be allocated for them regardless. (In other words, setting alloc true saves having to initalize these pointers to zero.) </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>M</em> </td><td>The number of tabular coordinate axes. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>K</em> </td><td>Vector of length M whose elements <img class="formulaInl" alt="$(K_1, K_2,... K_M)$" src="form_59.png"> record the lengths of the axes of the coordinate array and of each indexing vector. M and K[] are used to determine the length of the various <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> arrays and therefore the amount of memory to allocate for them. Their values are copied into the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <br>
It is permissible to set K (i.e. the address of the array) to zero which has the same effect as setting each element of K[] to zero. In this case no memory will be allocated for the index vectors or coordinate array in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. These together with the K vector must be set separately before calling <a class="el" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f" title="Setup routine for the tabprm struct.">tabset()</a>.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>tab</em> </td><td>Tabular transformation parameters. Note that, in order to initialize memory management <a class="el" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">tabprm::flag</a> should be set to -1 when tab is initialized for the first time (memory leaks may result if it had already been initialized).</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>2: Memory allocation failed.</li><li>3: Invalid tabular parameters.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e403ff0b740916989c7386728df001c8"></a><!-- doxytag: member="tab.h::tabmem" ref="e403ff0b740916989c7386728df001c8" args="(struct tabprm *tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabmem </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabmem</b>() takes control of memory allocated by the user for arrays in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct.<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>tab</em> </td><td>Tabular transformation parameters.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>2: Memory allocation failed.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="87b3a2a84bab396a528af8382ce9ad04"></a><!-- doxytag: member="tab.h::tabcpy" ref="87b3a2a84bab396a528af8382ce9ad04" args="(int alloc, const struct tabprm *tabsrc, struct tabprm *tabdst)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabcpy </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>alloc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tabsrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tabdst</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabcpy</b>() does a deep copy of one <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct to another, using <a class="el" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct.">tabini()</a> to allocate memory for its arrays if required. Only the "information to be provided" part of the struct is copied; a call to <a class="el" href="tab_8h.html#519e8e4503f7c41c0f99e8597171c97f" title="Setup routine for the tabprm struct.">tabset()</a> is required to set up the remainder.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>alloc</em> </td><td>If true, allocate memory unconditionally for arrays in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct. <br>
If false, it is assumed that pointers to these arrays have been set by the user except if they are null pointers in which case memory will be allocated for them regardless. (In other words, setting alloc true saves having to initalize these pointers to zero.) </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tabsrc</em> </td><td>Struct to copy from.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>tabdst</em> </td><td>Struct to copy to. <a class="el" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">tabprm::flag</a> should be set to -1 if tabdst was not previously initialized (memory leaks may result if it was previously initialized).</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>2: Memory allocation failed.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> (associated with tabdst) if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0f3501cc592c78e0f2cb9922466589f2"></a><!-- doxytag: member="tab.h::tabfree" ref="0f3501cc592c78e0f2cb9922466589f2" args="(struct tabprm *tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabfree </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabfree</b>() frees memory allocated for the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> arrays by <a class="el" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct.">tabini()</a>. <a class="el" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct.">tabini()</a> records the memory it allocates and <b>tabfree</b>() will only attempt to free this.<p>
<b>PLEASE NOTE:</b> <b>tabfree</b>() must not be invoked on a <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct that was not initialized by <a class="el" href="tab_8h.html#bb7920acdfb83179d3bac65035144c02" title="Default constructor for the tabprm struct.">tabini()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>tab</em> </td><td>Coordinate transformation parameters.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="6b3768349e9a5e925aab24effddc584f"></a><!-- doxytag: member="tab.h::tabprt" ref="6b3768349e9a5e925aab24effddc584f" args="(const struct tabprm *tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabprt </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabprt</b>() prints the contents of a <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct using <a class="el" href="wcsprintf_8h.html#46950abaf5a27347da8160741f98f973" title="Print function used by WCSLIB diagnostic routines.">wcsprintf()</a>. Mainly intended for diagnostic purposes.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tab</em> </td><td>Tabular transformation parameters.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="519e8e4503f7c41c0f99e8597171c97f"></a><!-- doxytag: member="tab.h::tabset" ref="519e8e4503f7c41c0f99e8597171c97f" args="(struct tabprm *tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabset </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>tabset</b>() allocates memory for work arrays in the <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> struct and sets up the struct according to information supplied within it.<p>
Note that this routine need not be called directly; it will be invoked by <a class="el" href="tab_8h.html#006d6e8cb373e0dc3e9ccf128adb9411" title="Pixel-to-world transformation.">tabx2s()</a> and <a class="el" href="tab_8h.html#aded7db92aa2758198b33f35f5f18d6e" title="World-to-pixel transformation.">tabs2x()</a> if <a class="el" href="structtabprm.html#27a7b0b12492e1b5f19242ec0eff8e08">tabprm::flag</a> is anything other than a predefined magic value.<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>tab</em> </td><td>Tabular transformation parameters.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Success.</li><li>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>3: Invalid tabular parameters.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="006d6e8cb373e0dc3e9ccf128adb9411"></a><!-- doxytag: member="tab.h::tabx2s" ref="006d6e8cb373e0dc3e9ccf128adb9411" args="(struct tabprm *tab, int ncoord, int nelem, const double x[], double world[], int stat[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabx2s </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ncoord</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</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>world</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>tabx2s</b>() transforms intermediate world coordinates to world coordinates using coordinate lookup.<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>tab</em> </td><td>Tabular transformation parameters.</td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ncoord,nelem</em> </td><td>The number of coordinates, each of vector length nelem. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>x</em> </td><td>Array of intermediate world coordinates, SI units.</td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>world</em> </td><td>Array of 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 coordinate:<ul>
<li>0: Success.</li><li>1: Invalid intermediate world coordinate.</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>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>3: Invalid tabular parameters.</li><li>4: One or more of the x coordinates were invalid, as indicated by the stat vector.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="aded7db92aa2758198b33f35f5f18d6e"></a><!-- doxytag: member="tab.h::tabs2x" ref="aded7db92aa2758198b33f35f5f18d6e" args="(struct tabprm *tab, int ncoord, int nelem, const double world[], double x[], int stat[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tabs2x </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structtabprm.html">tabprm</a> * </td>
<td class="paramname"> <em>tab</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ncoord</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double </td>
<td class="paramname"> <em>world</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>tabs2x</b>() transforms 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>tab</em> </td><td>Tabular transformation parameters.</td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ncoord,nelem</em> </td><td>The number of coordinates, each of vector length nelem. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>world</em> </td><td>Array of world coordinates, in SI units.</td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>x</em> </td><td>Array of intermediate world coordinates, 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 world coordinate.</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>1: Null <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> pointer passed.</li><li>3: Invalid tabular parameters.</li><li>5: One or more of the world coordinates were invalid, as indicated by the stat vector.</li></ul>
For returns > 1, a detailed error message is set in <a class="el" href="structtabprm.html#3df12930fa5f38dcfc71aece8aed816c">tabprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </dd></dl>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="824d1e7c8fea5e5918a8555df39aa5b7"></a><!-- doxytag: member="tab.h::tab_errmsg" ref="824d1e7c8fea5e5918a8555df39aa5b7" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * <a class="el" href="tab_8h.html#824d1e7c8fea5e5918a8555df39aa5b7">tab_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>
|
