WCSLIB 6.2

wcslib.h
Go to the documentation of this file.
1 /*============================================================================
2
3 WCSLIB 6.2 - an implementation of the FITS WCS standard.
4 Copyright (C) 1995-2018, Mark Calabretta
5
6 This file is part of WCSLIB.
7
8 WCSLIB is free software: you can redistribute it and/or modify it under the
9 terms of the GNU Lesser General Public License as published by the Free
10 Software Foundation, either version 3 of the License, or (at your option)
11 any later version.
12
13 WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
16 more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with WCSLIB. If not, see http://www.gnu.org/licenses.
20
21 Direct correspondence concerning WCSLIB to mark@calabretta.id.au
22
23 Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.
24 http://www.atnf.csiro.au/people/Mark.Calabretta
25 $Id: wcslib.h,v 6.2 2018/10/20 10:03:13 mcalabre Exp $
26 *=============================================================================
27 *
28 * WCSLIB 6.2 - C routines that implement the FITS World Coordinate System
29 * (WCS) standard. Refer to the README file provided with WCSLIB for an
30 * overview of the library.
31 *
32 * Summary of wcslib.h
33 * -------------------
34 * This header file is provided purely for convenience. Use it to include all
35 * of the separate WCSLIB headers.
36 *
37 *===========================================================================*/
38
39 #ifndef WCSLIB_WCSLIB
40 #define WCSLIB_WCSLIB
41
42 #include "cel.h"
43 #include "dis.h"
44 #include "fitshdr.h"
45 #include "lin.h"
46 #include "log.h"
47 #include "prj.h"
48 #include "spc.h"
49 #include "sph.h"
50 #include "spx.h"
51 #include "tab.h"
52 #include "wcs.h"
53 #include "wcserr.h"
54 #include "wcsfix.h"
55 #include "wcshdr.h"
56 #include "wcsmath.h"
57 #include "wcsprintf.h"
58 #include "wcstrig.h"
59 #include "wcsunits.h"
60 #include "wcsutil.h"
61 #include "wtbarr.h"
62
63 #endif /* WCSLIB_WCSLIB */
64
3374 wcserr_enable(1);
3375 wcsprintf_set(stderr);
3376
3377 ...
3378
3379 if (wcsset(&wcs) {
3380 wcsperr(&wcs);
3381 return wcs.err->status;
3382 }
3383 @endverbatim
3384 In this example, if an error was generated in one of the prjset() functions,
3385 wcsperr() would print an error traceback starting with wcsset(), then
3386 celset(), and finally the particular projection-setting function that
3387 generated the error. For each of them it would print the status return value,
3388 function name, source file, line number, and an error message which may be
3389 more specific and informative than the general error messages reported in the
3390 first example. For example, in response to a deliberately generated error,
3391 the @c twcs test program, which tests wcserr among other things, produces a
3392 traceback similar to this:
3393 @verbatim
3394 ERROR 5 in wcsset() at line 1564 of file wcs.c:
3395 Invalid parameter value.
3396 ERROR 2 in celset() at line 196 of file cel.c:
3397 Invalid projection parameters.
3398 ERROR 2 in bonset() at line 5727 of file prj.c:
3399 Invalid parameters for Bonne's projection.
3400 @endverbatim
3401
3402 Each of the @ref structs "structs" in @ref overview "WCSLIB" includes a
3403 pointer, called @a err, to a wcserr struct. When an error occurs, a struct is
3404 allocated and error information stored in it. The wcserr pointers and the
3405 @ref memory "memory" allocated for them are managed by the routines that
3406 manage the various structs such as wcsinit() and wcsfree().
3407
3408 wcserr messaging is an opt-in system enabled via wcserr_enable(), as in the
3409 example above. If enabled, when an error occurs it is the user's
3410 responsibility to free the memory allocated for the error message using
3411 wcsfree(), celfree(), prjfree(), etc. Failure to do so before the struct goes
3412 out of scope will result in memory leaks (if execution continues beyond the
3413 error).
3414 */
3415
3416
wcsfree
int wcsfree(struct wcsprm *wcs)
Destructor for the wcsprm struct.
dis.h
wcsinit
int wcsinit(int alloc, int naxis, struct wcsprm *wcs, int npvmax, int npsmax, int ndpmax)
Default constructor for the wcsprm struct.
wcshdr.h
lin.h
cel.h
prj.h
wcserr_enable
int wcserr_enable(int enable)
Enable/disable error messaging.
wcserr
Error message handling.
Definition: wcserr.h:223
wcsunits.h
wcsmath.h
spc.h
sph.h
prjfree
int prjfree(struct prjprm *prj)
Destructor for the prjprm struct.
wcsset
int wcsset(struct wcsprm *wcs)
Setup routine for the wcsprm struct.
celfree
int celfree(struct celprm *cel)
Destructor for the celprm struct.
fitshdr.h
wcsprintf_set
int wcsprintf_set(FILE *wcsout)
Set output disposition for wcsprintf() and wcsfprintf().
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.
wcsutil.h
wcsfix.h
wcsprintf.h
bonset
int bonset(struct prjprm *prj)
Set up a prjprm struct for Bonne&#39;s (BON) projection.
wtbarr.h
wcserr.h
wcs.h
tab.h
log.h
wcstrig.h
spx.h
celset
int celset(struct celprm *cel)
Setup routine for the celprm struct.