WCSLIB  4.25.1
wcslib.h
Go to the documentation of this file.
1 /*============================================================================
2 
3  WCSLIB 5.1 - an implementation of the FITS WCS standard.
4  Copyright (C) 1995-2015, 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 5.1 2015/04/07 10:56:36 mcalabre Exp $
26 *=============================================================================
27 *
28 * WCSLIB 5.1 - C routines that implement the FITS World Coordinate System
29 * (WCS) standard.
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 
61 #endif /* WCSLIB_WCSLIB */
62 
2822  wcserr_enable(1);
2823  wcsprintf_set(stderr);
2824 
2825  ...
2826 
2827  if (wcsset(&wcs) {
2828  wcsperr(&wcs);
2829  return wcs.err->status;
2830  }
2831 @endverbatim
2832 In this example, if an error was generated in one of the prjset() functions,
2833 wcsperr() would print an error traceback starting with wcsset(), then
2834 celset(), and finally the particular projection-setting function that
2835 generated the error. For each of them it would print the status return value,
2836 function name, source file, line number, and an error message which may be
2837 more specific and informative than the general error messages reported in the
2838 first example. For example, in response to a deliberately generated error,
2839 the @c twcs test program, which tests wcserr among other things, produces a
2840 traceback similar to this:
2841 @verbatim
2842 ERROR 5 in wcsset() at line 1564 of file wcs.c:
2843  Invalid parameter value.
2844 ERROR 2 in celset() at line 196 of file cel.c:
2845  Invalid projection parameters.
2846 ERROR 2 in bonset() at line 5727 of file prj.c:
2847  Invalid parameters for Bonne's projection.
2848 @endverbatim
2849 
2850 Each of the @ref structs "structs" in @ref overview "WCSLIB" includes a
2851 pointer, called @a err, to a wcserr struct. When an error occurs, a struct is
2852 allocated and error information stored in it. The wcserr pointers and the
2853 @ref memory "memory" allocated for them are managed by the routines that
2854 manage the various structs such as wcsini() and wcsfree().
2855 
2856 wcserr messaging is an opt-in system enabled via wcserr_enable(), as in the
2857 example above. If enabled, when an error occurs it is the user's
2858 responsibility to free the memory allocated for the error message using
2859 wcsfree(), celfree(), prjfree(), etc. Failure to do so before the struct goes
2860 out of scope will result in memory leaks (if execution continues beyond the
2861 error).
2862 */
2863 
2864 
int wcsfree(struct wcsprm *wcs)
Destructor for the wcsprm struct.
int wcserr_enable(int enable)
Enable/disable error messaging.
Error message handling.
Definition: wcserr.h:221
int prjfree(struct prjprm *prj)
Destructor for the prjprm struct.
int wcsset(struct wcsprm *wcs)
Setup routine for the wcsprm struct.
int celfree(struct celprm *cel)
Destructor for the celprm struct.
int wcsprintf_set(FILE *wcsout)
Set output disposition for wcsprintf() and wcsfprintf().
int wcsperr(const struct wcsprm *wcs, const char *prefix)
Print error messages from a wcsprm struct.
int prjset(struct prjprm *prj)
Generic setup routine for the prjprm struct.
int bonset(struct prjprm *prj)
Set up a prjprm struct for Bonne's (BON) projection.
int wcsini(int alloc, int naxis, struct wcsprm *wcs)
Default constructor for the wcsprm struct.
int celset(struct celprm *cel)
Setup routine for the celprm struct.