WCSLIB: wcslib.h Source File

WCSLIB 7.3.1

wcslib.h
Go to the documentation of this file.
1 /*============================================================================
2 WCSLIB 7.3 - an implementation of the FITS WCS standard.
3 Copyright (C) 1995-2020, Mark Calabretta
4
5 This file is part of WCSLIB.
6
7 WCSLIB is free software: you can redistribute it and/or modify it under the
8 terms of the GNU Lesser General Public License as published by the Free
9 Software Foundation, either version 3 of the License, or (at your option)
10 any later version.
11
12 WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
15 more details.
16
17 You should have received a copy of the GNU Lesser General Public License
18 along with WCSLIB. If not, see http://www.gnu.org/licenses.
19
20 Direct correspondence concerning WCSLIB to mark@calabretta.id.au
21
22 Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.
23 http://www.atnf.csiro.au/people/Mark.Calabretta
24 $Id: wcslib.h,v 7.3.1.2 2020/08/17 11:19:09 mcalabre Exp mcalabre $
25 *=============================================================================
26 *
27 * WCSLIB 7.3 - C routines that implement the FITS World Coordinate System
28 * (WCS) standard. Refer to the README file provided with WCSLIB for an
29 * overview of the library.
30 *
31 * Summary of wcslib.h
32 * -------------------
33 * This header file is provided purely for convenience. Use it to include all
34 * of the separate WCSLIB headers.
35 *
36 *===========================================================================*/
37
38 #ifndef WCSLIB_WCSLIB
39 #define WCSLIB_WCSLIB
40
41 #include "cel.h"
42 #include "dis.h"
43 #include "fitshdr.h"
44 #include "lin.h"
45 #include "log.h"
46 #include "prj.h"
47 #include "spc.h"
48 #include "sph.h"
49 #include "spx.h"
50 #include "tab.h"
51 #include "wcs.h"
52 #include "wcserr.h"
53 #include "wcsfix.h"
54 #include "wcshdr.h"
55 #include "wcsmath.h"
56 #include "wcsprintf.h"
57 #include "wcstrig.h"
58 #include "wcsunits.h"
59 #include "wcsutil.h"
60 #include "wtbarr.h"
61
62 #endif // WCSLIB_WCSLIB
63
3473 wcserr_enable(1);
3474 wcsprintf_set(stderr);
3475
3476 ...
3477
3478 if (wcsset(&wcs) {
3479 wcsperr(&wcs);
3480 return wcs.err->status;
3481 }
3482 @endverbatim
3483 In this example, if an error was generated in one of the prjset() functions,
3484 wcsperr() would print an error traceback starting with wcsset(), then
3485 celset(), and finally the particular projection-setting function that
3486 generated the error. For each of them it would print the status return value,
3487 function name, source file, line number, and an error message which may be
3488 more specific and informative than the general error messages reported in the
3489 first example. For example, in response to a deliberately generated error,
3490 the @c twcs test program, which tests wcserr among other things, produces a
3491 traceback similar to this:
3492 @verbatim
3493 ERROR 5 in wcsset() at line 1564 of file wcs.c:
3494 Invalid parameter value.
3495 ERROR 2 in celset() at line 196 of file cel.c:
3496 Invalid projection parameters.
3497 ERROR 2 in bonset() at line 5727 of file prj.c:
3498 Invalid parameters for Bonne's projection.
3499 @endverbatim
3500
3501 Each of the @ref structs "structs" in @ref overview "WCSLIB" includes a
3502 pointer, called @a err, to a wcserr struct. When an error occurs, a struct is
3503 allocated and error information stored in it. The wcserr pointers and the
3504 @ref memory "memory" allocated for them are managed by the routines that
3505 manage the various structs such as wcsinit() and wcsfree().
3506
3507 wcserr messaging is an opt-in system enabled via wcserr_enable(), as in the
3508 example above. If enabled, when an error occurs it is the user's
3509 responsibility to free the memory allocated for the error message using
3510 wcsfree(), celfree(), prjfree(), etc. Failure to do so before the struct goes
3511 out of scope will result in memory leaks (if execution continues beyond the
3512 error).
3513 */
3514
3515
celset
int celset(struct celprm *cel)
Setup routine for the celprm struct.
celfree
int celfree(struct celprm *cel)
Destructor for the celprm struct.
cel.h
fitshdr.h
spc.h
wcsinit
int wcsinit(int alloc, int naxis, struct wcsprm *wcs, int npvmax, int npsmax, int ndpmax)
Default constructor for the wcsprm struct.
sph.h
wcsprintf.h
wcstrig.h
wcsset
int wcsset(struct wcsprm *wcs)
Setup routine for the wcsprm struct.
wcsfix.h
wcs.h
wcsmath.h
prjfree
int prjfree(struct prjprm *prj)
Destructor for the prjprm struct.
tab.h
log.h
wcsperr
int wcsperr(const struct wcsprm *wcs, const char *prefix)
Print error messages from a wcsprm struct.
prjset
int prjset(struct prjprm *prj)
Generic setup routine for the prjprm struct.
wcserr_enable
int wcserr_enable(int enable)
Enable/disable error messaging.
spx.h
wcserr
Error message handling.
Definition: wcserr.h:222
wcsutil.h
wcsfree
int wcsfree(struct wcsprm *wcs)
Destructor for the wcsprm struct.
wcshdr.h
lin.h
bonset
int bonset(struct prjprm *prj)
Set up a prjprm struct for Bonne's (BON) projection.
wcsprintf_set
int wcsprintf_set(FILE *wcsout)
Set output disposition for wcsprintf() and wcsfprintf().
prj.h
wtbarr.h
dis.h
wcserr.h
wcsunits.h