00001 /*============================================================================ 00002 00003 WCSLIB 4.17 - an implementation of the FITS WCS standard. 00004 Copyright (C) 1995-2013, Mark Calabretta 00005 00006 This file is part of WCSLIB. 00007 00008 WCSLIB is free software: you can redistribute it and/or modify it under the 00009 terms of the GNU Lesser General Public License as published by the Free 00010 Software Foundation, either version 3 of the License, or (at your option) 00011 any later version. 00012 00013 WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY 00014 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for 00016 more details. 00017 00018 You should have received a copy of the GNU Lesser General Public License 00019 along with WCSLIB. If not, see http://www.gnu.org/licenses. 00020 00021 Direct correspondence concerning WCSLIB to mark@calabretta.id.au 00022 00023 Author: Mark Calabretta, Australia Telescope National Facility, CSIRO. 00024 http://www.atnf.csiro.au/people/Mark.Calabretta 00025 $Id: wcshdr.h,v 4.17 2013/01/29 05:29:20 cal103 Exp $ 00026 *============================================================================= 00027 * 00028 * WCSLIB 4.17 - C routines that implement the FITS World Coordinate System 00029 * (WCS) standard. Refer to 00030 * 00031 * "Representations of world coordinates in FITS", 00032 * Greisen, E.W., & Calabretta, M.R. 2002, A&A, 395, 1061 (Paper I) 00033 * 00034 * "Representations of celestial coordinates in FITS", 00035 * Calabretta, M.R., & Greisen, E.W. 2002, A&A, 395, 1077 (Paper II) 00036 * 00037 * "Representations of spectral coordinates in FITS", 00038 * Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L. 00039 * 2006, A&A, 446, 747 (Paper III) 00040 * 00041 * Refer to the README file provided with WCSLIB for an overview of the 00042 * library. 00043 * 00044 * 00045 * Summary of the wcshdr routines 00046 * ------------------------------ 00047 * Routines in this suite are aimed at extracting WCS information from a FITS 00048 * file. They provide the high-level interface between the FITS file and the 00049 * WCS coordinate transformation routines. 00050 * 00051 * Additionally, function wcshdo() is provided to write out the contents of a 00052 * wcsprm struct as a FITS header. 00053 * 00054 * Briefly, the anticipated sequence of operations is as follows: 00055 * 00056 * - 1: Open the FITS file and read the image or binary table header, e.g. 00057 * using CFITSIO routine fits_hdr2str(). 00058 * 00059 * - 2: Parse the header using wcspih() or wcsbth(); they will automatically 00060 * interpret 'TAB' header keywords using wcstab(). 00061 * 00062 * - 3: Allocate memory for, and read 'TAB' arrays from the binary table 00063 * extension, e.g. using CFITSIO routine fits_read_wcstab() - refer to 00064 * the prologue of getwcstab.h. wcsset() will automatically take 00065 * control of this allocated memory, in particular causing it to be 00066 * free'd by wcsfree(). 00067 * 00068 * - 4: Translate non-standard WCS usage using wcsfix(), see wcsfix.h. 00069 * 00070 * - 5: Initialize wcsprm struct(s) using wcsset() and calculate coordinates 00071 * using wcsp2s() and/or wcss2p(). Refer to the prologue of wcs.h for a 00072 * description of these and other high-level WCS coordinate 00073 * transformation routines. 00074 * 00075 * - 6: Clean up by freeing memory with wcsvfree(). 00076 * 00077 * In detail: 00078 * 00079 * - wcspih() is a high-level FITS WCS routine that parses an image header. It 00080 * returns an array of up to 27 wcsprm structs on each of which it invokes 00081 * wcstab(). 00082 * 00083 * - wcsbth() is the analogue of wcspih() for use with binary tables; it 00084 * handles image array and pixel list keywords. As an extension of the FITS 00085 * WCS standard, it also recognizes image header keywords which may be used 00086 * to provide default values via an inheritance mechanism. 00087 * 00088 * - wcstab() assists in filling in members of the wcsprm struct associated 00089 * with coordinate lookup tables ('TAB'). These are based on arrays stored 00090 * in a FITS binary table extension (BINTABLE) that are located by PVi_ma 00091 * keywords in the image header. 00092 * 00093 * - wcsidx() and wcsbdx() are utility routines that return the index for a 00094 * specified alternate coordinate descriptor in the array of wcsprm structs 00095 * returned by wcspih() or wcsbth(). 00096 * 00097 * - wcsvfree() deallocates memory for an array of wcsprm structs, such as 00098 * returned by wcspih() or wcsbth(). 00099 * 00100 * - wcshdo() writes out a wcsprm struct as a FITS header. 00101 * 00102 * 00103 * wcspih() - FITS WCS parser routine for image headers 00104 * ---------------------------------------------------- 00105 * wcspih() is a high-level FITS WCS routine that parses an image header, 00106 * either that of a primary HDU or of an image extension. All WCS keywords 00107 * defined in Papers I, II, and III are recognized, and also those used by the 00108 * AIPS convention and certain other keywords that existed in early drafts of 00109 * the WCS papers as explained in wcsbth() note 5. 00110 * 00111 * Given a character array containing a FITS image header, wcspih() identifies 00112 * and reads all WCS keywords for the primary coordinate representation and up 00113 * to 26 alternate representations. It returns this information as an array of 00114 * wcsprm structs. 00115 * 00116 * wcspih() invokes wcstab() on each of the wcsprm structs that it returns. 00117 * 00118 * Use wcsbth() in preference to wcspih() for FITS headers of unknown type; 00119 * wcsbth() can parse image headers as well as binary table and pixel list 00120 * headers. 00121 * 00122 * Given and returned: 00123 * header char[] Character array containing the (entire) FITS image 00124 * header from which to identify and construct the 00125 * coordinate representations, for example, as might be 00126 * obtained conveniently via the CFITSIO routine 00127 * fits_hdr2str(). 00128 * 00129 * Each header "keyrecord" (formerly "card image") 00130 * consists of exactly 80 7-bit ASCII printing characters 00131 * in the range 0x20 to 0x7e (which excludes NUL, BS, 00132 * TAB, LF, FF and CR) especially noting that the 00133 * keyrecords are NOT null-terminated. 00134 * 00135 * For negative values of ctrl (see below), header[] is 00136 * modified so that WCS keyrecords processed by wcspih() 00137 * are removed from it. 00138 * 00139 * Given: 00140 * nkeyrec int Number of keyrecords in header[]. 00141 * 00142 * relax int Degree of permissiveness: 00143 * 0: Recognize only FITS keywords defined by the 00144 * published WCS standard. 00145 * WCSHDR_all: Admit all recognized informal 00146 * extensions of the WCS standard. 00147 * Fine-grained control of the degree of permissiveness 00148 * is also possible as explained in wcsbth() note 5. 00149 * 00150 * ctrl int Error reporting and other control options for invalid 00151 * WCS and other header keyrecords: 00152 * 0: Do not report any rejected header keyrecords. 00153 * 1: Produce a one-line message stating the number 00154 * of WCS keyrecords rejected (nreject). 00155 * 2: Report each rejected keyrecord and the reason 00156 * why it was rejected. 00157 * 3: As above, but also report all non-WCS 00158 * keyrecords that were discarded, and the number 00159 * of coordinate representations (nwcs) found. 00160 * The report is written to stderr by default, or the 00161 * stream set by wcsprintf_set(). 00162 * 00163 * For ctrl < 0, WCS keyrecords processed by wcspih() 00164 * are removed from header[]: 00165 * -1: Remove only valid WCS keyrecords whose values 00166 * were successfully extracted, nothing is 00167 * reported. 00168 * -2: Also remove WCS keyrecords that were rejected, 00169 * reporting each one and the reason that it was 00170 * rejected. 00171 * -3: As above, and also report the number of 00172 * coordinate representations (nwcs) found. 00173 * -11: Same as -1 but preserving the basic keywords 00174 * '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'. 00175 * If any keyrecords are removed from header[] it will 00176 * be null-terminated (NUL not being a legal FITS header 00177 * character), otherwise it will contain its original 00178 * complement of nkeyrec keyrecords and possibly not be 00179 * null-terminated. 00180 * 00181 * Returned: 00182 * nreject int* Number of WCS keywords rejected for syntax errors, 00183 * illegal values, etc. Keywords not recognized as WCS 00184 * keywords are simply ignored. Refer also to wcsbth() 00185 * note 5. 00186 * 00187 * nwcs int* Number of coordinate representations found. 00188 * 00189 * wcs struct wcsprm** 00190 * Pointer to an array of wcsprm structs containing up to 00191 * 27 coordinate representations. 00192 * 00193 * Memory for the array is allocated by wcspih() which 00194 * also invokes wcsini() for each struct to allocate 00195 * memory for internal arrays and initialize their 00196 * members to default values. Refer also to wcsbth() 00197 * note 8. Note that wcsset() is not invoked on these 00198 * structs. 00199 * 00200 * This allocated memory must be freed by the user, first 00201 * by invoking wcsfree() for each struct, and then by 00202 * freeing the array itself. A routine, wcsvfree(), is 00203 * provided to do this (see below). 00204 * 00205 * Function return value: 00206 * int Status return value: 00207 * 0: Success. 00208 * 1: Null wcsprm pointer passed. 00209 * 2: Memory allocation failed. 00210 * 4: Fatal error returned by Flex parser. 00211 * 00212 * Notes: 00213 * Refer to wcsbth() notes 1, 2, 3, 5, 7, and 8. 00214 * 00215 * 00216 * wcsbth() - FITS WCS parser routine for binary table and image headers 00217 * --------------------------------------------------------------------- 00218 * wcsbth() is a high-level FITS WCS routine that parses a binary table header. 00219 * It handles image array and pixel list WCS keywords which may be present 00220 * together in one header. 00221 * 00222 * As an extension of the FITS WCS standard, wcsbth() also recognizes image 00223 * header keywords in a binary table header. These may be used to provide 00224 * default values via an inheritance mechanism discussed in note 5 (c.f. 00225 * WCSHDR_AUXIMG and WCSHDR_ALLIMG), or may instead result in wcsprm structs 00226 * that are not associated with any particular column. Thus wcsbth() can 00227 * handle primary image and image extension headers in addition to binary table 00228 * headers (it ignores NAXIS and does not rely on the presence of the TFIELDS 00229 * keyword). 00230 * 00231 * All WCS keywords defined in Papers I, II, and III are recognized, and also 00232 * those used by the AIPS convention and certain other keywords that existed in 00233 * early drafts of the WCS papers as explained in note 5 below. 00234 * 00235 * wcsbth() sets the colnum or colax[] members of the wcsprm structs that it 00236 * returns with the column number of an image array or the column numbers 00237 * associated with each pixel coordinate element in a pixel list. wcsprm 00238 * structs that are not associated with any particular column, as may be 00239 * derived from image header keywords, have colnum == 0. 00240 * 00241 * Note 6 below discusses the number of wcsprm structs returned by wcsbth(), 00242 * and the circumstances in which image header keywords cause a struct to be 00243 * created. See also note 9 concerning the number of separate images that may 00244 * be stored in a pixel list. 00245 * 00246 * The API to wcsbth() is similar to that of wcspih() except for the addition 00247 * of extra arguments that may be used to restrict its operation. Like 00248 * wcspih(), wcsbth() invokes wcstab() on each of the wcsprm structs that it 00249 * returns. 00250 * 00251 * Given and returned: 00252 * header char[] Character array containing the (entire) FITS binary 00253 * table, primary image, or image extension header from 00254 * which to identify and construct the coordinate 00255 * representations, for example, as might be obtained 00256 * conveniently via the CFITSIO routine fits_hdr2str(). 00257 * 00258 * Each header "keyrecord" (formerly "card image") 00259 * consists of exactly 80 7-bit ASCII printing 00260 * characters in the range 0x20 to 0x7e (which excludes 00261 * NUL, BS, TAB, LF, FF and CR) especially noting that 00262 * the keyrecords are NOT null-terminated. 00263 * 00264 * For negative values of ctrl (see below), header[] is 00265 * modified so that WCS keyrecords processed by wcsbth() 00266 * are removed from it. 00267 * 00268 * Given: 00269 * nkeyrec int Number of keyrecords in header[]. 00270 * 00271 * relax int Degree of permissiveness: 00272 * 0: Recognize only FITS keywords defined by the 00273 * published WCS standard. 00274 * WCSHDR_all: Admit all recognized informal 00275 * extensions of the WCS standard. 00276 * Fine-grained control of the degree of permissiveness 00277 * is also possible, as explained in note 5 below. 00278 * 00279 * ctrl int Error reporting and other control options for invalid 00280 * WCS and other header keyrecords: 00281 * 0: Do not report any rejected header keyrecords. 00282 * 1: Produce a one-line message stating the number 00283 * of WCS keyrecords rejected (nreject). 00284 * 2: Report each rejected keyrecord and the reason 00285 * why it was rejected. 00286 * 3: As above, but also report all non-WCS 00287 * keyrecords that were discarded, and the number 00288 * of coordinate representations (nwcs) found. 00289 * The report is written to stderr by default, or the 00290 * stream set by wcsprintf_set(). 00291 * 00292 * For ctrl < 0, WCS keyrecords processed by wcsbth() 00293 * are removed from header[]: 00294 * -1: Remove only valid WCS keyrecords whose values 00295 * were successfully extracted, nothing is 00296 * reported. 00297 * -2: Also remove WCS keyrecords that were rejected, 00298 * reporting each one and the reason that it was 00299 * rejected. 00300 * -3: As above, and also report the number of 00301 * coordinate representations (nwcs) found. 00302 * -11: Same as -1 but preserving the basic keywords 00303 * '{DATE,MJD}-{OBS,AVG}' and 'OBSGEO-{X,Y,Z}'. 00304 * If any keyrecords are removed from header[] it will 00305 * be null-terminated (NUL not being a legal FITS header 00306 * character), otherwise it will contain its original 00307 * complement of nkeyrec keyrecords and possibly not be 00308 * null-terminated. 00309 * 00310 * keysel int Vector of flag bits that may be used to restrict the 00311 * keyword types considered: 00312 * WCSHDR_IMGHEAD: Image header keywords. 00313 * WCSHDR_BIMGARR: Binary table image array. 00314 * WCSHDR_PIXLIST: Pixel list keywords. 00315 * If zero, there is no restriction. 00316 * 00317 * Keywords such as EQUIna or RFRQna that are common to 00318 * binary table image arrays and pixel lists (including 00319 * WCSNna and TWCSna, as explained in note 4 below) are 00320 * selected by both WCSHDR_BIMGARR and WCSHDR_PIXLIST. 00321 * Thus if inheritance via WCSHDR_ALLIMG is enabled as 00322 * discussed in note 5 and one of these shared keywords 00323 * is present, then WCSHDR_IMGHEAD and WCSHDR_PIXLIST 00324 * alone may be sufficient to cause the construction of 00325 * coordinate descriptions for binary table image arrays. 00326 * 00327 * colsel int* Pointer to an array of table column numbers used to 00328 * restrict the keywords considered by wcsbth(). 00329 * 00330 * A null pointer may be specified to indicate that there 00331 * is no restriction. Otherwise, the magnitude of 00332 * cols[0] specifies the length of the array: 00333 * cols[0] > 0: the columns are included, 00334 * cols[0] < 0: the columns are excluded. 00335 * 00336 * For the pixel list keywords TPn_ka and TCn_ka (and 00337 * TPCn_ka and TCDn_ka if WCSHDR_LONGKEY is enabled), it 00338 * is an error for one column to be selected but not the 00339 * other. This is unlike the situation with invalid 00340 * keyrecords, which are simply rejected, because the 00341 * error is not intrinsic to the header itself but 00342 * arises in the way that it is processed. 00343 * 00344 * Returned: 00345 * nreject int* Number of WCS keywords rejected for syntax errors, 00346 * illegal values, etc. Keywords not recognized as WCS 00347 * keywords are simply ignored, refer also to note 5 00348 * below. 00349 * 00350 * nwcs int* Number of coordinate representations found. 00351 * 00352 * wcs struct wcsprm** 00353 * Pointer to an array of wcsprm structs containing up 00354 * to 27027 coordinate representations, refer to note 6 00355 * below. 00356 * 00357 * Memory for the array is allocated by wcsbth() which 00358 * also invokes wcsini() for each struct to allocate 00359 * memory for internal arrays and initialize their 00360 * members to default values. Refer also to note 8 00361 * below. Note that wcsset() is not invoked on these 00362 * structs. 00363 * 00364 * This allocated memory must be freed by the user, first 00365 * by invoking wcsfree() for each struct, and then by 00366 * freeing the array itself. A routine, wcsvfree(), is 00367 * provided to do this (see below). 00368 * 00369 * Function return value: 00370 * int Status return value: 00371 * 0: Success. 00372 * 1: Null wcsprm pointer passed. 00373 * 2: Memory allocation failed. 00374 * 3: Invalid column selection. 00375 * 4: Fatal error returned by Flex parser. 00376 * 00377 * Notes: 00378 * 1: wcspih() determines the number of coordinate axes independently for 00379 * each alternate coordinate representation (denoted by the "a" value in 00380 * keywords like CTYPEia) from the higher of 00381 * 00382 * a: NAXIS, 00383 * b: WCSAXESa, 00384 * c: The highest axis number in any parameterized WCS keyword. The 00385 * keyvalue, as well as the keyword, must be syntactically valid 00386 * otherwise it will not be considered. 00387 * 00388 * If none of these keyword types is present, i.e. if the header only 00389 * contains auxiliary WCS keywords for a particular coordinate 00390 * representation, then no coordinate description is constructed for it. 00391 * 00392 * wcsbth() is similar except that it ignores the NAXIS keyword if given 00393 * an image header to process. 00394 * 00395 * The number of axes, which is returned as a member of the wcsprm 00396 * struct, may differ for different coordinate representations of the 00397 * same image. 00398 * 00399 * 2: wcspih() and wcsbth() enforce correct FITS "keyword = value" syntax 00400 * with regard to "= " occurring in columns 9 and 10. 00401 * 00402 * However, they do recognize free-format character (NOST 100-2.0, 00403 * Sect. 5.2.1), integer (Sect. 5.2.3), and floating-point values 00404 * (Sect. 5.2.4) for all keywords. 00405 * 00406 * 3: Where CROTAn, CDi_ja, and PCi_ja occur together in one header wcspih() 00407 * and wcsbth() treat them as described in the prologue to wcs.h. 00408 * 00409 * 4: WCS Paper I mistakenly defined the pixel list form of WCSNAMEa as 00410 * TWCSna instead of WCSNna; the 'T' is meant to substitute for the axis 00411 * number in the binary table form of the keyword - note that keywords 00412 * defined in WCS Papers II and III that are not parameterised by axis 00413 * number have identical forms for binary tables and pixel lists. 00414 * Consequently wcsbth() always treats WCSNna and TWCSna as equivalent. 00415 * 00416 * 5: wcspih() and wcsbth() interpret the "relax" argument as a vector of 00417 * flag bits to provide fine-grained control over what non-standard WCS 00418 * keywords to accept. The flag bits are subject to change in future and 00419 * should be set by using the preprocessor macros (see below) for the 00420 * purpose. 00421 * 00422 * - WCSHDR_none: Don't accept any extensions (not even those in the 00423 * errata). Treat non-conformant keywords in the same way as 00424 * non-WCS keywords in the header, i.e. simply ignore them. 00425 * 00426 * - WCSHDR_all: Accept all extensions recognized by the parser. 00427 * 00428 * - WCSHDR_reject: Reject non-standard keywords (that are not otherwise 00429 * accepted). A message will optionally be printed on stderr by 00430 * default, or the stream set by wcsprintf_set(), as determined by 00431 * the ctrl argument, and nreject will be incremented. 00432 * 00433 * This flag may be used to signal the presence of non-standard 00434 * keywords, otherwise they are simply passed over as though they 00435 * did not exist in the header. 00436 * 00437 * Useful for testing conformance of a FITS header to the WCS 00438 * standard. 00439 * 00440 * - WCSHDR_CROTAia: Accept CROTAia (wcspih()), 00441 * iCROTna (wcsbth()), 00442 * TCROTna (wcsbth()). 00443 * - WCSHDR_EPOCHa: Accept EPOCHa. 00444 * - WCSHDR_VELREFa: Accept VELREFa. 00445 * wcspih() always recognizes the AIPS-convention keywords, 00446 * CROTAn, EPOCH, and VELREF for the primary representation 00447 * (a = ' ') but alternates are non-standard. 00448 * 00449 * wcsbth() accepts EPOCHa and VELREFa only if WCSHDR_AUXIMG is 00450 * also enabled. 00451 * 00452 * - WCSHDR_CD00i00j: Accept CD00i00j (wcspih()). 00453 * - WCSHDR_PC00i00j: Accept PC00i00j (wcspih()). 00454 * - WCSHDR_PROJPn: Accept PROJPn (wcspih()). 00455 * These appeared in early drafts of WCS Paper I+II (before they 00456 * were split) and are equivalent to CDi_ja, PCi_ja, and PVi_ma 00457 * for the primary representation (a = ' '). PROJPn is 00458 * equivalent to PVi_ma with m = n <= 9, and is associated 00459 * exclusively with the latitude axis. 00460 * 00461 * - WCSHDR_RADECSYS: Accept RADECSYS. This appeared in early drafts of 00462 * WCS Paper I+II and was subsequently replaced by RADESYSa. 00463 * 00464 * wcsbth() accepts RADECSYS only if WCSHDR_AUXIMG is also 00465 * enabled. 00466 * 00467 * - WCSHDR_VSOURCE: Accept VSOURCEa or VSOUna (wcsbth()). This appeared 00468 * in early drafts of WCS Paper III and was subsequently dropped 00469 * in favour of ZSOURCEa and ZSOUna. 00470 * 00471 * wcsbth() accepts VSOURCEa only if WCSHDR_AUXIMG is also 00472 * enabled. 00473 * 00474 * - WCSHDR_DOBSn (wcsbth() only): Allow DOBSn, the column-specific analogue 00475 * of DATE-OBS. By an oversight this was never formally defined 00476 * in the standard. 00477 * 00478 * - WCSHDR_LONGKEY (wcsbth() only): Accept long forms of the alternate 00479 * binary table and pixel list WCS keywords, i.e. with "a" non- 00480 * blank. Specifically 00481 * 00482 # jCRPXna TCRPXna : jCRPXn jCRPna TCRPXn TCRPna CRPIXja 00483 # - TPCn_ka : - ijPCna - TPn_ka PCi_ja 00484 # - TCDn_ka : - ijCDna - TCn_ka CDi_ja 00485 # iCDLTna TCDLTna : iCDLTn iCDEna TCDLTn TCDEna CDELTia 00486 # iCUNIna TCUNIna : iCUNIn iCUNna TCUNIn TCUNna CUNITia 00487 # iCTYPna TCTYPna : iCTYPn iCTYna TCTYPn TCTYna CTYPEia 00488 # iCRVLna TCRVLna : iCRVLn iCRVna TCRVLn TCRVna CRVALia 00489 # iPVn_ma TPVn_ma : - iVn_ma - TVn_ma PVi_ma 00490 # iPSn_ma TPSn_ma : - iSn_ma - TSn_ma PSi_ma 00491 * 00492 * where the primary and standard alternate forms together with 00493 * the image-header equivalent are shown rightwards of the colon. 00494 * 00495 * The long form of these keywords could be described as quasi- 00496 * standard. TPCn_ka, iPVn_ma, and TPVn_ma appeared by mistake 00497 * in the examples in WCS Paper II and subsequently these and 00498 * also TCDn_ka, iPSn_ma and TPSn_ma were legitimized by the 00499 * errata to the WCS papers. 00500 * 00501 * Strictly speaking, the other long forms are non-standard and 00502 * in fact have never appeared in any draft of the WCS papers nor 00503 * in the errata. However, as natural extensions of the primary 00504 * form they are unlikely to be written with any other intention. 00505 * Thus it should be safe to accept them provided, of course, 00506 * that the resulting keyword does not exceed the 8-character 00507 * limit. 00508 * 00509 * If WCSHDR_CNAMn is enabled then also accept 00510 * 00511 # iCNAMna TCNAMna : --- iCNAna --- TCNAna CNAMEia 00512 # iCRDEna TCRDEna : --- iCRDna --- TCRDna CRDERia 00513 # iCSYEna TCSYEna : --- iCSYna --- TCSYna CSYERia 00514 * 00515 * Note that CNAMEia, CRDERia, CSYERia, and their variants are 00516 * not used by WCSLIB but are stored in the wcsprm struct as 00517 * auxiliary information. 00518 * 00519 * - WCSHDR_CNAMn (wcsbth() only): Accept iCNAMn, iCRDEn, iCSYEn, TCNAMn, 00520 * TCRDEn, and TCSYEn, i.e. with "a" blank. While non-standard, 00521 * these are the obvious analogues of iCTYPn, TCTYPn, etc. 00522 * 00523 * - WCSHDR_AUXIMG (wcsbth() only): Allow the image-header form of an 00524 * auxiliary WCS keyword with representation-wide scope to 00525 * provide a default value for all images. This default may be 00526 * overridden by the column-specific form of the keyword. 00527 * 00528 * For example, a keyword like EQUINOXa would apply to all image 00529 * arrays in a binary table, or all pixel list columns with 00530 * alternate representation "a" unless overridden by EQUIna. 00531 * 00532 * Specifically the keywords are: 00533 * 00534 # LATPOLEa for LATPna 00535 # LONPOLEa for LONPna 00536 # RESTFREQ for RFRQna 00537 # RESTFRQa for RFRQna 00538 # RESTWAVa for RWAVna 00539 * 00540 * whose keyvalues are actually used by WCSLIB, and also keywords 00541 * that provide auxiliary information that is simply stored in 00542 * the wcsprm struct: 00543 * 00544 # EPOCH - ... (No column-specific form.) 00545 # EPOCHa - ... Only if WCSHDR_EPOCHa is set. 00546 # EQUINOXa for EQUIna 00547 # RADESYSa for RADEna 00548 # RADECSYS for RADEna ... Only if WCSHDR_RADECSYS is set. 00549 # SPECSYSa for SPECna 00550 # SSYSOBSa for SOBSna 00551 # SSYSSRCa for SSRCna 00552 # VELOSYSa for VSYSna 00553 # VELANGLa for VANGna 00554 # VELREF - ... (No column-specific form.) 00555 # VELREFa - ... Only if WCSHDR_VELREFa is set. 00556 # VSOURCEa for VSOUna ... Only if WCSHDR_VSOURCE is set. 00557 # WCSNAMEa for WCSNna ... Or TWCSna (see below). 00558 # ZSOURCEa for ZSOUna 00559 * 00560 # DATE-AVG for DAVGn 00561 # DATE-OBS for DOBSn 00562 # MJD-AVG for MJDAn 00563 # MJD-OBS for MJDOBn 00564 # OBSGEO-X for OBSGXn 00565 # OBSGEO-Y for OBSGYn 00566 # OBSGEO-Z for OBSGZn 00567 * 00568 * where the image-header keywords on the left provide default 00569 * values for the column specific keywords on the right. 00570 * 00571 * Keywords in the last group, such as MJD-OBS, apply to all 00572 * alternate representations, so MJD-OBS would provide a default 00573 * value for all images in the header. 00574 * 00575 * This auxiliary inheritance mechanism applies to binary table 00576 * image arrays and pixel lists alike. Most of these keywords 00577 * have no default value, the exceptions being LONPOLEa and 00578 * LATPOLEa, and also RADESYSa and EQUINOXa which provide 00579 * defaults for each other. Thus the only potential difficulty 00580 * in using WCSHDR_AUXIMG is that of erroneously inheriting one 00581 * of these four keywords. 00582 * 00583 * Unlike WCSHDR_ALLIMG, the existence of one (or all) of these 00584 * auxiliary WCS image header keywords will not by itself cause a 00585 * wcsprm struct to be created for alternate representation "a". 00586 * This is because they do not provide sufficient information to 00587 * create a non-trivial coordinate representation when used in 00588 * conjunction with the default values of those keywords, such as 00589 * CTYPEia, that are parameterized by axis number. 00590 * 00591 * - WCSHDR_ALLIMG (wcsbth() only): Allow the image-header form of *all* 00592 * image header WCS keywords to provide a default value for all 00593 * image arrays in a binary table (n.b. not pixel list). This 00594 * default may be overridden by the column-specific form of the 00595 * keyword. 00596 * 00597 * For example, a keyword like CRPIXja would apply to all image 00598 * arrays in a binary table with alternate representation "a" 00599 * unless overridden by jCRPna. 00600 * 00601 * Specifically the keywords are those listed above for 00602 * WCSHDR_AUXIMG plus 00603 * 00604 # WCSAXESa for WCAXna 00605 * 00606 * which defines the coordinate dimensionality, and the following 00607 * keywords which are parameterized by axis number: 00608 * 00609 # CRPIXja for jCRPna 00610 # PCi_ja for ijPCna 00611 # CDi_ja for ijCDna 00612 # CDELTia for iCDEna 00613 # CROTAi for iCROTn 00614 # CROTAia - ... Only if WCSHDR_CROTAia is set. 00615 # CUNITia for iCUNna 00616 # CTYPEia for iCTYna 00617 # CRVALia for iCRVna 00618 # PVi_ma for iVn_ma 00619 # PSi_ma for iSn_ma 00620 * 00621 # CNAMEia for iCNAna 00622 # CRDERia for iCRDna 00623 # CSYERia for iCSYna 00624 * 00625 * where the image-header keywords on the left provide default 00626 * values for the column specific keywords on the right. 00627 * 00628 * This full inheritance mechanism only applies to binary table 00629 * image arrays, not pixel lists, because in the latter case 00630 * there is no well-defined association between coordinate axis 00631 * number and column number. 00632 * 00633 * Note that CNAMEia, CRDERia, CSYERia, and their variants are 00634 * not used by WCSLIB but are stored in the wcsprm struct as 00635 * auxiliary information. 00636 * 00637 * Note especially that at least one wcsprm struct will be 00638 * returned for each "a" found in one of the image header 00639 * keywords listed above: 00640 * 00641 * - If the image header keywords for "a" ARE NOT inherited by a 00642 * binary table, then the struct will not be associated with 00643 * any particular table column number and it is up to the user 00644 * to provide an association. 00645 * 00646 * - If the image header keywords for "a" ARE inherited by a 00647 * binary table image array, then those keywords are considered 00648 * to be "exhausted" and do not result in a separate wcsprm 00649 * struct. 00650 * 00651 * For example, to accept CD00i00j and PC00i00j and reject all other 00652 * extensions, use 00653 * 00654 = relax = WCSHDR_reject | WCSHDR_CD00i00j | WCSHDR_PC00i00j; 00655 * 00656 * The parser always treats EPOCH as subordinate to EQUINOXa if both are 00657 * present, and VSOURCEa is always subordinate to ZSOURCEa. 00658 * 00659 * Likewise, VELREF is subordinate to the formalism of WCS Paper III, see 00660 * spcaips(). 00661 * 00662 * Neither wcspih() nor wcsbth() currently recognize the AIPS-convention 00663 * keywords ALTRPIX or ALTRVAL which effectively define an alternative 00664 * representation for a spectral axis. 00665 * 00666 * 6: Depending on what flags have been set in its "relax" argument, 00667 * wcsbth() could return as many as 27027 wcsprm structs: 00668 * 00669 * - Up to 27 unattached representations derived from image header 00670 * keywords. 00671 * 00672 * - Up to 27 structs for each of up to 999 columns containing an image 00673 * arrays. 00674 * 00675 * - Up to 27 structs for a pixel list. 00676 * 00677 * Note that it is considered legitimate for a column to contain an image 00678 * array and also form part of a pixel list, and in particular that 00679 * wcsbth() does not check the TFORM keyword for a pixel list column to 00680 * check that it is scalar. 00681 * 00682 * In practice, of course, a realistic binary table header is unlikely to 00683 * contain more than a handful of images. 00684 * 00685 * In order for wcsbth() to create a wcsprm struct for a particular 00686 * coordinate representation, at least one WCS keyword that defines an 00687 * axis number must be present, either directly or by inheritance if 00688 * WCSHDR_ALLIMG is set. 00689 * 00690 * When the image header keywords for an alternate representation are 00691 * inherited by a binary table image array via WCSHDR_ALLIMG, those 00692 * keywords are considered to be "exhausted" and do not result in a 00693 * separate wcsprm struct. Otherwise they do. 00694 * 00695 * 7: Neither wcspih() nor wcsbth() check for duplicated keywords, in most 00696 * cases they accept the last encountered. 00697 * 00698 * 8: wcspih() and wcsbth() use wcsnpv() and wcsnps() (refer to the prologue 00699 * of wcs.h) to match the size of the pv[] and ps[] arrays in the wcsprm 00700 * structs to the number in the header. Consequently there are no unused 00701 * elements in the pv[] and ps[] arrays, indeed they will often be of 00702 * zero length. 00703 * 00704 * 9: The FITS WCS standard for pixel lists assumes that a pixel list 00705 * defines one and only one image, i.e. that each row of the binary table 00706 * refers to just one event, e.g. the detection of a single photon or 00707 * neutrino. 00708 * 00709 * In the absence of a formal mechanism for identifying the columns 00710 * containing pixel coordinates (as opposed to pixel values or ancillary 00711 * data recorded at the time the photon or neutrino was detected), 00712 * Paper I discusses how the WCS keywords themselves may be used to 00713 * identify them. 00714 * 00715 * In practice, however, pixel lists have been used to store multiple 00716 * images. Besides not specifying how to identify columns, the pixel 00717 * list convention is also silent on the method to be used to associate 00718 * table columns with image axes. 00719 * 00720 * wcsbth() simply collects all WCS keywords for a particular coordinate 00721 * representation (i.e. the "a" value in TCTYna) into one wcsprm struct. 00722 * However, these alternates need not be associated with the same table 00723 * columns and this allows a pixel list to contain up to 27 separate 00724 * images. As usual, if one of these representations happened to contain 00725 * more than two celestial axes, for example, then an error would result 00726 * when wcsset() is invoked on it. In this case the "colsel" argument 00727 * could be used to restrict the columns used to construct the 00728 * representation so that it only contained one pair of celestial axes. 00729 * 00730 * 00731 * wcstab() - Tabular construction routine 00732 * --------------------------------------- 00733 * wcstab() assists in filling in the information in the wcsprm struct relating 00734 * to coordinate lookup tables. 00735 * 00736 * Tabular coordinates ('TAB') present certain difficulties in that the main 00737 * components of the lookup table - the multidimensional coordinate array plus 00738 * an index vector for each dimension - are stored in a FITS binary table 00739 * extension (BINTABLE). Information required to locate these arrays is stored 00740 * in PVi_ma and PSi_ma keywords in the image header. 00741 * 00742 * wcstab() parses the PVi_ma and PSi_ma keywords associated with each 'TAB' 00743 * axis and allocates memory in the wcsprm struct for the required number of 00744 * tabprm structs. It sets as much of the tabprm struct as can be gleaned from 00745 * the image header, and also sets up an array of wtbarr structs (described in 00746 * the prologue of wcs.h) to assist in extracting the required arrays from the 00747 * BINTABLE extension(s). 00748 * 00749 * It is then up to the user to allocate memory for, and copy arrays from the 00750 * BINTABLE extension(s) into the tabprm structs. A CFITSIO routine, 00751 * fits_read_wcstab(), has been provided for this purpose, see getwcstab.h. 00752 * wcsset() will automatically take control of this allocated memory, in 00753 * particular causing it to be free'd by wcsfree(); the user must not attempt 00754 * to free it after wcsset() has been called. 00755 * 00756 * Note that wcspih() and wcsbth() automatically invoke wcstab() on each of the 00757 * wcsprm structs that they return. 00758 * 00759 * Given and returned: 00760 * wcs struct wcsprm* 00761 * Coordinate transformation parameters (see below). 00762 * 00763 * wcstab() sets ntab, tab, nwtb and wtb, allocating 00764 * memory for the tab and wtb arrays. This allocated 00765 * memory will be free'd automatically by wcsfree(). 00766 * 00767 * Function return value: 00768 * int Status return value: 00769 * 0: Success. 00770 * 1: Null wcsprm pointer passed. 00771 * 2: Memory allocation failed. 00772 * 3: Invalid tabular parameters. 00773 * 00774 * For returns > 1, a detailed error message is set in 00775 * wcsprm::err if enabled, see wcserr_enable(). 00776 * 00777 * 00778 * wcsidx() - Index alternate coordinate representations 00779 * ----------------------------------------------------- 00780 * wcsidx() returns an array of 27 indices for the alternate coordinate 00781 * representations in the array of wcsprm structs returned by wcspih(). For 00782 * the array returned by wcsbth() it returns indices for the unattached 00783 * (colnum == 0) representations derived from image header keywords - use 00784 * wcsbdx() for those derived from binary table image arrays or pixel lists 00785 * keywords. 00786 * 00787 * Given: 00788 * nwcs int Number of coordinate representations in the array. 00789 * 00790 * wcs const struct wcsprm** 00791 * Pointer to an array of wcsprm structs returned by 00792 * wcspih() or wcsbth(). 00793 * 00794 * Returned: 00795 * alts int[27] Index of each alternate coordinate representation in 00796 * the array: alts[0] for the primary, alts[1] for 'A', 00797 * etc., set to -1 if not present. 00798 * 00799 * For example, if there was no 'P' representation then 00800 * 00801 = alts['P'-'A'+1] == -1; 00802 * 00803 * Otherwise, the address of its wcsprm struct would be 00804 * 00805 = wcs + alts['P'-'A'+1]; 00806 * 00807 * Function return value: 00808 * int Status return value: 00809 * 0: Success. 00810 * 1: Null wcsprm pointer passed. 00811 * 00812 * 00813 * wcsbdx() - Index alternate coordinate representions 00814 * --------------------------------------------------- 00815 * wcsbdx() returns an array of 999 x 27 indices for the alternate coordinate 00816 * representions for binary table image arrays xor pixel lists in the array of 00817 * wcsprm structs returned by wcsbth(). Use wcsidx() for the unattached 00818 * representations derived from image header keywords. 00819 * 00820 * Given: 00821 * nwcs int Number of coordinate representations in the array. 00822 * 00823 * wcs const struct wcsprm** 00824 * Pointer to an array of wcsprm structs returned by 00825 * wcsbth(). 00826 * 00827 * type int Select the type of coordinate representation: 00828 * 0: binary table image arrays, 00829 * 1: pixel lists. 00830 * 00831 * Returned: 00832 * alts short[1000][28] 00833 * Index of each alternate coordinate represention in the 00834 * array: alts[col][0] for the primary, alts[col][1] for 00835 * 'A', to alts[col][26] for 'Z', where col is the 00836 * 1-relative column number, and col == 0 is used for 00837 * unattached image headers. Set to -1 if not present. 00838 * 00839 * alts[col][27] counts the number of coordinate 00840 * representations of the chosen type for each column. 00841 * 00842 * For example, if there was no 'P' represention for 00843 * column 13 then 00844 * 00845 = alts[13]['P'-'A'+1] == -1; 00846 * 00847 * Otherwise, the address of its wcsprm struct would be 00848 * 00849 = wcs + alts[13]['P'-'A'+1]; 00850 * 00851 * Function return value: 00852 * int Status return value: 00853 * 0: Success. 00854 * 1: Null wcsprm pointer passed. 00855 * 00856 * 00857 * wcsvfree() - Free the array of wcsprm structs 00858 * --------------------------------------------- 00859 * wcsvfree() frees the memory allocated by wcspih() or wcsbth() for the array 00860 * of wcsprm structs, first invoking wcsfree() on each of the array members. 00861 * 00862 * Given and returned: 00863 * nwcs int* Number of coordinate representations found; set to 0 00864 * on return. 00865 * 00866 * wcs struct wcsprm** 00867 * Pointer to the array of wcsprm structs; set to 0 on 00868 * return. 00869 * 00870 * Function return value: 00871 * int Status return value: 00872 * 0: Success. 00873 * 1: Null wcsprm pointer passed. 00874 * 00875 * 00876 * wcshdo() - Write out a wcsprm struct as a FITS header 00877 * ----------------------------------------------------- 00878 * wcshdo() translates a wcsprm struct into a FITS header. If the colnum 00879 * member of the struct is non-zero then a binary table image array header will 00880 * be produced. Otherwise, if the colax[] member of the struct is set non-zero 00881 * then a pixel list header will be produced. Otherwise, a primary image or 00882 * image extension header will be produced. 00883 * 00884 * If the struct was originally constructed from a header, e.g. by wcspih(), 00885 * the output header will almost certainly differ in a number of respects: 00886 * 00887 * - The output header only contains WCS-related keywords. In particular, it 00888 * does not contain syntactically-required keywords such as SIMPLE, NAXIS, 00889 * BITPIX, or END. 00890 * 00891 * - Deprecated (e.g. CROTAn) or non-standard usage will be translated to 00892 * standard (this is partially dependent on whether wcsfix() was applied). 00893 * 00894 * - Quantities will be converted to the units used internally, basically SI 00895 * with the addition of degrees. 00896 * 00897 * - Floating-point quantities may be given to a different decimal precision. 00898 * 00899 * - Elements of the PCi_ja matrix will be written if and only if they differ 00900 * from the unit matrix. Thus, if the matrix is unity then no elements 00901 * will be written. 00902 * 00903 * - Additional keywords such as WCSAXESa, CUNITia, LONPOLEa and LATPOLEa may 00904 * appear. 00905 * 00906 * - The original keycomments will be lost, although wcshdo() tries hard to 00907 * write meaningful comments. 00908 * 00909 * - Keyword order may be changed. 00910 * 00911 * Keywords can be translated between the image array, binary table, and pixel 00912 * lists forms by manipulating the colnum or colax[] members of the wcsprm 00913 * struct. 00914 * 00915 * Given: 00916 * relax int Degree of permissiveness: 00917 * 0: Recognize only FITS keywords defined by the 00918 * published WCS standard. 00919 * -1: Admit all informal extensions of the WCS 00920 * standard. 00921 * Fine-grained control of the degree of permissiveness 00922 * is also possible as explained in the notes below. 00923 * 00924 * Given and returned: 00925 * wcs struct wcsprm* 00926 * Pointer to a wcsprm struct containing coordinate 00927 * transformation parameters. Will be initialized if 00928 * necessary. 00929 * 00930 * Returned: 00931 * nkeyrec int* Number of FITS header keyrecords returned in the 00932 * "header" array. 00933 * 00934 * header char** Pointer to an array of char holding the header. 00935 * Storage for the array is allocated by wcshdo() in 00936 * blocks of 2880 bytes (32 x 80-character keyrecords) 00937 * and must be free'd by the user to avoid memory leaks. 00938 * 00939 * Each keyrecord is 80 characters long and is *NOT* 00940 * null-terminated, so the first keyrecord starts at 00941 * (*header)[0], the second at (*header)[80], etc. 00942 * 00943 * Function return value: 00944 * int Status return value (associated with wcs_errmsg[]): 00945 * 0: Success. 00946 * 1: Null wcsprm pointer passed. 00947 * 2: Memory allocation failed. 00948 * 3: Linear transformation matrix is singular. 00949 * 4: Inconsistent or unrecognized coordinate axis 00950 * types. 00951 * 5: Invalid parameter value. 00952 * 6: Invalid coordinate transformation parameters. 00953 * 7: Ill-conditioned coordinate transformation 00954 * parameters. 00955 * 00956 * For returns > 1, a detailed error message is set in 00957 * wcsprm::err if enabled, see wcserr_enable(). 00958 * 00959 * Notes: 00960 * wcshdo() interprets the "relax" argument as a vector of flag bits to 00961 * provide fine-grained control over what non-standard WCS keywords to write. 00962 * The flag bits are subject to change in future and should be set by using 00963 * the preprocessor macros (see below) for the purpose. 00964 * 00965 * - WCSHDO_none: Don't use any extensions. 00966 * 00967 * - WCSHDO_all: Write all recognized extensions, equivalent to setting each 00968 * flag bit. 00969 * 00970 * - WCSHDO_safe: Write all extensions that are considered to be safe and 00971 * recommended. 00972 * 00973 * - WCSHDO_DOBSn: Write DOBSn, the column-specific analogue of DATE-OBS for 00974 * use in binary tables and pixel lists. WCS Paper III introduced 00975 * DATE-AVG and DAVGn but by an oversight DOBSn (the obvious analogy) 00976 * was never formally defined by the standard. The alternative to 00977 * using DOBSn is to write DATE-OBS which applies to the whole table. 00978 * This usage is considered to be safe and is recommended. 00979 * 00980 * - WCSHDO_TPCn_ka: WCS Paper I defined 00981 * 00982 * - TPn_ka and TCn_ka for pixel lists 00983 * 00984 * but WCS Paper II uses TPCn_ka in one example and subsequently the 00985 * errata for the WCS papers legitimized the use of 00986 * 00987 * - TPCn_ka and TCDn_ka for pixel lists 00988 * 00989 * provided that the keyword does not exceed eight characters. This 00990 * usage is considered to be safe and is recommended because of the 00991 * non-mnemonic terseness of the shorter forms. 00992 * 00993 * - WCSHDO_PVn_ma: WCS Paper I defined 00994 * 00995 * - iVn_ma and iSn_ma for bintables and 00996 * - TVn_ma and TSn_ma for pixel lists 00997 * 00998 * but WCS Paper II uses iPVn_ma and TPVn_ma in the examples and 00999 * subsequently the errata for the WCS papers legitimized the use of 01000 * 01001 * - iPVn_ma and iPSn_ma for bintables and 01002 * - TPVn_ma and TPSn_ma for pixel lists 01003 * 01004 * provided that the keyword does not exceed eight characters. This 01005 * usage is considered to be safe and is recommended because of the 01006 * non-mnemonic terseness of the shorter forms. 01007 * 01008 * - WCSHDO_CRPXna: For historical reasons WCS Paper I defined 01009 * 01010 * - jCRPXn, iCDLTn, iCUNIn, iCTYPn, and iCRVLn for bintables and 01011 * - TCRPXn, TCDLTn, TCUNIn, TCTYPn, and TCRVLn for pixel lists 01012 * 01013 * for use without an alternate version specifier. However, because 01014 * of the eight-character keyword constraint, in order to accommodate 01015 * column numbers greater than 99 WCS Paper I also defined 01016 * 01017 * - jCRPna, iCDEna, iCUNna, iCTYna and iCRVna for bintables and 01018 * - TCRPna, TCDEna, TCUNna, TCTYna and TCRVna for pixel lists 01019 * 01020 * for use with an alternate version specifier (the "a"). Like the 01021 * PC, CD, PV, and PS keywords there is an obvious tendency to 01022 * confuse these two forms for column numbers up to 99. It is very 01023 * unlikely that any parser would reject keywords in the first set 01024 * with a non-blank alternate version specifier so this usage is 01025 * considered to be safe and is recommended. 01026 * 01027 * - WCSHDO_CNAMna: WCS Papers I and III defined 01028 * 01029 * - iCNAna, iCRDna, and iCSYna for bintables and 01030 * - TCNAna, TCRDna, and TCSYna for pixel lists 01031 * 01032 * By analogy with the above, the long forms would be 01033 * 01034 * - iCNAMna, iCRDEna, and iCSYEna for bintables and 01035 * - TCNAMna, TCRDEna, and TCSYEna for pixel lists 01036 * 01037 * Note that these keywords provide auxiliary information only, none 01038 * of them are needed to compute world coordinates. This usage is 01039 * potentially unsafe and is not recommended at this time. 01040 * 01041 * - WCSHDO_WCSNna: In light of wcsbth() note 4, write WCSNna instead of 01042 * TWCSna for pixel lists. While wcsbth() treats WCSNna and TWCSna 01043 * as equivalent, other parsers may not. Consequently, this usage 01044 * is potentially unsafe and is not recommended at this time. 01045 * 01046 * 01047 * Global variable: const char *wcshdr_errmsg[] - Status return messages 01048 * --------------------------------------------------------------------- 01049 * Error messages to match the status value returned from each function. 01050 * Use wcs_errmsg[] for status returns from wcshdo(). 01051 * 01052 *===========================================================================*/ 01053 01054 #ifndef WCSLIB_WCSHDR 01055 #define WCSLIB_WCSHDR 01056 01057 #include "wcs.h" 01058 01059 #ifdef __cplusplus 01060 extern "C" { 01061 #endif 01062 01063 #define WCSHDR_none 0x00000000 01064 #define WCSHDR_all 0x000FFFFF 01065 #define WCSHDR_reject 0x10000000 01066 01067 #define WCSHDR_CROTAia 0x00000001 01068 #define WCSHDR_EPOCHa 0x00000002 01069 #define WCSHDR_VELREFa 0x00000004 01070 #define WCSHDR_CD00i00j 0x00000008 01071 #define WCSHDR_PC00i00j 0x00000010 01072 #define WCSHDR_PROJPn 0x00000020 01073 #define WCSHDR_RADECSYS 0x00000040 01074 #define WCSHDR_VSOURCE 0x00000080 01075 #define WCSHDR_DOBSn 0x00000100 01076 #define WCSHDR_LONGKEY 0x00000200 01077 #define WCSHDR_CNAMn 0x00000400 01078 #define WCSHDR_AUXIMG 0x00000800 01079 #define WCSHDR_ALLIMG 0x00001000 01080 01081 #define WCSHDR_IMGHEAD 0x00010000 01082 #define WCSHDR_BIMGARR 0x00020000 01083 #define WCSHDR_PIXLIST 0x00040000 01084 01085 #define WCSHDO_none 0x00 01086 #define WCSHDO_all 0xFF 01087 #define WCSHDO_safe 0x0F 01088 #define WCSHDO_DOBSn 0x01 01089 #define WCSHDO_TPCn_ka 0x02 01090 #define WCSHDO_PVn_ma 0x04 01091 #define WCSHDO_CRPXna 0x08 01092 #define WCSHDO_CNAMna 0x10 01093 #define WCSHDO_WCSNna 0x20 01094 01095 01096 extern const char *wcshdr_errmsg[]; 01097 01098 enum wcshdr_errmsg_enum { 01099 WCSHDRERR_SUCCESS = 0, /* Success. */ 01100 WCSHDRERR_NULL_POINTER = 1, /* Null wcsprm pointer passed. */ 01101 WCSHDRERR_MEMORY = 2, /* Memory allocation failed. */ 01102 WCSHDRERR_BAD_COLUMN = 3, /* Invalid column selection. */ 01103 WCSHDRERR_PARSER = 4, /* Fatal error returned by Flex 01104 parser. */ 01105 WCSHDRERR_BAD_TABULAR_PARAMS = 5 /* Invalid tabular parameters. */ 01106 }; 01107 01108 int wcspih(char *header, int nkeyrec, int relax, int ctrl, int *nreject, 01109 int *nwcs, struct wcsprm **wcs); 01110 01111 int wcsbth(char *header, int nkeyrec, int relax, int ctrl, int keysel, 01112 int *colsel, int *nreject, int *nwcs, struct wcsprm **wcs); 01113 01114 int wcstab(struct wcsprm *wcs); 01115 01116 int wcsidx(int nwcs, struct wcsprm **wcs, int alts[27]); 01117 01118 int wcsbdx(int nwcs, struct wcsprm **wcs, int type, short alts[1000][28]); 01119 01120 int wcsvfree(int *nwcs, struct wcsprm **wcs); 01121 01122 int wcshdo(int relax, struct wcsprm *wcs, int *nkeyrec, char **header); 01123 01124 01125 #ifdef __cplusplus 01126 } 01127 #endif 01128 01129 #endif /* WCSLIB_WCSHDR */