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
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
|
<!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: wcshdr.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>wcshdr.h</h1><a href="wcshdr_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: wcshdr.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 the FITS World Coordinate System</span>
<a name="l00035"></a>00035 <span class="comment">* (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 celestial coordinates in FITS",</span>
<a name="l00041"></a>00041 <span class="comment">* Calabretta, M.R., & Greisen, E.W. 2002, A&A, 395, 1077 (Paper II)</span>
<a name="l00042"></a>00042 <span class="comment">*</span>
<a name="l00043"></a>00043 <span class="comment">* "Representations of spectral coordinates in FITS",</span>
<a name="l00044"></a>00044 <span class="comment">* Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L.</span>
<a name="l00045"></a>00045 <span class="comment">* 2006, A&A, 446, 747 (Paper III)</span>
<a name="l00046"></a>00046 <span class="comment">*</span>
<a name="l00047"></a>00047 <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span>
<a name="l00048"></a>00048 <span class="comment">* library.</span>
<a name="l00049"></a>00049 <span class="comment">*</span>
<a name="l00050"></a>00050 <span class="comment">*</span>
<a name="l00051"></a>00051 <span class="comment">* Summary of the wcshdr routines</span>
<a name="l00052"></a>00052 <span class="comment">* ------------------------------</span>
<a name="l00053"></a>00053 <span class="comment">* Routines in this suite are aimed at extracting WCS information from a FITS</span>
<a name="l00054"></a>00054 <span class="comment">* file. They provide the high-level interface between the FITS file and the</span>
<a name="l00055"></a>00055 <span class="comment">* WCS coordinate transformation routines.</span>
<a name="l00056"></a>00056 <span class="comment">*</span>
<a name="l00057"></a>00057 <span class="comment">* Additionally, function wcshdo() is provided to write out the contents of a</span>
<a name="l00058"></a>00058 <span class="comment">* wcsprm struct as a FITS header.</span>
<a name="l00059"></a>00059 <span class="comment">*</span>
<a name="l00060"></a>00060 <span class="comment">* Briefly, the anticipated sequence of operations is as follows:</span>
<a name="l00061"></a>00061 <span class="comment">*</span>
<a name="l00062"></a>00062 <span class="comment">* - 1: Open the FITS file and read the image or binary table header, e.g.</span>
<a name="l00063"></a>00063 <span class="comment">* using CFITSIO routine fits_hdr2str().</span>
<a name="l00064"></a>00064 <span class="comment">*</span>
<a name="l00065"></a>00065 <span class="comment">* - 2: Parse the header using wcspih() or wcsbth(); they will automatically</span>
<a name="l00066"></a>00066 <span class="comment">* interpret 'TAB' header keywords using wcstab().</span>
<a name="l00067"></a>00067 <span class="comment">*</span>
<a name="l00068"></a>00068 <span class="comment">* - 3: Allocate memory for, and read 'TAB' arrays from the binary table</span>
<a name="l00069"></a>00069 <span class="comment">* extension, e.g. using CFITSIO routine fits_read_wcstab() - refer to</span>
<a name="l00070"></a>00070 <span class="comment">* the prologue of getwcstab.h. wcsset() will automatically take</span>
<a name="l00071"></a>00071 <span class="comment">* control of this allocated memory, in particular causing it to be</span>
<a name="l00072"></a>00072 <span class="comment">* free'd by wcsfree().</span>
<a name="l00073"></a>00073 <span class="comment">*</span>
<a name="l00074"></a>00074 <span class="comment">* - 4: Translate non-standard WCS usage using wcsfix(), see wcsfix.h.</span>
<a name="l00075"></a>00075 <span class="comment">*</span>
<a name="l00076"></a>00076 <span class="comment">* - 5: Initialize wcsprm struct(s) using wcsset() and calculate coordinates</span>
<a name="l00077"></a>00077 <span class="comment">* using wcsp2s() and/or wcss2p(). Refer to the prologue of wcs.h for a</span>
<a name="l00078"></a>00078 <span class="comment">* description of these and other high-level WCS coordinate</span>
<a name="l00079"></a>00079 <span class="comment">* transformation routines.</span>
<a name="l00080"></a>00080 <span class="comment">*</span>
<a name="l00081"></a>00081 <span class="comment">* - 6: Clean up by freeing memory with wcsvfree().</span>
<a name="l00082"></a>00082 <span class="comment">*</span>
<a name="l00083"></a>00083 <span class="comment">* In detail:</span>
<a name="l00084"></a>00084 <span class="comment">*</span>
<a name="l00085"></a>00085 <span class="comment">* - wcspih() is a high-level FITS WCS routine that parses an image header. It</span>
<a name="l00086"></a>00086 <span class="comment">* returns an array of up to 27 wcsprm structs on each of which it invokes</span>
<a name="l00087"></a>00087 <span class="comment">* wcstab().</span>
<a name="l00088"></a>00088 <span class="comment">*</span>
<a name="l00089"></a>00089 <span class="comment">* - wcsbth() is the analogue of wcspih() for use with binary tables; it</span>
<a name="l00090"></a>00090 <span class="comment">* handles image array and pixel list keywords. As an extension of the FITS</span>
<a name="l00091"></a>00091 <span class="comment">* WCS standard, it also recognizes image header keywords which may be used</span>
<a name="l00092"></a>00092 <span class="comment">* to provide default values via an inheritance mechanism.</span>
<a name="l00093"></a>00093 <span class="comment">*</span>
<a name="l00094"></a>00094 <span class="comment">* - wcstab() assists in filling in members of the wcsprm struct associated</span>
<a name="l00095"></a>00095 <span class="comment">* with coordinate lookup tables ('TAB'). These are based on arrays stored</span>
<a name="l00096"></a>00096 <span class="comment">* in a FITS binary table extension (BINTABLE) that are located by PVi_ma</span>
<a name="l00097"></a>00097 <span class="comment">* keywords in the image header.</span>
<a name="l00098"></a>00098 <span class="comment">*</span>
<a name="l00099"></a>00099 <span class="comment">* - wcsidx() and wcsbdx() are utility routines that return the index for a</span>
<a name="l00100"></a>00100 <span class="comment">* specified alternate coordinate descriptor in the array of wcsprm structs</span>
<a name="l00101"></a>00101 <span class="comment">* returned by wcspih() or wcsbth().</span>
<a name="l00102"></a>00102 <span class="comment">*</span>
<a name="l00103"></a>00103 <span class="comment">* - wcsvfree() deallocates memory for an array of wcsprm structs, such as</span>
<a name="l00104"></a>00104 <span class="comment">* returned by wcspih() or wcsbth().</span>
<a name="l00105"></a>00105 <span class="comment">*</span>
<a name="l00106"></a>00106 <span class="comment">* - wcshdo() writes out a wcsprm struct as a FITS header.</span>
<a name="l00107"></a>00107 <span class="comment">*</span>
<a name="l00108"></a>00108 <span class="comment">*</span>
<a name="l00109"></a>00109 <span class="comment">* wcspih() - FITS WCS parser routine for image headers</span>
<a name="l00110"></a>00110 <span class="comment">* ----------------------------------------------------</span>
<a name="l00111"></a>00111 <span class="comment">* wcspih() is a high-level FITS WCS routine that parses an image header,</span>
<a name="l00112"></a>00112 <span class="comment">* either that of a primary HDU or of an image extension. All WCS keywords</span>
<a name="l00113"></a>00113 <span class="comment">* defined in Papers I, II, and III are recognized, and also those used by the</span>
<a name="l00114"></a>00114 <span class="comment">* AIPS convention and certain other keywords that existed in early drafts of</span>
<a name="l00115"></a>00115 <span class="comment">* the WCS papers as explained in wcsbth() note 5.</span>
<a name="l00116"></a>00116 <span class="comment">*</span>
<a name="l00117"></a>00117 <span class="comment">* Given a character array containing a FITS image header, wcspih() identifies</span>
<a name="l00118"></a>00118 <span class="comment">* and reads all WCS keywords for the primary coordinate representation and up</span>
<a name="l00119"></a>00119 <span class="comment">* to 26 alternate representations. It returns this information as an array of</span>
<a name="l00120"></a>00120 <span class="comment">* wcsprm structs.</span>
<a name="l00121"></a>00121 <span class="comment">*</span>
<a name="l00122"></a>00122 <span class="comment">* wcspih() invokes wcstab() on each of the wcsprm structs that it returns.</span>
<a name="l00123"></a>00123 <span class="comment">*</span>
<a name="l00124"></a>00124 <span class="comment">* Use wcsbth() in preference to wcspih() for FITS headers of unknown type;</span>
<a name="l00125"></a>00125 <span class="comment">* wcsbth() can parse image headers as well as binary table and pixel list</span>
<a name="l00126"></a>00126 <span class="comment">* headers.</span>
<a name="l00127"></a>00127 <span class="comment">*</span>
<a name="l00128"></a>00128 <span class="comment">* Given and returned:</span>
<a name="l00129"></a>00129 <span class="comment">* header char[] Character array containing the (entire) FITS image</span>
<a name="l00130"></a>00130 <span class="comment">* header from which to identify and construct the</span>
<a name="l00131"></a>00131 <span class="comment">* coordinate representations, for example, as might be</span>
<a name="l00132"></a>00132 <span class="comment">* obtained conveniently via the CFITSIO routine</span>
<a name="l00133"></a>00133 <span class="comment">* fits_hdr2str().</span>
<a name="l00134"></a>00134 <span class="comment">*</span>
<a name="l00135"></a>00135 <span class="comment">* Each header "keyrecord" (formerly "card image")</span>
<a name="l00136"></a>00136 <span class="comment">* consists of exactly 80 7-bit ASCII printing characters</span>
<a name="l00137"></a>00137 <span class="comment">* in the range 0x20 to 0x7e (which excludes NUL, BS,</span>
<a name="l00138"></a>00138 <span class="comment">* TAB, LF, FF and CR) especially noting that the</span>
<a name="l00139"></a>00139 <span class="comment">* keyrecords are NOT null-terminated.</span>
<a name="l00140"></a>00140 <span class="comment">*</span>
<a name="l00141"></a>00141 <span class="comment">* For negative values of ctrl (see below), header[] is</span>
<a name="l00142"></a>00142 <span class="comment">* modified so that WCS keyrecords processed by wcspih()</span>
<a name="l00143"></a>00143 <span class="comment">* are removed from it.</span>
<a name="l00144"></a>00144 <span class="comment">*</span>
<a name="l00145"></a>00145 <span class="comment">* Given:</span>
<a name="l00146"></a>00146 <span class="comment">* nkeyrec int Number of keyrecords in header[].</span>
<a name="l00147"></a>00147 <span class="comment">*</span>
<a name="l00148"></a>00148 <span class="comment">* relax int Degree of permissiveness:</span>
<a name="l00149"></a>00149 <span class="comment">* 0: Recognize only FITS keywords defined by the</span>
<a name="l00150"></a>00150 <span class="comment">* published WCS standard.</span>
<a name="l00151"></a>00151 <span class="comment">* WCSHDR_all: Admit all recognized informal</span>
<a name="l00152"></a>00152 <span class="comment">* extensions of the WCS standard.</span>
<a name="l00153"></a>00153 <span class="comment">* Fine-grained control of the degree of permissiveness</span>
<a name="l00154"></a>00154 <span class="comment">* is also possible as explained in wcsbth() note 5.</span>
<a name="l00155"></a>00155 <span class="comment">*</span>
<a name="l00156"></a>00156 <span class="comment">* ctrl int Error reporting and other control options for invalid</span>
<a name="l00157"></a>00157 <span class="comment">* WCS and other header keyrecords:</span>
<a name="l00158"></a>00158 <span class="comment">* 0: Do not report any rejected header keyrecords.</span>
<a name="l00159"></a>00159 <span class="comment">* 1: Produce a one-line message stating the number</span>
<a name="l00160"></a>00160 <span class="comment">* of WCS keyrecords rejected (nreject).</span>
<a name="l00161"></a>00161 <span class="comment">* 2: Report each rejected keyrecord and the reason</span>
<a name="l00162"></a>00162 <span class="comment">* why it was rejected.</span>
<a name="l00163"></a>00163 <span class="comment">* 3: As above, but also report all non-WCS</span>
<a name="l00164"></a>00164 <span class="comment">* keyrecords that were discarded, and the number</span>
<a name="l00165"></a>00165 <span class="comment">* of coordinate representations (nwcs) found.</span>
<a name="l00166"></a>00166 <span class="comment">* The report is written to stderr.</span>
<a name="l00167"></a>00167 <span class="comment">*</span>
<a name="l00168"></a>00168 <span class="comment">* For ctrl < 0, WCS keyrecords processed by wcspih()</span>
<a name="l00169"></a>00169 <span class="comment">* are removed from header[]:</span>
<a name="l00170"></a>00170 <span class="comment">* -1: Remove only valid WCS keyrecords whose values</span>
<a name="l00171"></a>00171 <span class="comment">* were successfully extracted, nothing is</span>
<a name="l00172"></a>00172 <span class="comment">* reported.</span>
<a name="l00173"></a>00173 <span class="comment">* -2: Also remove WCS keyrecords that were rejected,</span>
<a name="l00174"></a>00174 <span class="comment">* reporting each one and the reason that it was</span>
<a name="l00175"></a>00175 <span class="comment">* rejected.</span>
<a name="l00176"></a>00176 <span class="comment">* -3: As above, and also report the number of</span>
<a name="l00177"></a>00177 <span class="comment">* coordinate representations (nwcs) found.</span>
<a name="l00178"></a>00178 <span class="comment">* -11: Same as -1 but preserving the basic keywords</span>
<a name="l00179"></a>00179 <span class="comment">* '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'.</span>
<a name="l00180"></a>00180 <span class="comment">* If any keyrecords are removed from header[] it will</span>
<a name="l00181"></a>00181 <span class="comment">* be null-terminated (NUL not being a legal FITS header</span>
<a name="l00182"></a>00182 <span class="comment">* character), otherwise it will contain its original</span>
<a name="l00183"></a>00183 <span class="comment">* complement of nkeyrec keyrecords and possibly not be</span>
<a name="l00184"></a>00184 <span class="comment">* null-terminated.</span>
<a name="l00185"></a>00185 <span class="comment">*</span>
<a name="l00186"></a>00186 <span class="comment">* Returned:</span>
<a name="l00187"></a>00187 <span class="comment">* nreject int* Number of WCS keywords rejected for syntax errors,</span>
<a name="l00188"></a>00188 <span class="comment">* illegal values, etc. Keywords not recognized as WCS</span>
<a name="l00189"></a>00189 <span class="comment">* keywords are simply ignored. Refer also to wcsbth()</span>
<a name="l00190"></a>00190 <span class="comment">* note 5.</span>
<a name="l00191"></a>00191 <span class="comment">*</span>
<a name="l00192"></a>00192 <span class="comment">* nwcs int* Number of coordinate representations found.</span>
<a name="l00193"></a>00193 <span class="comment">*</span>
<a name="l00194"></a>00194 <span class="comment">* wcs struct wcsprm**</span>
<a name="l00195"></a>00195 <span class="comment">* Pointer to an array of wcsprm structs containing up to</span>
<a name="l00196"></a>00196 <span class="comment">* 27 coordinate representations.</span>
<a name="l00197"></a>00197 <span class="comment">*</span>
<a name="l00198"></a>00198 <span class="comment">* Memory for the array is allocated by wcspih() which</span>
<a name="l00199"></a>00199 <span class="comment">* also invokes wcsini() for each struct to allocate</span>
<a name="l00200"></a>00200 <span class="comment">* memory for internal arrays and initialize their</span>
<a name="l00201"></a>00201 <span class="comment">* members to default values. Refer also to wcsbth()</span>
<a name="l00202"></a>00202 <span class="comment">* note 8. Note that wcsset() is not invoked on these</span>
<a name="l00203"></a>00203 <span class="comment">* structs.</span>
<a name="l00204"></a>00204 <span class="comment">*</span>
<a name="l00205"></a>00205 <span class="comment">* This allocated memory must be freed by the user, first</span>
<a name="l00206"></a>00206 <span class="comment">* by invoking wcsfree() for each struct, and then by</span>
<a name="l00207"></a>00207 <span class="comment">* freeing the array itself. A routine, wcsvfree(), is</span>
<a name="l00208"></a>00208 <span class="comment">* provided to do this (see below).</span>
<a name="l00209"></a>00209 <span class="comment">*</span>
<a name="l00210"></a>00210 <span class="comment">* Function return value:</span>
<a name="l00211"></a>00211 <span class="comment">* int Status return value:</span>
<a name="l00212"></a>00212 <span class="comment">* 0: Success.</span>
<a name="l00213"></a>00213 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00214"></a>00214 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00215"></a>00215 <span class="comment">* 4: Fatal error returned by Flex parser.</span>
<a name="l00216"></a>00216 <span class="comment">*</span>
<a name="l00217"></a>00217 <span class="comment">* Notes:</span>
<a name="l00218"></a>00218 <span class="comment">* Refer to wcsbth() notes 1, 2, 3, 5, 7, and 8.</span>
<a name="l00219"></a>00219 <span class="comment">*</span>
<a name="l00220"></a>00220 <span class="comment">*</span>
<a name="l00221"></a>00221 <span class="comment">* wcsbth() - FITS WCS parser routine for binary table and image headers</span>
<a name="l00222"></a>00222 <span class="comment">* ---------------------------------------------------------------------</span>
<a name="l00223"></a>00223 <span class="comment">* wcsbth() is a high-level FITS WCS routine that parses a binary table header.</span>
<a name="l00224"></a>00224 <span class="comment">* It handles image array and pixel list WCS keywords which may be present</span>
<a name="l00225"></a>00225 <span class="comment">* together in one header.</span>
<a name="l00226"></a>00226 <span class="comment">*</span>
<a name="l00227"></a>00227 <span class="comment">* As an extension of the FITS WCS standard, wcsbth() also recognizes image</span>
<a name="l00228"></a>00228 <span class="comment">* header keywords in a binary table header. These may be used to provide</span>
<a name="l00229"></a>00229 <span class="comment">* default values via an inheritance mechanism discussed in note 5 (c.f.</span>
<a name="l00230"></a>00230 <span class="comment">* WCSHDR_AUXIMG and WCSHDR_ALLIMG), or may instead result in wcsprm structs</span>
<a name="l00231"></a>00231 <span class="comment">* that are not associated with any particular column. Thus wcsbth() can</span>
<a name="l00232"></a>00232 <span class="comment">* handle primary image and image extension headers in addition to binary table</span>
<a name="l00233"></a>00233 <span class="comment">* headers (it ignores NAXIS and does not rely on the presence of the TFIELDS</span>
<a name="l00234"></a>00234 <span class="comment">* keyword).</span>
<a name="l00235"></a>00235 <span class="comment">*</span>
<a name="l00236"></a>00236 <span class="comment">* All WCS keywords defined in Papers I, II, and III are recognized, and also</span>
<a name="l00237"></a>00237 <span class="comment">* those used by the AIPS convention and certain other keywords that existed in</span>
<a name="l00238"></a>00238 <span class="comment">* early drafts of the WCS papers as explained in note 5 below.</span>
<a name="l00239"></a>00239 <span class="comment">*</span>
<a name="l00240"></a>00240 <span class="comment">* wcsbth() sets the colnum or colax[] members of the wcsprm structs that it</span>
<a name="l00241"></a>00241 <span class="comment">* returns with the column number of an image array or the column numbers</span>
<a name="l00242"></a>00242 <span class="comment">* associated with each pixel coordinate element in a pixel list. wcsprm</span>
<a name="l00243"></a>00243 <span class="comment">* structs that are not associated with any particular column, as may be</span>
<a name="l00244"></a>00244 <span class="comment">* derived from image header keywords, have colnum == 0.</span>
<a name="l00245"></a>00245 <span class="comment">*</span>
<a name="l00246"></a>00246 <span class="comment">* Note 6 below discusses the number of wcsprm structs returned by wcsbth(),</span>
<a name="l00247"></a>00247 <span class="comment">* and the circumstances in which image header keywords cause a struct to be</span>
<a name="l00248"></a>00248 <span class="comment">* created. See also note 9 concerning the number of separate images that may</span>
<a name="l00249"></a>00249 <span class="comment">* be stored in a pixel list.</span>
<a name="l00250"></a>00250 <span class="comment">*</span>
<a name="l00251"></a>00251 <span class="comment">* The API to wcsbth() is similar to that of wcspih() except for the addition</span>
<a name="l00252"></a>00252 <span class="comment">* of extra arguments that may be used to restrict its operation. Like</span>
<a name="l00253"></a>00253 <span class="comment">* wcspih(), wcsbth() invokes wcstab() on each of the wcsprm structs that it</span>
<a name="l00254"></a>00254 <span class="comment">* returns.</span>
<a name="l00255"></a>00255 <span class="comment">*</span>
<a name="l00256"></a>00256 <span class="comment">* Given and returned:</span>
<a name="l00257"></a>00257 <span class="comment">* header char[] Character array containing the (entire) FITS binary</span>
<a name="l00258"></a>00258 <span class="comment">* table, primary image, or image extension header from</span>
<a name="l00259"></a>00259 <span class="comment">* which to identify and construct the coordinate</span>
<a name="l00260"></a>00260 <span class="comment">* representations, for example, as might be obtained</span>
<a name="l00261"></a>00261 <span class="comment">* conveniently via the CFITSIO routine fits_hdr2str().</span>
<a name="l00262"></a>00262 <span class="comment">*</span>
<a name="l00263"></a>00263 <span class="comment">* Each header "keyrecord" (formerly "card image")</span>
<a name="l00264"></a>00264 <span class="comment">* consists of exactly 80 7-bit ASCII printing</span>
<a name="l00265"></a>00265 <span class="comment">* characters in the range 0x20 to 0x7e (which excludes</span>
<a name="l00266"></a>00266 <span class="comment">* NUL, BS, TAB, LF, FF and CR) especially noting that</span>
<a name="l00267"></a>00267 <span class="comment">* the keyrecords are NOT null-terminated.</span>
<a name="l00268"></a>00268 <span class="comment">*</span>
<a name="l00269"></a>00269 <span class="comment">* For negative values of ctrl (see below), header[] is</span>
<a name="l00270"></a>00270 <span class="comment">* modified so that WCS keyrecords processed by wcsbth()</span>
<a name="l00271"></a>00271 <span class="comment">* are removed from it.</span>
<a name="l00272"></a>00272 <span class="comment">*</span>
<a name="l00273"></a>00273 <span class="comment">* Given:</span>
<a name="l00274"></a>00274 <span class="comment">* nkeyrec int Number of keyrecords in header[].</span>
<a name="l00275"></a>00275 <span class="comment">*</span>
<a name="l00276"></a>00276 <span class="comment">* relax int Degree of permissiveness:</span>
<a name="l00277"></a>00277 <span class="comment">* 0: Recognize only FITS keywords defined by the</span>
<a name="l00278"></a>00278 <span class="comment">* published WCS standard.</span>
<a name="l00279"></a>00279 <span class="comment">* WCSHDR_all: Admit all recognized informal</span>
<a name="l00280"></a>00280 <span class="comment">* extensions of the WCS standard.</span>
<a name="l00281"></a>00281 <span class="comment">* Fine-grained control of the degree of permissiveness</span>
<a name="l00282"></a>00282 <span class="comment">* is also possible, as explained in note 5 below.</span>
<a name="l00283"></a>00283 <span class="comment">*</span>
<a name="l00284"></a>00284 <span class="comment">* ctrl int Error reporting and other control options for invalid</span>
<a name="l00285"></a>00285 <span class="comment">* WCS and other header keyrecords:</span>
<a name="l00286"></a>00286 <span class="comment">* 0: Do not report any rejected header keyrecords.</span>
<a name="l00287"></a>00287 <span class="comment">* 1: Produce a one-line message stating the number</span>
<a name="l00288"></a>00288 <span class="comment">* of WCS keyrecords rejected (nreject).</span>
<a name="l00289"></a>00289 <span class="comment">* 2: Report each rejected keyrecord and the reason</span>
<a name="l00290"></a>00290 <span class="comment">* why it was rejected.</span>
<a name="l00291"></a>00291 <span class="comment">* 3: As above, but also report all non-WCS</span>
<a name="l00292"></a>00292 <span class="comment">* keyrecords that were discarded, and the number</span>
<a name="l00293"></a>00293 <span class="comment">* of coordinate representations (nwcs) found.</span>
<a name="l00294"></a>00294 <span class="comment">* The report is written to stderr.</span>
<a name="l00295"></a>00295 <span class="comment">*</span>
<a name="l00296"></a>00296 <span class="comment">* For ctrl < 0, WCS keyrecords processed by wcsbth()</span>
<a name="l00297"></a>00297 <span class="comment">* are removed from header[]:</span>
<a name="l00298"></a>00298 <span class="comment">* -1: Remove only valid WCS keyrecords whose values</span>
<a name="l00299"></a>00299 <span class="comment">* were successfully extracted, nothing is</span>
<a name="l00300"></a>00300 <span class="comment">* reported.</span>
<a name="l00301"></a>00301 <span class="comment">* -2: Also remove WCS keyrecords that were rejected,</span>
<a name="l00302"></a>00302 <span class="comment">* reporting each one and the reason that it was</span>
<a name="l00303"></a>00303 <span class="comment">* rejected.</span>
<a name="l00304"></a>00304 <span class="comment">* -3: As above, and also report the number of</span>
<a name="l00305"></a>00305 <span class="comment">* coordinate representations (nwcs) found.</span>
<a name="l00306"></a>00306 <span class="comment">* -11: Same as -1 but preserving the basic keywords</span>
<a name="l00307"></a>00307 <span class="comment">* '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'.</span>
<a name="l00308"></a>00308 <span class="comment">* If any keyrecords are removed from header[] it will</span>
<a name="l00309"></a>00309 <span class="comment">* be null-terminated (NUL not being a legal FITS header</span>
<a name="l00310"></a>00310 <span class="comment">* character), otherwise it will contain its original</span>
<a name="l00311"></a>00311 <span class="comment">* complement of nkeyrec keyrecords and possibly not be</span>
<a name="l00312"></a>00312 <span class="comment">* null-terminated.</span>
<a name="l00313"></a>00313 <span class="comment">*</span>
<a name="l00314"></a>00314 <span class="comment">* keysel int Vector of flag bits that may be used to restrict the</span>
<a name="l00315"></a>00315 <span class="comment">* keyword types considered:</span>
<a name="l00316"></a>00316 <span class="comment">* WCSHDR_IMGHEAD: Image header keywords.</span>
<a name="l00317"></a>00317 <span class="comment">* WCSHDR_BIMGARR: Binary table image array.</span>
<a name="l00318"></a>00318 <span class="comment">* WCSHDR_PIXLIST: Pixel list keywords.</span>
<a name="l00319"></a>00319 <span class="comment">* If zero, there is no restriction.</span>
<a name="l00320"></a>00320 <span class="comment">*</span>
<a name="l00321"></a>00321 <span class="comment">* Keywords such as EQUIna or RFRQna that are common to</span>
<a name="l00322"></a>00322 <span class="comment">* binary table image arrays and pixel lists (including</span>
<a name="l00323"></a>00323 <span class="comment">* WCSNna and TWCSna, as explained in note 4 below) are</span>
<a name="l00324"></a>00324 <span class="comment">* selected by both WCSHDR_BIMGARR and WCSHDR_PIXLIST.</span>
<a name="l00325"></a>00325 <span class="comment">* Thus if inheritance via WCSHDR_ALLIMG is enabled as</span>
<a name="l00326"></a>00326 <span class="comment">* discussed in note 5 and one of these shared keywords</span>
<a name="l00327"></a>00327 <span class="comment">* is present, then WCSHDR_IMGHEAD and WCSHDR_PIXLIST</span>
<a name="l00328"></a>00328 <span class="comment">* alone may be sufficient to cause the construction of</span>
<a name="l00329"></a>00329 <span class="comment">* coordinate descriptions for binary table image arrays.</span>
<a name="l00330"></a>00330 <span class="comment">*</span>
<a name="l00331"></a>00331 <span class="comment">* colsel int* Pointer to an array of table column numbers used to</span>
<a name="l00332"></a>00332 <span class="comment">* restrict the keywords considered by wcsbth().</span>
<a name="l00333"></a>00333 <span class="comment">*</span>
<a name="l00334"></a>00334 <span class="comment">* A null pointer may be specified to indicate that there</span>
<a name="l00335"></a>00335 <span class="comment">* is no restriction. Otherwise, the magnitude of</span>
<a name="l00336"></a>00336 <span class="comment">* cols[0] specifies the length of the array:</span>
<a name="l00337"></a>00337 <span class="comment">* cols[0] > 0: the columns are included,</span>
<a name="l00338"></a>00338 <span class="comment">* cols[0] < 0: the columns are excluded.</span>
<a name="l00339"></a>00339 <span class="comment">*</span>
<a name="l00340"></a>00340 <span class="comment">* For the pixel list keywords TPn_ka and TCn_ka (and</span>
<a name="l00341"></a>00341 <span class="comment">* TPCn_ka and TCDn_ka if WCSHDR_LONGKEY is enabled), it</span>
<a name="l00342"></a>00342 <span class="comment">* is an error for one column to be selected but not the</span>
<a name="l00343"></a>00343 <span class="comment">* other. This is unlike the situation with invalid</span>
<a name="l00344"></a>00344 <span class="comment">* keyrecords, which are simply rejected, because the</span>
<a name="l00345"></a>00345 <span class="comment">* error is not intrinsic to the header itself but</span>
<a name="l00346"></a>00346 <span class="comment">* arises in the way that it is processed.</span>
<a name="l00347"></a>00347 <span class="comment">*</span>
<a name="l00348"></a>00348 <span class="comment">* Returned:</span>
<a name="l00349"></a>00349 <span class="comment">* nreject int* Number of WCS keywords rejected for syntax errors,</span>
<a name="l00350"></a>00350 <span class="comment">* illegal values, etc. Keywords not recognized as WCS</span>
<a name="l00351"></a>00351 <span class="comment">* keywords are simply ignored, refer also to note 5</span>
<a name="l00352"></a>00352 <span class="comment">* below.</span>
<a name="l00353"></a>00353 <span class="comment">*</span>
<a name="l00354"></a>00354 <span class="comment">* nwcs int* Number of coordinate representations found.</span>
<a name="l00355"></a>00355 <span class="comment">*</span>
<a name="l00356"></a>00356 <span class="comment">* wcs struct wcsprm**</span>
<a name="l00357"></a>00357 <span class="comment">* Pointer to an array of wcsprm structs containing up</span>
<a name="l00358"></a>00358 <span class="comment">* to 27027 coordinate representations, refer to note 6</span>
<a name="l00359"></a>00359 <span class="comment">* below.</span>
<a name="l00360"></a>00360 <span class="comment">*</span>
<a name="l00361"></a>00361 <span class="comment">* Memory for the array is allocated by wcsbth() which</span>
<a name="l00362"></a>00362 <span class="comment">* also invokes wcsini() for each struct to allocate</span>
<a name="l00363"></a>00363 <span class="comment">* memory for internal arrays and initialize their</span>
<a name="l00364"></a>00364 <span class="comment">* members to default values. Refer also to note 8</span>
<a name="l00365"></a>00365 <span class="comment">* below. Note that wcsset() is not invoked on these</span>
<a name="l00366"></a>00366 <span class="comment">* structs.</span>
<a name="l00367"></a>00367 <span class="comment">*</span>
<a name="l00368"></a>00368 <span class="comment">* This allocated memory must be freed by the user, first</span>
<a name="l00369"></a>00369 <span class="comment">* by invoking wcsfree() for each struct, and then by</span>
<a name="l00370"></a>00370 <span class="comment">* freeing the array itself. A routine, wcsvfree(), is</span>
<a name="l00371"></a>00371 <span class="comment">* provided to do this (see below).</span>
<a name="l00372"></a>00372 <span class="comment">*</span>
<a name="l00373"></a>00373 <span class="comment">* Function return value:</span>
<a name="l00374"></a>00374 <span class="comment">* int Status return value:</span>
<a name="l00375"></a>00375 <span class="comment">* 0: Success.</span>
<a name="l00376"></a>00376 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00377"></a>00377 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00378"></a>00378 <span class="comment">* 3: Invalid column selection.</span>
<a name="l00379"></a>00379 <span class="comment">* 4: Fatal error returned by Flex parser.</span>
<a name="l00380"></a>00380 <span class="comment">*</span>
<a name="l00381"></a>00381 <span class="comment">* Notes:</span>
<a name="l00382"></a>00382 <span class="comment">* 1: wcspih() determines the number of coordinate axes independently for</span>
<a name="l00383"></a>00383 <span class="comment">* each alternate coordinate representation (denoted by the "a" value in</span>
<a name="l00384"></a>00384 <span class="comment">* keywords like CTYPEia) from the higher of</span>
<a name="l00385"></a>00385 <span class="comment">*</span>
<a name="l00386"></a>00386 <span class="comment">* a: NAXIS,</span>
<a name="l00387"></a>00387 <span class="comment">* b: WCSAXESa,</span>
<a name="l00388"></a>00388 <span class="comment">* c: The highest axis number in any parameterized WCS keyword. The</span>
<a name="l00389"></a>00389 <span class="comment">* keyvalue, as well as the keyword, must be syntactically valid</span>
<a name="l00390"></a>00390 <span class="comment">* otherwise it will not be considered.</span>
<a name="l00391"></a>00391 <span class="comment">*</span>
<a name="l00392"></a>00392 <span class="comment">* If none of these keyword types is present, i.e. if the header only</span>
<a name="l00393"></a>00393 <span class="comment">* contains auxiliary WCS keywords for a particular coordinate</span>
<a name="l00394"></a>00394 <span class="comment">* representation, then no coordinate description is constructed for it.</span>
<a name="l00395"></a>00395 <span class="comment">*</span>
<a name="l00396"></a>00396 <span class="comment">* wcsbth() is similar except that it ignores the NAXIS keyword if given</span>
<a name="l00397"></a>00397 <span class="comment">* an image header to process.</span>
<a name="l00398"></a>00398 <span class="comment">*</span>
<a name="l00399"></a>00399 <span class="comment">* The number of axes, which is returned as a member of the wcsprm</span>
<a name="l00400"></a>00400 <span class="comment">* struct, may differ for different coordinate representations of the</span>
<a name="l00401"></a>00401 <span class="comment">* same image.</span>
<a name="l00402"></a>00402 <span class="comment">*</span>
<a name="l00403"></a>00403 <span class="comment">* 2: wcspih() and wcsbth() enforce correct FITS "keyword = value" syntax</span>
<a name="l00404"></a>00404 <span class="comment">* with regard to "= " occurring in columns 9 and 10.</span>
<a name="l00405"></a>00405 <span class="comment">*</span>
<a name="l00406"></a>00406 <span class="comment">* However, they do recognize free-format character (NOST 100-2.0,</span>
<a name="l00407"></a>00407 <span class="comment">* Sect. 5.2.1), integer (Sect. 5.2.3), and floating-point values</span>
<a name="l00408"></a>00408 <span class="comment">* (Sect. 5.2.4) for all keywords.</span>
<a name="l00409"></a>00409 <span class="comment">*</span>
<a name="l00410"></a>00410 <span class="comment">* 3: Where CROTAn, CDi_ja, and PCi_ja occur together in one header wcspih()</span>
<a name="l00411"></a>00411 <span class="comment">* and wcsbth() treat them as described in the prologue to wcs.h.</span>
<a name="l00412"></a>00412 <span class="comment">*</span>
<a name="l00413"></a>00413 <span class="comment">* 4: WCS Paper I mistakenly defined the pixel list form of WCSNAMEa as</span>
<a name="l00414"></a>00414 <span class="comment">* TWCSna instead of WCSNna; the 'T' is meant to substitute for the axis</span>
<a name="l00415"></a>00415 <span class="comment">* number in the binary table form of the keyword - note that keywords</span>
<a name="l00416"></a>00416 <span class="comment">* defined in WCS Papers II and III that are not parameterised by axis</span>
<a name="l00417"></a>00417 <span class="comment">* number have identical forms for binary tables and pixel lists.</span>
<a name="l00418"></a>00418 <span class="comment">* Consequently wcsbth() always treats WCSNna and TWCSna as equivalent.</span>
<a name="l00419"></a>00419 <span class="comment">*</span>
<a name="l00420"></a>00420 <span class="comment">* 5: wcspih() and wcsbth() interpret the "relax" argument as a vector of</span>
<a name="l00421"></a>00421 <span class="comment">* flag bits to provide fine-grained control over what non-standard WCS</span>
<a name="l00422"></a>00422 <span class="comment">* keywords to accept. The flag bits are subject to change in future and</span>
<a name="l00423"></a>00423 <span class="comment">* should be set by using the preprocessor macros (see below) for the</span>
<a name="l00424"></a>00424 <span class="comment">* purpose.</span>
<a name="l00425"></a>00425 <span class="comment">*</span>
<a name="l00426"></a>00426 <span class="comment">* - WCSHDR_none: Don't accept any extensions (not even those in the</span>
<a name="l00427"></a>00427 <span class="comment">* errata). Treat non-conformant keywords in the same way as</span>
<a name="l00428"></a>00428 <span class="comment">* non-WCS keywords in the header, i.e. simply ignore them.</span>
<a name="l00429"></a>00429 <span class="comment">*</span>
<a name="l00430"></a>00430 <span class="comment">* - WCSHDR_all: Accept all extensions recognized by the parser.</span>
<a name="l00431"></a>00431 <span class="comment">*</span>
<a name="l00432"></a>00432 <span class="comment">* - WCSHDR_reject: Reject non-standard keywords (that are not otherwise</span>
<a name="l00433"></a>00433 <span class="comment">* accepted). A message will optionally be printed on stderr, as</span>
<a name="l00434"></a>00434 <span class="comment">* determined by the ctrl argument, and nreject will be</span>
<a name="l00435"></a>00435 <span class="comment">* incremented.</span>
<a name="l00436"></a>00436 <span class="comment">*</span>
<a name="l00437"></a>00437 <span class="comment">* This flag may be used to signal the presence of non-standard</span>
<a name="l00438"></a>00438 <span class="comment">* keywords, otherwise they are simply passed over as though they</span>
<a name="l00439"></a>00439 <span class="comment">* did not exist in the header.</span>
<a name="l00440"></a>00440 <span class="comment">*</span>
<a name="l00441"></a>00441 <span class="comment">* Useful for testing conformance of a FITS header to the WCS</span>
<a name="l00442"></a>00442 <span class="comment">* standard.</span>
<a name="l00443"></a>00443 <span class="comment">*</span>
<a name="l00444"></a>00444 <span class="comment">* - WCSHDR_CROTAia: Accept CROTAia (wcspih()),</span>
<a name="l00445"></a>00445 <span class="comment">* iCROTna (wcsbth()),</span>
<a name="l00446"></a>00446 <span class="comment">* TCROTna (wcsbth()).</span>
<a name="l00447"></a>00447 <span class="comment">* - WCSHDR_EPOCHa: Accept EPOCHa.</span>
<a name="l00448"></a>00448 <span class="comment">* - WCSHDR_VELREFa: Accept VELREFa.</span>
<a name="l00449"></a>00449 <span class="comment">* wcspih() always recognizes the AIPS-convention keywords,</span>
<a name="l00450"></a>00450 <span class="comment">* CROTAn, EPOCH, and VELREF for the primary representation</span>
<a name="l00451"></a>00451 <span class="comment">* (a = ' ') but alternates are non-standard.</span>
<a name="l00452"></a>00452 <span class="comment">*</span>
<a name="l00453"></a>00453 <span class="comment">* wcsbth() accepts EPOCHa and VELREFa only if WCSHDR_AUXIMG is</span>
<a name="l00454"></a>00454 <span class="comment">* also enabled.</span>
<a name="l00455"></a>00455 <span class="comment">*</span>
<a name="l00456"></a>00456 <span class="comment">* - WCSHDR_CD00i00j: Accept CD00i00j (wcspih()).</span>
<a name="l00457"></a>00457 <span class="comment">* - WCSHDR_PC00i00j: Accept PC00i00j (wcspih()).</span>
<a name="l00458"></a>00458 <span class="comment">* - WCSHDR_PROJPn: Accept PROJPn (wcspih()).</span>
<a name="l00459"></a>00459 <span class="comment">* These appeared in early drafts of WCS Paper I+II (before they</span>
<a name="l00460"></a>00460 <span class="comment">* were split) and are equivalent to CDi_ja, PCi_ja, and PVi_ma</span>
<a name="l00461"></a>00461 <span class="comment">* for the primary representation (a = ' '). PROJPn is</span>
<a name="l00462"></a>00462 <span class="comment">* equivalent to PVi_ma with m = n <= 9, and is associated</span>
<a name="l00463"></a>00463 <span class="comment">* exclusively with the latitude axis.</span>
<a name="l00464"></a>00464 <span class="comment">*</span>
<a name="l00465"></a>00465 <span class="comment">* - WCSHDR_RADECSYS: Accept RADECSYS. This appeared in early drafts of</span>
<a name="l00466"></a>00466 <span class="comment">* WCS Paper I+II and was subsequently replaced by RADESYSa.</span>
<a name="l00467"></a>00467 <span class="comment">*</span>
<a name="l00468"></a>00468 <span class="comment">* wcsbth() accepts RADECSYS only if WCSHDR_AUXIMG is also</span>
<a name="l00469"></a>00469 <span class="comment">* enabled.</span>
<a name="l00470"></a>00470 <span class="comment">*</span>
<a name="l00471"></a>00471 <span class="comment">* - WCSHDR_VSOURCE: Accept VSOURCEa or VSOUna (wcsbth()). This appeared</span>
<a name="l00472"></a>00472 <span class="comment">* in early drafts of WCS Paper III and was subsequently dropped</span>
<a name="l00473"></a>00473 <span class="comment">* in favour of ZSOURCEa and ZSOUna.</span>
<a name="l00474"></a>00474 <span class="comment">*</span>
<a name="l00475"></a>00475 <span class="comment">* wcsbth() accepts VSOURCEa only if WCSHDR_AUXIMG is also</span>
<a name="l00476"></a>00476 <span class="comment">* enabled.</span>
<a name="l00477"></a>00477 <span class="comment">*</span>
<a name="l00478"></a>00478 <span class="comment">* - WCSHDR_DOBSn (wcsbth() only): Allow DOBSn, the column-specific analogue</span>
<a name="l00479"></a>00479 <span class="comment">* of DATE-OBS. By an oversight this was never formally defined</span>
<a name="l00480"></a>00480 <span class="comment">* in the standard.</span>
<a name="l00481"></a>00481 <span class="comment">*</span>
<a name="l00482"></a>00482 <span class="comment">* - WCSHDR_LONGKEY (wcsbth() only): Accept long forms of the alternate</span>
<a name="l00483"></a>00483 <span class="comment">* binary table and pixel list WCS keywords, i.e. with "a" non-</span>
<a name="l00484"></a>00484 <span class="comment">* blank. Specifically</span>
<a name="l00485"></a>00485 <span class="comment">*</span>
<a name="l00486"></a>00486 <span class="comment"># jCRPXna TCRPXna : jCRPXn jCRPna TCRPXn TCRPna CRPIXja</span>
<a name="l00487"></a>00487 <span class="comment"># - TPCn_ka : - ijPCna - TPn_ka PCi_ja</span>
<a name="l00488"></a>00488 <span class="comment"># - TCDn_ka : - ijCDna - TCn_ka CDi_ja</span>
<a name="l00489"></a>00489 <span class="comment"># iCDLTna TCDLTna : iCDLTn iCDEna TCDLTn TCDEna CDELTia</span>
<a name="l00490"></a>00490 <span class="comment"># iCUNIna TCUNIna : iCUNIn iCUNna TCUNIn TCUNna CUNITia</span>
<a name="l00491"></a>00491 <span class="comment"># iCTYPna TCTYPna : iCTYPn iCTYna TCTYPn TCTYna CTYPEia</span>
<a name="l00492"></a>00492 <span class="comment"># iCRVLna TCRVLna : iCRVLn iCRVna TCRVLn TCRVna CRVALia</span>
<a name="l00493"></a>00493 <span class="comment"># iPVn_ma TPVn_ma : - iVn_ma - TVn_ma PVi_ma</span>
<a name="l00494"></a>00494 <span class="comment"># iPSn_ma TPSn_ma : - iSn_ma - TSn_ma PSi_ma</span>
<a name="l00495"></a>00495 <span class="comment">*</span>
<a name="l00496"></a>00496 <span class="comment">* where the primary and standard alternate forms together with</span>
<a name="l00497"></a>00497 <span class="comment">* the image-header equivalent are shown rightwards of the colon.</span>
<a name="l00498"></a>00498 <span class="comment">*</span>
<a name="l00499"></a>00499 <span class="comment">* The long form of these keywords could be described as quasi-</span>
<a name="l00500"></a>00500 <span class="comment">* standard. TPCn_ka, iPVn_ma, and TPVn_ma appeared by mistake</span>
<a name="l00501"></a>00501 <span class="comment">* in the examples in WCS Paper II and subsequently these and</span>
<a name="l00502"></a>00502 <span class="comment">* also TCDn_ka, iPSn_ma and TPSn_ma were legitimized by the</span>
<a name="l00503"></a>00503 <span class="comment">* errata to the WCS papers.</span>
<a name="l00504"></a>00504 <span class="comment">*</span>
<a name="l00505"></a>00505 <span class="comment">* Strictly speaking, the other long forms are non-standard and</span>
<a name="l00506"></a>00506 <span class="comment">* in fact have never appeared in any draft of the WCS papers nor</span>
<a name="l00507"></a>00507 <span class="comment">* in the errata. However, as natural extensions of the primary</span>
<a name="l00508"></a>00508 <span class="comment">* form they are unlikely to be written with any other intention.</span>
<a name="l00509"></a>00509 <span class="comment">* Thus it should be safe to accept them provided, of course,</span>
<a name="l00510"></a>00510 <span class="comment">* that the resulting keyword does not exceed the 8-character</span>
<a name="l00511"></a>00511 <span class="comment">* limit.</span>
<a name="l00512"></a>00512 <span class="comment">*</span>
<a name="l00513"></a>00513 <span class="comment">* If WCSHDR_CNAMn is enabled then also accept</span>
<a name="l00514"></a>00514 <span class="comment">*</span>
<a name="l00515"></a>00515 <span class="comment"># iCNAMna TCNAMna : --- iCNAna --- TCNAna CNAMEia</span>
<a name="l00516"></a>00516 <span class="comment"># iCRDEna TCRDEna : --- iCRDna --- TCRDna CRDERia</span>
<a name="l00517"></a>00517 <span class="comment"># iCSYEna TCSYEna : --- iCSYna --- TCSYna CSYERia</span>
<a name="l00518"></a>00518 <span class="comment">*</span>
<a name="l00519"></a>00519 <span class="comment">* Note that CNAMEia, CRDERia, CSYERia, and their variants are</span>
<a name="l00520"></a>00520 <span class="comment">* not used by WCSLIB but are stored in the wcsprm struct as</span>
<a name="l00521"></a>00521 <span class="comment">* auxiliary information.</span>
<a name="l00522"></a>00522 <span class="comment">*</span>
<a name="l00523"></a>00523 <span class="comment">* - WCSHDR_CNAMn (wcsbth() only): Accept iCNAMn, iCRDEn, iCSYEn, TCNAMn,</span>
<a name="l00524"></a>00524 <span class="comment">* TCRDEn, and TCSYEn, i.e. with "a" blank. While non-standard,</span>
<a name="l00525"></a>00525 <span class="comment">* these are the obvious analogues of iCTYPn, TCTYPn, etc.</span>
<a name="l00526"></a>00526 <span class="comment">*</span>
<a name="l00527"></a>00527 <span class="comment">* - WCSHDR_AUXIMG (wcsbth() only): Allow the image-header form of an</span>
<a name="l00528"></a>00528 <span class="comment">* auxiliary WCS keyword with representation-wide scope to</span>
<a name="l00529"></a>00529 <span class="comment">* provide a default value for all images. This default may be</span>
<a name="l00530"></a>00530 <span class="comment">* overridden by the column-specific form of the keyword.</span>
<a name="l00531"></a>00531 <span class="comment">*</span>
<a name="l00532"></a>00532 <span class="comment">* For example, a keyword like EQUINOXa would apply to all image</span>
<a name="l00533"></a>00533 <span class="comment">* arrays in a binary table, or all pixel list columns with</span>
<a name="l00534"></a>00534 <span class="comment">* alternate representation "a" unless overridden by EQUIna.</span>
<a name="l00535"></a>00535 <span class="comment">*</span>
<a name="l00536"></a>00536 <span class="comment">* Specifically the keywords are:</span>
<a name="l00537"></a>00537 <span class="comment">*</span>
<a name="l00538"></a>00538 <span class="comment"># LATPOLEa for LATPna</span>
<a name="l00539"></a>00539 <span class="comment"># LONPOLEa for LONPna</span>
<a name="l00540"></a>00540 <span class="comment"># RESTFREQ for RFRQna</span>
<a name="l00541"></a>00541 <span class="comment"># RESTFRQa for RFRQna</span>
<a name="l00542"></a>00542 <span class="comment"># RESTWAVa for RWAVna</span>
<a name="l00543"></a>00543 <span class="comment">*</span>
<a name="l00544"></a>00544 <span class="comment">* whose keyvalues are actually used by WCSLIB, and also keywords</span>
<a name="l00545"></a>00545 <span class="comment">* that provide auxiliary information that is simply stored in</span>
<a name="l00546"></a>00546 <span class="comment">* the wcsprm struct:</span>
<a name="l00547"></a>00547 <span class="comment">*</span>
<a name="l00548"></a>00548 <span class="comment"># EPOCH - ... (No column-specific form.)</span>
<a name="l00549"></a>00549 <span class="comment"># EPOCHa - ... Only if WCSHDR_EPOCHa is set.</span>
<a name="l00550"></a>00550 <span class="comment"># EQUINOXa for EQUIna</span>
<a name="l00551"></a>00551 <span class="comment"># RADESYSa for RADEna</span>
<a name="l00552"></a>00552 <span class="comment"># RADECSYS for RADEna ... Only if WCSHDR_RADECSYS is set.</span>
<a name="l00553"></a>00553 <span class="comment"># SPECSYSa for SPECna</span>
<a name="l00554"></a>00554 <span class="comment"># SSYSOBSa for SOBSna</span>
<a name="l00555"></a>00555 <span class="comment"># SSYSSRCa for SSRCna</span>
<a name="l00556"></a>00556 <span class="comment"># VELOSYSa for VSYSna</span>
<a name="l00557"></a>00557 <span class="comment"># VELANGLa for VANGna</span>
<a name="l00558"></a>00558 <span class="comment"># VELREF - ... (No column-specific form.)</span>
<a name="l00559"></a>00559 <span class="comment"># VELREFa - ... Only if WCSHDR_VELREFa is set.</span>
<a name="l00560"></a>00560 <span class="comment"># VSOURCEa for VSOUna ... Only if WCSHDR_VSOURCE is set.</span>
<a name="l00561"></a>00561 <span class="comment"># WCSNAMEa for WCSNna ... Or TWCSna (see below).</span>
<a name="l00562"></a>00562 <span class="comment"># ZSOURCEa for ZSOUna</span>
<a name="l00563"></a>00563 <span class="comment">*</span>
<a name="l00564"></a>00564 <span class="comment"># DATE-AVG for DAVGn</span>
<a name="l00565"></a>00565 <span class="comment"># DATE-OBS for DOBSn</span>
<a name="l00566"></a>00566 <span class="comment"># MJD-AVG for MJDAn</span>
<a name="l00567"></a>00567 <span class="comment"># MJD-OBS for MJDOBn</span>
<a name="l00568"></a>00568 <span class="comment"># OBSGEO-X for OBSGXn</span>
<a name="l00569"></a>00569 <span class="comment"># OBSGEO-Y for OBSGYn</span>
<a name="l00570"></a>00570 <span class="comment"># OBSGEO-Z for OBSGZn</span>
<a name="l00571"></a>00571 <span class="comment">*</span>
<a name="l00572"></a>00572 <span class="comment">* where the image-header keywords on the left provide default</span>
<a name="l00573"></a>00573 <span class="comment">* values for the column specific keywords on the right.</span>
<a name="l00574"></a>00574 <span class="comment">*</span>
<a name="l00575"></a>00575 <span class="comment">* Keywords in the last group, such as MJD-OBS, apply to all</span>
<a name="l00576"></a>00576 <span class="comment">* alternate representations, so MJD-OBS would provide a default</span>
<a name="l00577"></a>00577 <span class="comment">* value for all images in the header.</span>
<a name="l00578"></a>00578 <span class="comment">*</span>
<a name="l00579"></a>00579 <span class="comment">* This auxiliary inheritance mechanism applies to binary table</span>
<a name="l00580"></a>00580 <span class="comment">* image arrays and pixel lists alike. Most of these keywords</span>
<a name="l00581"></a>00581 <span class="comment">* have no default value, the exceptions being LONPOLEa and</span>
<a name="l00582"></a>00582 <span class="comment">* LATPOLEa, and also RADESYSa and EQUINOXa which provide</span>
<a name="l00583"></a>00583 <span class="comment">* defaults for each other. Thus the only potential difficulty</span>
<a name="l00584"></a>00584 <span class="comment">* in using WCSHDR_AUXIMG is that of erroneously inheriting one</span>
<a name="l00585"></a>00585 <span class="comment">* of these four keywords.</span>
<a name="l00586"></a>00586 <span class="comment">*</span>
<a name="l00587"></a>00587 <span class="comment">* Unlike WCSHDR_ALLIMG, the existence of one (or all) of these</span>
<a name="l00588"></a>00588 <span class="comment">* auxiliary WCS image header keywords will not by itself cause a</span>
<a name="l00589"></a>00589 <span class="comment">* wcsprm struct to be created for alternate representation "a".</span>
<a name="l00590"></a>00590 <span class="comment">* This is because they do not provide sufficient information to</span>
<a name="l00591"></a>00591 <span class="comment">* create a non-trivial coordinate representation when used in</span>
<a name="l00592"></a>00592 <span class="comment">* conjunction with the default values of those keywords, such as</span>
<a name="l00593"></a>00593 <span class="comment">* CTYPEia, that are parameterized by axis number.</span>
<a name="l00594"></a>00594 <span class="comment">*</span>
<a name="l00595"></a>00595 <span class="comment">* - WCSHDR_ALLIMG (wcsbth() only): Allow the image-header form of *all*</span>
<a name="l00596"></a>00596 <span class="comment">* image header WCS keywords to provide a default value for all</span>
<a name="l00597"></a>00597 <span class="comment">* image arrays in a binary table (n.b. not pixel list). This</span>
<a name="l00598"></a>00598 <span class="comment">* default may be overridden by the column-specific form of the</span>
<a name="l00599"></a>00599 <span class="comment">* keyword.</span>
<a name="l00600"></a>00600 <span class="comment">*</span>
<a name="l00601"></a>00601 <span class="comment">* For example, a keyword like CRPIXja would apply to all image</span>
<a name="l00602"></a>00602 <span class="comment">* arrays in a binary table with alternate representation "a"</span>
<a name="l00603"></a>00603 <span class="comment">* unless overridden by jCRPna.</span>
<a name="l00604"></a>00604 <span class="comment">*</span>
<a name="l00605"></a>00605 <span class="comment">* Specifically the keywords are those listed above for</span>
<a name="l00606"></a>00606 <span class="comment">* WCSHDR_AUXIMG plus</span>
<a name="l00607"></a>00607 <span class="comment">*</span>
<a name="l00608"></a>00608 <span class="comment"># WCSAXESa for WCAXna</span>
<a name="l00609"></a>00609 <span class="comment">*</span>
<a name="l00610"></a>00610 <span class="comment">* which defines the coordinate dimensionality, and the following</span>
<a name="l00611"></a>00611 <span class="comment">* keywords which are parameterized by axis number:</span>
<a name="l00612"></a>00612 <span class="comment">*</span>
<a name="l00613"></a>00613 <span class="comment"># CRPIXja for jCRPna</span>
<a name="l00614"></a>00614 <span class="comment"># PCi_ja for ijPCna</span>
<a name="l00615"></a>00615 <span class="comment"># CDi_ja for ijCDna</span>
<a name="l00616"></a>00616 <span class="comment"># CDELTia for iCDEna</span>
<a name="l00617"></a>00617 <span class="comment"># CROTAi for iCROTn</span>
<a name="l00618"></a>00618 <span class="comment"># CROTAia - ... Only if WCSHDR_CROTAia is set.</span>
<a name="l00619"></a>00619 <span class="comment"># CUNITia for iCUNna</span>
<a name="l00620"></a>00620 <span class="comment"># CTYPEia for iCTYna</span>
<a name="l00621"></a>00621 <span class="comment"># CRVALia for iCRVna</span>
<a name="l00622"></a>00622 <span class="comment"># PVi_ma for iVn_ma</span>
<a name="l00623"></a>00623 <span class="comment"># PSi_ma for iSn_ma</span>
<a name="l00624"></a>00624 <span class="comment">*</span>
<a name="l00625"></a>00625 <span class="comment"># CNAMEia for iCNAna</span>
<a name="l00626"></a>00626 <span class="comment"># CRDERia for iCRDna</span>
<a name="l00627"></a>00627 <span class="comment"># CSYERia for iCSYna</span>
<a name="l00628"></a>00628 <span class="comment">*</span>
<a name="l00629"></a>00629 <span class="comment">* where the image-header keywords on the left provide default</span>
<a name="l00630"></a>00630 <span class="comment">* values for the column specific keywords on the right.</span>
<a name="l00631"></a>00631 <span class="comment">*</span>
<a name="l00632"></a>00632 <span class="comment">* This full inheritance mechanism only applies to binary table</span>
<a name="l00633"></a>00633 <span class="comment">* image arrays, not pixel lists, because in the latter case</span>
<a name="l00634"></a>00634 <span class="comment">* there is no well-defined association between coordinate axis</span>
<a name="l00635"></a>00635 <span class="comment">* number and column number.</span>
<a name="l00636"></a>00636 <span class="comment">*</span>
<a name="l00637"></a>00637 <span class="comment">* Note that CNAMEia, CRDERia, CSYERia, and their variants are</span>
<a name="l00638"></a>00638 <span class="comment">* not used by WCSLIB but are stored in the wcsprm struct as</span>
<a name="l00639"></a>00639 <span class="comment">* auxiliary information.</span>
<a name="l00640"></a>00640 <span class="comment">*</span>
<a name="l00641"></a>00641 <span class="comment">* Note especially that at least one wcsprm struct will be</span>
<a name="l00642"></a>00642 <span class="comment">* returned for each "a" found in one of the image header</span>
<a name="l00643"></a>00643 <span class="comment">* keywords listed above:</span>
<a name="l00644"></a>00644 <span class="comment">*</span>
<a name="l00645"></a>00645 <span class="comment">* - If the image header keywords for "a" ARE NOT inherited by a</span>
<a name="l00646"></a>00646 <span class="comment">* binary table, then the struct will not be associated with</span>
<a name="l00647"></a>00647 <span class="comment">* any particular table column number and it is up to the user</span>
<a name="l00648"></a>00648 <span class="comment">* to provide an association.</span>
<a name="l00649"></a>00649 <span class="comment">*</span>
<a name="l00650"></a>00650 <span class="comment">* - If the image header keywords for "a" ARE inherited by a</span>
<a name="l00651"></a>00651 <span class="comment">* binary table image array, then those keywords are considered</span>
<a name="l00652"></a>00652 <span class="comment">* to be "exhausted" and do not result in a separate wcsprm</span>
<a name="l00653"></a>00653 <span class="comment">* struct.</span>
<a name="l00654"></a>00654 <span class="comment">*</span>
<a name="l00655"></a>00655 <span class="comment">* For example, to accept CD00i00j and PC00i00j and reject all other</span>
<a name="l00656"></a>00656 <span class="comment">* extensions, use</span>
<a name="l00657"></a>00657 <span class="comment">*</span>
<a name="l00658"></a>00658 <span class="comment">= relax = WCSHDR_reject | WCSHDR_CD00i00j | WCSHDR_PC00i00j;</span>
<a name="l00659"></a>00659 <span class="comment">*</span>
<a name="l00660"></a>00660 <span class="comment">* The parser always treats EPOCH as subordinate to EQUINOXa if both are</span>
<a name="l00661"></a>00661 <span class="comment">* present, and VSOURCEa is always subordinate to ZSOURCEa.</span>
<a name="l00662"></a>00662 <span class="comment">*</span>
<a name="l00663"></a>00663 <span class="comment">* Likewise, VELREF is subordinate to the formalism of WCS Paper III, see</span>
<a name="l00664"></a>00664 <span class="comment">* spcaips().</span>
<a name="l00665"></a>00665 <span class="comment">*</span>
<a name="l00666"></a>00666 <span class="comment">* Neither wcspih() nor wcsbth() currently recognize the AIPS-convention</span>
<a name="l00667"></a>00667 <span class="comment">* keywords ALTRPIX or ALTRVAL which effectively define an alternative</span>
<a name="l00668"></a>00668 <span class="comment">* representation for a spectral axis.</span>
<a name="l00669"></a>00669 <span class="comment">*</span>
<a name="l00670"></a>00670 <span class="comment">* 6: Depending on what flags have been set in its "relax" argument,</span>
<a name="l00671"></a>00671 <span class="comment">* wcsbth() could return as many as 27027 wcsprm structs:</span>
<a name="l00672"></a>00672 <span class="comment">*</span>
<a name="l00673"></a>00673 <span class="comment">* - Up to 27 unattached representations derived from image header</span>
<a name="l00674"></a>00674 <span class="comment">* keywords.</span>
<a name="l00675"></a>00675 <span class="comment">*</span>
<a name="l00676"></a>00676 <span class="comment">* - Up to 27 structs for each of up to 999 columns containing an image</span>
<a name="l00677"></a>00677 <span class="comment">* arrays.</span>
<a name="l00678"></a>00678 <span class="comment">*</span>
<a name="l00679"></a>00679 <span class="comment">* - Up to 27 structs for a pixel list.</span>
<a name="l00680"></a>00680 <span class="comment">*</span>
<a name="l00681"></a>00681 <span class="comment">* Note that it is considered legitimate for a column to contain an image</span>
<a name="l00682"></a>00682 <span class="comment">* array and also form part of a pixel list, and in particular that</span>
<a name="l00683"></a>00683 <span class="comment">* wcsbth() does not check the TFORM keyword for a pixel list column to</span>
<a name="l00684"></a>00684 <span class="comment">* check that it is scalar.</span>
<a name="l00685"></a>00685 <span class="comment">*</span>
<a name="l00686"></a>00686 <span class="comment">* In practice, of course, a realistic binary table header is unlikely to</span>
<a name="l00687"></a>00687 <span class="comment">* contain more than a handful of images.</span>
<a name="l00688"></a>00688 <span class="comment">*</span>
<a name="l00689"></a>00689 <span class="comment">* In order for wcsbth() to create a wcsprm struct for a particular</span>
<a name="l00690"></a>00690 <span class="comment">* coordinate representation, at least one WCS keyword that defines an</span>
<a name="l00691"></a>00691 <span class="comment">* axis number must be present, either directly or by inheritance if</span>
<a name="l00692"></a>00692 <span class="comment">* WCSHDR_ALLIMG is set.</span>
<a name="l00693"></a>00693 <span class="comment">*</span>
<a name="l00694"></a>00694 <span class="comment">* When the image header keywords for an alternate representation are</span>
<a name="l00695"></a>00695 <span class="comment">* inherited by a binary table image array via WCSHDR_ALLIMG, those</span>
<a name="l00696"></a>00696 <span class="comment">* keywords are considered to be "exhausted" and do not result in a</span>
<a name="l00697"></a>00697 <span class="comment">* separate wcsprm struct. Otherwise they do.</span>
<a name="l00698"></a>00698 <span class="comment">*</span>
<a name="l00699"></a>00699 <span class="comment">* 7: Neither wcspih() nor wcsbth() check for duplicated keywords, in most</span>
<a name="l00700"></a>00700 <span class="comment">* cases they accept the last encountered.</span>
<a name="l00701"></a>00701 <span class="comment">*</span>
<a name="l00702"></a>00702 <span class="comment">* 8: wcspih() and wcsbth() use wcsnpv() and wcsnps() (refer to the prologue</span>
<a name="l00703"></a>00703 <span class="comment">* of wcs.h) to match the size of the pv[] and ps[] arrays in the wcsprm</span>
<a name="l00704"></a>00704 <span class="comment">* structs to the number in the header. Consequently there are no unused</span>
<a name="l00705"></a>00705 <span class="comment">* elements in the pv[] and ps[] arrays, indeed they will often be of</span>
<a name="l00706"></a>00706 <span class="comment">* zero length.</span>
<a name="l00707"></a>00707 <span class="comment">*</span>
<a name="l00708"></a>00708 <span class="comment">* 9: The FITS WCS standard for pixel lists assumes that a pixel list</span>
<a name="l00709"></a>00709 <span class="comment">* defines one and only one image, i.e. that each row of the binary table</span>
<a name="l00710"></a>00710 <span class="comment">* refers to just one event, e.g. the detection of a single photon or</span>
<a name="l00711"></a>00711 <span class="comment">* neutrino.</span>
<a name="l00712"></a>00712 <span class="comment">*</span>
<a name="l00713"></a>00713 <span class="comment">* In the absence of a formal mechanism for identifying the columns</span>
<a name="l00714"></a>00714 <span class="comment">* containing pixel coordinates (as opposed to pixel values or ancillary</span>
<a name="l00715"></a>00715 <span class="comment">* data recorded at the time the photon or neutrino was detected),</span>
<a name="l00716"></a>00716 <span class="comment">* Paper I discusses how the WCS keywords themselves may be used to</span>
<a name="l00717"></a>00717 <span class="comment">* identify them.</span>
<a name="l00718"></a>00718 <span class="comment">*</span>
<a name="l00719"></a>00719 <span class="comment">* In practice, however, pixel lists have been used to store multiple</span>
<a name="l00720"></a>00720 <span class="comment">* images. Besides not specifying how to identify columns, the pixel</span>
<a name="l00721"></a>00721 <span class="comment">* list convention is also silent on the method to be used to associate</span>
<a name="l00722"></a>00722 <span class="comment">* table columns with image axes.</span>
<a name="l00723"></a>00723 <span class="comment">*</span>
<a name="l00724"></a>00724 <span class="comment">* wcsbth() simply collects all WCS keywords for a particular coordinate</span>
<a name="l00725"></a>00725 <span class="comment">* representation (i.e. the "a" value in TCTYna) into one wcsprm struct.</span>
<a name="l00726"></a>00726 <span class="comment">* However, these alternates need not be associated with the same table</span>
<a name="l00727"></a>00727 <span class="comment">* columns and this allows a pixel list to contain up to 27 separate</span>
<a name="l00728"></a>00728 <span class="comment">* images. As usual, if one of these representations happened to contain</span>
<a name="l00729"></a>00729 <span class="comment">* more than two celestial axes, for example, then an error would result</span>
<a name="l00730"></a>00730 <span class="comment">* when wcsset() is invoked on it. In this case the "colsel" argument</span>
<a name="l00731"></a>00731 <span class="comment">* could be used to restrict the columns used to construct the</span>
<a name="l00732"></a>00732 <span class="comment">* representation so that it only contained one pair of celestial axes.</span>
<a name="l00733"></a>00733 <span class="comment">*</span>
<a name="l00734"></a>00734 <span class="comment">*</span>
<a name="l00735"></a>00735 <span class="comment">* wcstab() - Tabular construction routine</span>
<a name="l00736"></a>00736 <span class="comment">* ---------------------------------------</span>
<a name="l00737"></a>00737 <span class="comment">* wcstab() assists in filling in the information in the wcsprm struct relating</span>
<a name="l00738"></a>00738 <span class="comment">* to coordinate lookup tables.</span>
<a name="l00739"></a>00739 <span class="comment">*</span>
<a name="l00740"></a>00740 <span class="comment">* Tabular coordinates ('TAB') present certain difficulties in that the main</span>
<a name="l00741"></a>00741 <span class="comment">* components of the lookup table - the multidimensional coordinate array plus</span>
<a name="l00742"></a>00742 <span class="comment">* an index vector for each dimension - are stored in a FITS binary table</span>
<a name="l00743"></a>00743 <span class="comment">* extension (BINTABLE). Information required to locate these arrays is stored</span>
<a name="l00744"></a>00744 <span class="comment">* in PVi_ma and PSi_ma keywords in the image header.</span>
<a name="l00745"></a>00745 <span class="comment">*</span>
<a name="l00746"></a>00746 <span class="comment">* wcstab() parses the PVi_ma and PSi_ma keywords associated with each 'TAB'</span>
<a name="l00747"></a>00747 <span class="comment">* axis and allocates memory in the wcsprm struct for the required number of</span>
<a name="l00748"></a>00748 <span class="comment">* tabprm structs. It sets as much of the tabprm struct as can be gleaned from</span>
<a name="l00749"></a>00749 <span class="comment">* the image header, and also sets up an array of wtbarr structs (described in</span>
<a name="l00750"></a>00750 <span class="comment">* the prologue of wcs.h) to assist in extracting the required arrays from the</span>
<a name="l00751"></a>00751 <span class="comment">* BINTABLE extension(s).</span>
<a name="l00752"></a>00752 <span class="comment">*</span>
<a name="l00753"></a>00753 <span class="comment">* It is then up to the user to allocate memory for, and copy arrays from the</span>
<a name="l00754"></a>00754 <span class="comment">* BINTABLE extension(s) into the tabprm structs. A CFITSIO routine,</span>
<a name="l00755"></a>00755 <span class="comment">* fits_read_wcstab(), has been provided for this purpose, see getwcstab.h.</span>
<a name="l00756"></a>00756 <span class="comment">* wcsset() will automatically take control of this allocated memory, in</span>
<a name="l00757"></a>00757 <span class="comment">* particular causing it to be free'd by wcsfree(); the user must not attempt</span>
<a name="l00758"></a>00758 <span class="comment">* to free it after wcsset() has been called.</span>
<a name="l00759"></a>00759 <span class="comment">*</span>
<a name="l00760"></a>00760 <span class="comment">* Note that wcspih() and wcsbth() automatically invoke wcstab() on each of the</span>
<a name="l00761"></a>00761 <span class="comment">* wcsprm structs that they return.</span>
<a name="l00762"></a>00762 <span class="comment">*</span>
<a name="l00763"></a>00763 <span class="comment">* Given and returned:</span>
<a name="l00764"></a>00764 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00765"></a>00765 <span class="comment">* Coordinate transformation parameters (see below).</span>
<a name="l00766"></a>00766 <span class="comment">*</span>
<a name="l00767"></a>00767 <span class="comment">* wcstab() sets ntab, tab, nwtb and wtb, allocating</span>
<a name="l00768"></a>00768 <span class="comment">* memory for the tab and wtb arrays. This allocated</span>
<a name="l00769"></a>00769 <span class="comment">* memory will be free'd automatically by wcsfree().</span>
<a name="l00770"></a>00770 <span class="comment">*</span>
<a name="l00771"></a>00771 <span class="comment">* Function return value:</span>
<a name="l00772"></a>00772 <span class="comment">* int Status return value:</span>
<a name="l00773"></a>00773 <span class="comment">* 0: Success.</span>
<a name="l00774"></a>00774 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00775"></a>00775 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00776"></a>00776 <span class="comment">* 3: Invalid tabular parameters.</span>
<a name="l00777"></a>00777 <span class="comment">*</span>
<a name="l00778"></a>00778 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00779"></a>00779 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00780"></a>00780 <span class="comment">*</span>
<a name="l00781"></a>00781 <span class="comment">*</span>
<a name="l00782"></a>00782 <span class="comment">* wcsidx() - Index alternate coordinate representations</span>
<a name="l00783"></a>00783 <span class="comment">* -----------------------------------------------------</span>
<a name="l00784"></a>00784 <span class="comment">* wcsidx() returns an array of 27 indices for the alternate coordinate</span>
<a name="l00785"></a>00785 <span class="comment">* representations in the array of wcsprm structs returned by wcspih(). For</span>
<a name="l00786"></a>00786 <span class="comment">* the array returned by wcsbth() it returns indices for the unattached</span>
<a name="l00787"></a>00787 <span class="comment">* (colnum == 0) representations derived from image header keywords - use</span>
<a name="l00788"></a>00788 <span class="comment">* wcsbdx() for those derived from binary table image arrays or pixel lists</span>
<a name="l00789"></a>00789 <span class="comment">* keywords.</span>
<a name="l00790"></a>00790 <span class="comment">*</span>
<a name="l00791"></a>00791 <span class="comment">* Given:</span>
<a name="l00792"></a>00792 <span class="comment">* nwcs int Number of coordinate representations in the array.</span>
<a name="l00793"></a>00793 <span class="comment">*</span>
<a name="l00794"></a>00794 <span class="comment">* wcs const struct wcsprm**</span>
<a name="l00795"></a>00795 <span class="comment">* Pointer to an array of wcsprm structs returned by</span>
<a name="l00796"></a>00796 <span class="comment">* wcspih() or wcsbth().</span>
<a name="l00797"></a>00797 <span class="comment">*</span>
<a name="l00798"></a>00798 <span class="comment">* Returned:</span>
<a name="l00799"></a>00799 <span class="comment">* alts int[27] Index of each alternate coordinate representation in</span>
<a name="l00800"></a>00800 <span class="comment">* the array: alts[0] for the primary, alts[1] for 'A',</span>
<a name="l00801"></a>00801 <span class="comment">* etc., set to -1 if not present.</span>
<a name="l00802"></a>00802 <span class="comment">*</span>
<a name="l00803"></a>00803 <span class="comment">* For example, if there was no 'P' representation then</span>
<a name="l00804"></a>00804 <span class="comment">*</span>
<a name="l00805"></a>00805 <span class="comment">= alts['P'-'A'+1] == -1;</span>
<a name="l00806"></a>00806 <span class="comment">*</span>
<a name="l00807"></a>00807 <span class="comment">* Otherwise, the address of its wcsprm struct would be</span>
<a name="l00808"></a>00808 <span class="comment">*</span>
<a name="l00809"></a>00809 <span class="comment">= wcs + alts['P'-'A'+1];</span>
<a name="l00810"></a>00810 <span class="comment">*</span>
<a name="l00811"></a>00811 <span class="comment">* Function return value:</span>
<a name="l00812"></a>00812 <span class="comment">* int Status return value:</span>
<a name="l00813"></a>00813 <span class="comment">* 0: Success.</span>
<a name="l00814"></a>00814 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00815"></a>00815 <span class="comment">*</span>
<a name="l00816"></a>00816 <span class="comment">*</span>
<a name="l00817"></a>00817 <span class="comment">* wcsbdx() - Index alternate coordinate representions</span>
<a name="l00818"></a>00818 <span class="comment">* ---------------------------------------------------</span>
<a name="l00819"></a>00819 <span class="comment">* wcsbdx() returns an array of 999 x 27 indices for the alternate coordinate</span>
<a name="l00820"></a>00820 <span class="comment">* representions for binary table image arrays xor pixel lists in the array of</span>
<a name="l00821"></a>00821 <span class="comment">* wcsprm structs returned by wcsbth(). Use wcsidx() for the unattached</span>
<a name="l00822"></a>00822 <span class="comment">* representations derived from image header keywords.</span>
<a name="l00823"></a>00823 <span class="comment">*</span>
<a name="l00824"></a>00824 <span class="comment">* Given:</span>
<a name="l00825"></a>00825 <span class="comment">* nwcs int Number of coordinate representations in the array.</span>
<a name="l00826"></a>00826 <span class="comment">*</span>
<a name="l00827"></a>00827 <span class="comment">* wcs const struct wcsprm**</span>
<a name="l00828"></a>00828 <span class="comment">* Pointer to an array of wcsprm structs returned by</span>
<a name="l00829"></a>00829 <span class="comment">* wcsbth().</span>
<a name="l00830"></a>00830 <span class="comment">*</span>
<a name="l00831"></a>00831 <span class="comment">* type int Select the type of coordinate representation:</span>
<a name="l00832"></a>00832 <span class="comment">* 0: binary table image arrays,</span>
<a name="l00833"></a>00833 <span class="comment">* 1: pixel lists.</span>
<a name="l00834"></a>00834 <span class="comment">*</span>
<a name="l00835"></a>00835 <span class="comment">* Returned:</span>
<a name="l00836"></a>00836 <span class="comment">* alts short[1000][28]</span>
<a name="l00837"></a>00837 <span class="comment">* Index of each alternate coordinate represention in the</span>
<a name="l00838"></a>00838 <span class="comment">* array: alts[col][0] for the primary, alts[col][1] for</span>
<a name="l00839"></a>00839 <span class="comment">* 'A', to alts[col][26] for 'Z', where col is the</span>
<a name="l00840"></a>00840 <span class="comment">* 1-relative column number, and col == 0 is used for</span>
<a name="l00841"></a>00841 <span class="comment">* unattached image headers. Set to -1 if not present.</span>
<a name="l00842"></a>00842 <span class="comment">*</span>
<a name="l00843"></a>00843 <span class="comment">* alts[col][27] counts the number of coordinate</span>
<a name="l00844"></a>00844 <span class="comment">* representations of the chosen type for each column.</span>
<a name="l00845"></a>00845 <span class="comment">*</span>
<a name="l00846"></a>00846 <span class="comment">* For example, if there was no 'P' represention for</span>
<a name="l00847"></a>00847 <span class="comment">* column 13 then</span>
<a name="l00848"></a>00848 <span class="comment">*</span>
<a name="l00849"></a>00849 <span class="comment">= alts[13]['P'-'A'+1] == -1;</span>
<a name="l00850"></a>00850 <span class="comment">*</span>
<a name="l00851"></a>00851 <span class="comment">* Otherwise, the address of its wcsprm struct would be</span>
<a name="l00852"></a>00852 <span class="comment">*</span>
<a name="l00853"></a>00853 <span class="comment">= wcs + alts[13]['P'-'A'+1];</span>
<a name="l00854"></a>00854 <span class="comment">*</span>
<a name="l00855"></a>00855 <span class="comment">* Function return value:</span>
<a name="l00856"></a>00856 <span class="comment">* int Status return value:</span>
<a name="l00857"></a>00857 <span class="comment">* 0: Success.</span>
<a name="l00858"></a>00858 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00859"></a>00859 <span class="comment">*</span>
<a name="l00860"></a>00860 <span class="comment">*</span>
<a name="l00861"></a>00861 <span class="comment">* wcsvfree() - Free the array of wcsprm structs</span>
<a name="l00862"></a>00862 <span class="comment">* ---------------------------------------------</span>
<a name="l00863"></a>00863 <span class="comment">* wcsvfree() frees the memory allocated by wcspih() or wcsbth() for the array</span>
<a name="l00864"></a>00864 <span class="comment">* of wcsprm structs, first invoking wcsfree() on each of the array members.</span>
<a name="l00865"></a>00865 <span class="comment">*</span>
<a name="l00866"></a>00866 <span class="comment">* Given and returned:</span>
<a name="l00867"></a>00867 <span class="comment">* nwcs int* Number of coordinate representations found; set to 0</span>
<a name="l00868"></a>00868 <span class="comment">* on return.</span>
<a name="l00869"></a>00869 <span class="comment">*</span>
<a name="l00870"></a>00870 <span class="comment">* wcs struct wcsprm**</span>
<a name="l00871"></a>00871 <span class="comment">* Pointer to the array of wcsprm structs; set to 0 on</span>
<a name="l00872"></a>00872 <span class="comment">* return.</span>
<a name="l00873"></a>00873 <span class="comment">*</span>
<a name="l00874"></a>00874 <span class="comment">* Function return value:</span>
<a name="l00875"></a>00875 <span class="comment">* int Status return value:</span>
<a name="l00876"></a>00876 <span class="comment">* 0: Success.</span>
<a name="l00877"></a>00877 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00878"></a>00878 <span class="comment">*</span>
<a name="l00879"></a>00879 <span class="comment">*</span>
<a name="l00880"></a>00880 <span class="comment">* wcshdo() - Write out a wcsprm struct as a FITS header</span>
<a name="l00881"></a>00881 <span class="comment">* -----------------------------------------------------</span>
<a name="l00882"></a>00882 <span class="comment">* wcshdo() translates a wcsprm struct into a FITS header. If the colnum</span>
<a name="l00883"></a>00883 <span class="comment">* member of the struct is non-zero then a binary table image array header will</span>
<a name="l00884"></a>00884 <span class="comment">* be produced. Otherwise, if the colax[] member of the struct is set non-zero</span>
<a name="l00885"></a>00885 <span class="comment">* then a pixel list header will be produced. Otherwise, a primary image or</span>
<a name="l00886"></a>00886 <span class="comment">* image extension header will be produced.</span>
<a name="l00887"></a>00887 <span class="comment">*</span>
<a name="l00888"></a>00888 <span class="comment">* If the struct was originally constructed from a header, e.g. by wcspih(),</span>
<a name="l00889"></a>00889 <span class="comment">* the output header will almost certainly differ in a number of respects:</span>
<a name="l00890"></a>00890 <span class="comment">*</span>
<a name="l00891"></a>00891 <span class="comment">* - The output header only contains WCS-related keywords. In particular, it</span>
<a name="l00892"></a>00892 <span class="comment">* does not contain syntactically-required keywords such as SIMPLE, NAXIS,</span>
<a name="l00893"></a>00893 <span class="comment">* BITPIX, or END.</span>
<a name="l00894"></a>00894 <span class="comment">*</span>
<a name="l00895"></a>00895 <span class="comment">* - Deprecated (e.g. CROTAn) or non-standard usage will be translated to</span>
<a name="l00896"></a>00896 <span class="comment">* standard (this is partially dependent on whether wcsfix() was applied).</span>
<a name="l00897"></a>00897 <span class="comment">*</span>
<a name="l00898"></a>00898 <span class="comment">* - Quantities will be converted to the units used internally, basically SI</span>
<a name="l00899"></a>00899 <span class="comment">* with the addition of degrees.</span>
<a name="l00900"></a>00900 <span class="comment">*</span>
<a name="l00901"></a>00901 <span class="comment">* - Floating-point quantities may be given to a different decimal precision.</span>
<a name="l00902"></a>00902 <span class="comment">*</span>
<a name="l00903"></a>00903 <span class="comment">* - Elements of the PCi_ja matrix will be written if and only if they differ</span>
<a name="l00904"></a>00904 <span class="comment">* from the unit matrix. Thus, if the matrix is unity then no elements</span>
<a name="l00905"></a>00905 <span class="comment">* will be written.</span>
<a name="l00906"></a>00906 <span class="comment">*</span>
<a name="l00907"></a>00907 <span class="comment">* - Additional keywords such as WCSAXESa, CUNITia, LONPOLEa and LATPOLEa may</span>
<a name="l00908"></a>00908 <span class="comment">* appear.</span>
<a name="l00909"></a>00909 <span class="comment">*</span>
<a name="l00910"></a>00910 <span class="comment">* - The original keycomments will be lost, although wcshdo() tries hard to</span>
<a name="l00911"></a>00911 <span class="comment">* write meaningful comments.</span>
<a name="l00912"></a>00912 <span class="comment">*</span>
<a name="l00913"></a>00913 <span class="comment">* - Keyword order may be changed.</span>
<a name="l00914"></a>00914 <span class="comment">*</span>
<a name="l00915"></a>00915 <span class="comment">* Keywords can be translated between the image array, binary table, and pixel</span>
<a name="l00916"></a>00916 <span class="comment">* lists forms by manipulating the colnum or colax[] members of the wcsprm</span>
<a name="l00917"></a>00917 <span class="comment">* struct.</span>
<a name="l00918"></a>00918 <span class="comment">*</span>
<a name="l00919"></a>00919 <span class="comment">* Given:</span>
<a name="l00920"></a>00920 <span class="comment">* relax int Degree of permissiveness:</span>
<a name="l00921"></a>00921 <span class="comment">* 0: Recognize only FITS keywords defined by the</span>
<a name="l00922"></a>00922 <span class="comment">* published WCS standard.</span>
<a name="l00923"></a>00923 <span class="comment">* -1: Admit all informal extensions of the WCS</span>
<a name="l00924"></a>00924 <span class="comment">* standard.</span>
<a name="l00925"></a>00925 <span class="comment">* Fine-grained control of the degree of permissiveness</span>
<a name="l00926"></a>00926 <span class="comment">* is also possible as explained in the notes below.</span>
<a name="l00927"></a>00927 <span class="comment">*</span>
<a name="l00928"></a>00928 <span class="comment">* Given and returned:</span>
<a name="l00929"></a>00929 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00930"></a>00930 <span class="comment">* Pointer to a wcsprm struct containing coordinate</span>
<a name="l00931"></a>00931 <span class="comment">* transformation parameters. Will be initialized if</span>
<a name="l00932"></a>00932 <span class="comment">* necessary.</span>
<a name="l00933"></a>00933 <span class="comment">*</span>
<a name="l00934"></a>00934 <span class="comment">* Returned:</span>
<a name="l00935"></a>00935 <span class="comment">* nkeyrec int* Number of FITS header keyrecords returned in the</span>
<a name="l00936"></a>00936 <span class="comment">* "header" array.</span>
<a name="l00937"></a>00937 <span class="comment">*</span>
<a name="l00938"></a>00938 <span class="comment">* header char** Pointer to an array of char holding the header.</span>
<a name="l00939"></a>00939 <span class="comment">* Storage for the array is allocated by wcshdo() in</span>
<a name="l00940"></a>00940 <span class="comment">* blocks of 2880 bytes (32 x 80-character keyrecords)</span>
<a name="l00941"></a>00941 <span class="comment">* and must be free'd by the user to avoid memory leaks.</span>
<a name="l00942"></a>00942 <span class="comment">*</span>
<a name="l00943"></a>00943 <span class="comment">* Each keyrecord is 80 characters long and is *NOT*</span>
<a name="l00944"></a>00944 <span class="comment">* null-terminated, so the first keyrecord starts at</span>
<a name="l00945"></a>00945 <span class="comment">* (*header)[0], the second at (*header)[80], etc.</span>
<a name="l00946"></a>00946 <span class="comment">*</span>
<a name="l00947"></a>00947 <span class="comment">* Function return value:</span>
<a name="l00948"></a>00948 <span class="comment">* int Status return value (associated with wcs_errmsg[]):</span>
<a name="l00949"></a>00949 <span class="comment">* 0: Success.</span>
<a name="l00950"></a>00950 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00951"></a>00951 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00952"></a>00952 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00953"></a>00953 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00954"></a>00954 <span class="comment">* types.</span>
<a name="l00955"></a>00955 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00956"></a>00956 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00957"></a>00957 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00958"></a>00958 <span class="comment">* parameters.</span>
<a name="l00959"></a>00959 <span class="comment">*</span>
<a name="l00960"></a>00960 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00961"></a>00961 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00962"></a>00962 <span class="comment">*</span>
<a name="l00963"></a>00963 <span class="comment">* Notes:</span>
<a name="l00964"></a>00964 <span class="comment">* wcshdo() interprets the "relax" argument as a vector of flag bits to</span>
<a name="l00965"></a>00965 <span class="comment">* provide fine-grained control over what non-standard WCS keywords to write.</span>
<a name="l00966"></a>00966 <span class="comment">* The flag bits are subject to change in future and should be set by using</span>
<a name="l00967"></a>00967 <span class="comment">* the preprocessor macros (see below) for the purpose.</span>
<a name="l00968"></a>00968 <span class="comment">*</span>
<a name="l00969"></a>00969 <span class="comment">* - WCSHDO_none: Don't use any extensions.</span>
<a name="l00970"></a>00970 <span class="comment">*</span>
<a name="l00971"></a>00971 <span class="comment">* - WCSHDO_all: Write all recognized extensions, equivalent to setting each</span>
<a name="l00972"></a>00972 <span class="comment">* flag bit.</span>
<a name="l00973"></a>00973 <span class="comment">*</span>
<a name="l00974"></a>00974 <span class="comment">* - WCSHDO_safe: Write all extensions that are considered to be safe and</span>
<a name="l00975"></a>00975 <span class="comment">* recommended.</span>
<a name="l00976"></a>00976 <span class="comment">*</span>
<a name="l00977"></a>00977 <span class="comment">* - WCSHDO_DOBSn: Write DOBSn, the column-specific analogue of DATE-OBS for</span>
<a name="l00978"></a>00978 <span class="comment">* use in binary tables and pixel lists. WCS Paper III introduced</span>
<a name="l00979"></a>00979 <span class="comment">* DATE-AVG and DAVGn but by an oversight DOBSn (the obvious analogy)</span>
<a name="l00980"></a>00980 <span class="comment">* was never formally defined by the standard. The alternative to</span>
<a name="l00981"></a>00981 <span class="comment">* using DOBSn is to write DATE-OBS which applies to the whole table.</span>
<a name="l00982"></a>00982 <span class="comment">* This usage is considered to be safe and is recommended.</span>
<a name="l00983"></a>00983 <span class="comment">*</span>
<a name="l00984"></a>00984 <span class="comment">* - WCSHDO_TPCn_ka: WCS Paper I defined</span>
<a name="l00985"></a>00985 <span class="comment">*</span>
<a name="l00986"></a>00986 <span class="comment">* - TPn_ka and TCn_ka for pixel lists</span>
<a name="l00987"></a>00987 <span class="comment">*</span>
<a name="l00988"></a>00988 <span class="comment">* but WCS Paper II uses TPCn_ka in one example and subsequently the</span>
<a name="l00989"></a>00989 <span class="comment">* errata for the WCS papers legitimized the use of</span>
<a name="l00990"></a>00990 <span class="comment">*</span>
<a name="l00991"></a>00991 <span class="comment">* - TPCn_ka and TCDn_ka for pixel lists</span>
<a name="l00992"></a>00992 <span class="comment">*</span>
<a name="l00993"></a>00993 <span class="comment">* provided that the keyword does not exceed eight characters. This</span>
<a name="l00994"></a>00994 <span class="comment">* usage is considered to be safe and is recommended because of the</span>
<a name="l00995"></a>00995 <span class="comment">* non-mnemonic terseness of the shorter forms.</span>
<a name="l00996"></a>00996 <span class="comment">*</span>
<a name="l00997"></a>00997 <span class="comment">* - WCSHDO_PVn_ma: WCS Paper I defined</span>
<a name="l00998"></a>00998 <span class="comment">*</span>
<a name="l00999"></a>00999 <span class="comment">* - iVn_ma and iSn_ma for bintables and</span>
<a name="l01000"></a>01000 <span class="comment">* - TVn_ma and TSn_ma for pixel lists</span>
<a name="l01001"></a>01001 <span class="comment">*</span>
<a name="l01002"></a>01002 <span class="comment">* but WCS Paper II uses iPVn_ma and TPVn_ma in the examples and</span>
<a name="l01003"></a>01003 <span class="comment">* subsequently the errata for the WCS papers legitimized the use of</span>
<a name="l01004"></a>01004 <span class="comment">*</span>
<a name="l01005"></a>01005 <span class="comment">* - iPVn_ma and iPSn_ma for bintables and</span>
<a name="l01006"></a>01006 <span class="comment">* - TPVn_ma and TPSn_ma for pixel lists</span>
<a name="l01007"></a>01007 <span class="comment">*</span>
<a name="l01008"></a>01008 <span class="comment">* provided that the keyword does not exceed eight characters. This</span>
<a name="l01009"></a>01009 <span class="comment">* usage is considered to be safe and is recommended because of the</span>
<a name="l01010"></a>01010 <span class="comment">* non-mnemonic terseness of the shorter forms.</span>
<a name="l01011"></a>01011 <span class="comment">*</span>
<a name="l01012"></a>01012 <span class="comment">* - WCSHDO_CRPXna: For historical reasons WCS Paper I defined</span>
<a name="l01013"></a>01013 <span class="comment">*</span>
<a name="l01014"></a>01014 <span class="comment">* - jCRPXn, iCDLTn, iCUNIn, iCTYPn, and iCRVLn for bintables and</span>
<a name="l01015"></a>01015 <span class="comment">* - TCRPXn, TCDLTn, TCUNIn, TCTYPn, and TCRVLn for pixel lists</span>
<a name="l01016"></a>01016 <span class="comment">*</span>
<a name="l01017"></a>01017 <span class="comment">* for use without an alternate version specifier. However, because</span>
<a name="l01018"></a>01018 <span class="comment">* of the eight-character keyword constraint, in order to accommodate</span>
<a name="l01019"></a>01019 <span class="comment">* column numbers greater than 99 WCS Paper I also defined</span>
<a name="l01020"></a>01020 <span class="comment">*</span>
<a name="l01021"></a>01021 <span class="comment">* - jCRPna, iCDEna, iCUNna, iCTYna and iCRVna for bintables and</span>
<a name="l01022"></a>01022 <span class="comment">* - TCRPna, TCDEna, TCUNna, TCTYna and TCRVna for pixel lists</span>
<a name="l01023"></a>01023 <span class="comment">*</span>
<a name="l01024"></a>01024 <span class="comment">* for use with an alternate version specifier (the "a"). Like the</span>
<a name="l01025"></a>01025 <span class="comment">* PC, CD, PV, and PS keywords there is an obvious tendency to</span>
<a name="l01026"></a>01026 <span class="comment">* confuse these two forms for column numbers up to 99. It is very</span>
<a name="l01027"></a>01027 <span class="comment">* unlikely that any parser would reject keywords in the first set</span>
<a name="l01028"></a>01028 <span class="comment">* with a non-blank alternate version specifier so this usage is</span>
<a name="l01029"></a>01029 <span class="comment">* considered to be safe and is recommended.</span>
<a name="l01030"></a>01030 <span class="comment">*</span>
<a name="l01031"></a>01031 <span class="comment">* - WCSHDO_CNAMna: WCS Papers I and III defined</span>
<a name="l01032"></a>01032 <span class="comment">*</span>
<a name="l01033"></a>01033 <span class="comment">* - iCNAna, iCRDna, and iCSYna for bintables and</span>
<a name="l01034"></a>01034 <span class="comment">* - TCNAna, TCRDna, and TCSYna for pixel lists</span>
<a name="l01035"></a>01035 <span class="comment">*</span>
<a name="l01036"></a>01036 <span class="comment">* By analogy with the above, the long forms would be</span>
<a name="l01037"></a>01037 <span class="comment">*</span>
<a name="l01038"></a>01038 <span class="comment">* - iCNAMna, iCRDEna, and iCSYEna for bintables and</span>
<a name="l01039"></a>01039 <span class="comment">* - TCNAMna, TCRDEna, and TCSYEna for pixel lists</span>
<a name="l01040"></a>01040 <span class="comment">*</span>
<a name="l01041"></a>01041 <span class="comment">* Note that these keywords provide auxiliary information only, none</span>
<a name="l01042"></a>01042 <span class="comment">* of them are needed to compute world coordinates. This usage is</span>
<a name="l01043"></a>01043 <span class="comment">* potentially unsafe and is not recommended at this time.</span>
<a name="l01044"></a>01044 <span class="comment">*</span>
<a name="l01045"></a>01045 <span class="comment">* - WCSHDO_WCSNna: In light of wcsbth() note 4, write WCSNna instead of</span>
<a name="l01046"></a>01046 <span class="comment">* TWCSna for pixel lists. While wcsbth() treats WCSNna and TWCSna</span>
<a name="l01047"></a>01047 <span class="comment">* as equivalent, other parsers may not. Consequently, this usage</span>
<a name="l01048"></a>01048 <span class="comment">* is potentially unsafe and is not recommended at this time.</span>
<a name="l01049"></a>01049 <span class="comment">*</span>
<a name="l01050"></a>01050 <span class="comment">*</span>
<a name="l01051"></a>01051 <span class="comment">* Global variable: const char *wcshdr_errmsg[] - Status return messages</span>
<a name="l01052"></a>01052 <span class="comment">* ---------------------------------------------------------------------</span>
<a name="l01053"></a>01053 <span class="comment">* Error messages to match the status value returned from each function.</span>
<a name="l01054"></a>01054 <span class="comment">* Use wcs_errmsg[] for status returns from wcshdo().</span>
<a name="l01055"></a>01055 <span class="comment">*</span>
<a name="l01056"></a>01056 <span class="comment">*===========================================================================*/</span>
<a name="l01057"></a>01057
<a name="l01058"></a>01058 <span class="preprocessor">#ifndef WCSLIB_WCSHDR</span>
<a name="l01059"></a>01059 <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCSHDR</span>
<a name="l01060"></a>01060 <span class="preprocessor"></span>
<a name="l01061"></a>01061 <span class="preprocessor">#include "<a class="code" href="wcs_8h.html">wcs.h</a>"</span>
<a name="l01062"></a>01062
<a name="l01063"></a>01063 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01064"></a>01064 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l01065"></a>01065 <span class="preprocessor">#endif</span>
<a name="l01066"></a>01066 <span class="preprocessor"></span>
<a name="l01067"></a><a class="code" href="wcshdr_8h.html#92a0007f672a5498ab1b6ccc6a4a002b">01067</a> <span class="preprocessor">#define WCSHDR_none 0x00000000</span>
<a name="l01068"></a><a class="code" href="wcshdr_8h.html#0b9b53e5cfd05653cbca75cf1aa8b2ed">01068</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_all 0x000FFFFF</span>
<a name="l01069"></a><a class="code" href="wcshdr_8h.html#fd6d52bed79bd48230f651ac48eb5ca6">01069</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_reject 0x10000000</span>
<a name="l01070"></a>01070 <span class="preprocessor"></span>
<a name="l01071"></a><a class="code" href="wcshdr_8h.html#017f1e817bdb2114ba765e7a9ef73bac">01071</a> <span class="preprocessor">#define WCSHDR_CROTAia 0x00000001</span>
<a name="l01072"></a><a class="code" href="wcshdr_8h.html#5feeef18919b1cbb79729bbfa75976ec">01072</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_EPOCHa 0x00000002</span>
<a name="l01073"></a><a class="code" href="wcshdr_8h.html#fc0a5a6b475a8e50b77d4be099790985">01073</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_VELREFa 0x00000004</span>
<a name="l01074"></a><a class="code" href="wcshdr_8h.html#63eb554461f3df5dc64a25f71891b9f1">01074</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_CD00i00j 0x00000008</span>
<a name="l01075"></a><a class="code" href="wcshdr_8h.html#3dea9d7548bdbc9a7cc8d0a04cdd46fb">01075</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PC00i00j 0x00000010</span>
<a name="l01076"></a><a class="code" href="wcshdr_8h.html#ee4fe41274945f9e34009d2eb309c922">01076</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PROJPn 0x00000020</span>
<a name="l01077"></a><a class="code" href="wcshdr_8h.html#1d506ef2ad493a963426e0732a6328ca">01077</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_RADECSYS 0x00000040</span>
<a name="l01078"></a><a class="code" href="wcshdr_8h.html#1b66d50d7f1927222a170bc88f9db51e">01078</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_VSOURCE 0x00000080</span>
<a name="l01079"></a><a class="code" href="wcshdr_8h.html#dff9a101a373a634f3a1baab29e92534">01079</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_DOBSn 0x00000100</span>
<a name="l01080"></a><a class="code" href="wcshdr_8h.html#e8a768f544fe3ae81436b73dca3099fb">01080</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_LONGKEY 0x00000200</span>
<a name="l01081"></a><a class="code" href="wcshdr_8h.html#df57a609a5c3f7288452cce86210260e">01081</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_CNAMn 0x00000400</span>
<a name="l01082"></a><a class="code" href="wcshdr_8h.html#0e8eb873389e9c15bd6079a96c41ad60">01082</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_AUXIMG 0x00000800</span>
<a name="l01083"></a><a class="code" href="wcshdr_8h.html#33d67fd81c52448aead9e09f32ba9cca">01083</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_ALLIMG 0x00001000</span>
<a name="l01084"></a>01084 <span class="preprocessor"></span>
<a name="l01085"></a><a class="code" href="wcshdr_8h.html#b65e929c7d525d735ae240046d4f0d9c">01085</a> <span class="preprocessor">#define WCSHDR_IMGHEAD 0x00010000</span>
<a name="l01086"></a><a class="code" href="wcshdr_8h.html#a7c5021293b0db20ece0e82c3702a159">01086</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_BIMGARR 0x00020000</span>
<a name="l01087"></a><a class="code" href="wcshdr_8h.html#7bf13ab87b23ecdbbb4b4847d4944070">01087</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDR_PIXLIST 0x00040000</span>
<a name="l01088"></a>01088 <span class="preprocessor"></span>
<a name="l01089"></a><a class="code" href="wcshdr_8h.html#54634ed49425e8842874e9e2b77899df">01089</a> <span class="preprocessor">#define WCSHDO_none 0x00</span>
<a name="l01090"></a><a class="code" href="wcshdr_8h.html#5592649ee4c25e118559c6d283c51930">01090</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_all 0xFF</span>
<a name="l01091"></a><a class="code" href="wcshdr_8h.html#446914676e0b3f55ac6a080015a52b43">01091</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_safe 0x0F</span>
<a name="l01092"></a><a class="code" href="wcshdr_8h.html#6779d48001260a0011b3dcffdcb64cb6">01092</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_DOBSn 0x01</span>
<a name="l01093"></a><a class="code" href="wcshdr_8h.html#96b787f84207faa42599e50e6e078d21">01093</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_TPCn_ka 0x02</span>
<a name="l01094"></a><a class="code" href="wcshdr_8h.html#222a5bd7659f3e1ea1a9ed21f54c50ef">01094</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_PVn_ma 0x04</span>
<a name="l01095"></a><a class="code" href="wcshdr_8h.html#ace96fb8c1499616dd1333af3e8340b0">01095</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_CRPXna 0x08</span>
<a name="l01096"></a><a class="code" href="wcshdr_8h.html#95325b53ebd8d7d0a371a65b27b3d04a">01096</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_CNAMna 0x10</span>
<a name="l01097"></a><a class="code" href="wcshdr_8h.html#9a70ad2a355a9736711d8017535bf72b">01097</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSHDO_WCSNna 0x20</span>
<a name="l01098"></a>01098 <span class="preprocessor"></span>
<a name="l01099"></a>01099
<a name="l01100"></a>01100 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcshdr_8h.html#06cd9297f8315235ba1cf13d1cc115e1" title="Status return messages.">wcshdr_errmsg</a>[];
<a name="l01101"></a>01101
<a name="l01102"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae">01102</a> <span class="keyword">enum</span> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae">wcshdr_errmsg_enum</a> {
<a name="l01103"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdaebfe69dd9e4c486f856a5dc44b02e79a1">01103</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdaebfe69dd9e4c486f856a5dc44b02e79a1">WCSHDRERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span>
<a name="l01104"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae99dd31e274ec97542e650ff89357cded">01104</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae99dd31e274ec97542e650ff89357cded">WCSHDRERR_NULL_POINTER</a> = 1, <span class="comment">/* Null wcsprm pointer passed. */</span>
<a name="l01105"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae0a858638ef0dd0dc9b529f98b14cc46f">01105</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae0a858638ef0dd0dc9b529f98b14cc46f">WCSHDRERR_MEMORY</a> = 2, <span class="comment">/* Memory allocation failed. */</span>
<a name="l01106"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae0c926e2cc98a8c39585aa0e212423459">01106</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae0c926e2cc98a8c39585aa0e212423459">WCSHDRERR_BAD_COLUMN</a> = 3, <span class="comment">/* Invalid column selection. */</span>
<a name="l01107"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae218297c7a2a4d405c251e9ed239e615b">01107</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdae218297c7a2a4d405c251e9ed239e615b">WCSHDRERR_PARSER</a> = 4, <span class="comment">/* Fatal error returned by Flex</span>
<a name="l01108"></a>01108 <span class="comment"> parser. */</span>
<a name="l01109"></a><a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdaeeae58359638c0c631e6c7c573a343508">01109</a> <a class="code" href="wcshdr_8h.html#e2dfc36c150d3a16a5e83131d32ecdaeeae58359638c0c631e6c7c573a343508">WCSHDRERR_BAD_TABULAR_PARAMS</a> = 5 <span class="comment">/* Invalid tabular parameters. */</span>
<a name="l01110"></a>01110 };
<a name="l01111"></a>01111
<a name="l01112"></a>01112 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#c75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih</a>(<span class="keywordtype">char</span> *header, <span class="keywordtype">int</span> nkeyrec, <span class="keywordtype">int</span> relax, <span class="keywordtype">int</span> ctrl, <span class="keywordtype">int</span> *nreject,
<a name="l01113"></a>01113 <span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> **wcs);
<a name="l01114"></a>01114
<a name="l01115"></a>01115 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#dc053d80a9c4da454a52eed34e123633" title="FITS WCS parser routine for binary table and image headers.">wcsbth</a>(<span class="keywordtype">char</span> *header, <span class="keywordtype">int</span> nkeyrec, <span class="keywordtype">int</span> relax, <span class="keywordtype">int</span> ctrl, <span class="keywordtype">int</span> keysel,
<a name="l01116"></a>01116 <span class="keywordtype">int</span> *colsel, <span class="keywordtype">int</span> *nreject, <span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> **wcs);
<a name="l01117"></a>01117
<a name="l01118"></a>01118 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#6dd857f7b61a5b349cc8af5a4b6d8a1c" title="Tabular construction routine.">wcstab</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs);
<a name="l01119"></a>01119
<a name="l01120"></a>01120 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#6174a483baad91dae3fa1c30b0e4cde5" title="Index alternate coordinate representations.">wcsidx</a>(<span class="keywordtype">int</span> nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> **wcs, <span class="keywordtype">int</span> alts[27]);
<a name="l01121"></a>01121
<a name="l01122"></a>01122 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#16e35904c64fe6b0aab144bd022c722f" title="Index alternate coordinate representions.">wcsbdx</a>(<span class="keywordtype">int</span> nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> **wcs, <span class="keywordtype">int</span> type, <span class="keywordtype">short</span> alts[1000][28]);
<a name="l01123"></a>01123
<a name="l01124"></a>01124 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#27465844aaeea0623133f8151ca4fd9b" title="Free the array of wcsprm structs.">wcsvfree</a>(<span class="keywordtype">int</span> *nwcs, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> **wcs);
<a name="l01125"></a>01125
<a name="l01126"></a>01126 <span class="keywordtype">int</span> <a class="code" href="wcshdr_8h.html#0b8372e555a2e2bcc63a11f3dc7a1bf6" title="Write out a wcsprm struct as a FITS header.">wcshdo</a>(<span class="keywordtype">int</span> relax, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keywordtype">int</span> *nkeyrec, <span class="keywordtype">char</span> **header);
<a name="l01127"></a>01127
<a name="l01128"></a>01128
<a name="l01129"></a>01129 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01130"></a>01130 <span class="preprocessor"></span>}
<a name="l01131"></a>01131 <span class="preprocessor">#endif</span>
<a name="l01132"></a>01132 <span class="preprocessor"></span>
<a name="l01133"></a>01133 <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCSHDR */</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>
|
