Skip to content
GitLab
An error occurred while loading the file. Please try again.
Switch branch/tag
Find file BlameHistoryPermalink
fitscat.h 12.21 KiB
Open in Web IDE
1 
/*
2 
*				fitscat.h
3 
*
4 
* Main include file for the LDACTools FITS library.
5 
*
6 
*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 
*
8 
*	This file part of:	AstrOmatic FITS/LDAC library
9 
*
10 
*	Copyright:		(C) 1995-2020 IAP/CNRS/SorbonneU
11 
*
12 
*	License:		GNU General Public License
13 
*
14 
*	AstrOmatic software is free software: you can redistribute it and/or
15 
*	modify it under the terms of the GNU General Public License as
16 
*	published by the Free Software Foundation, either version 3 of the
17 
*	License, or (at your option) any later version.
18 
*	AstrOmatic software is distributed in the hope that it will be useful,
19 
*	but WITHOUT ANY WARRANTY; without even the implied warranty of
20 
*	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 
*	GNU General Public License for more details.
22 
*	You should have received a copy of the GNU General Public License
23 
*	along with AstrOmatic software.
24 
*	If not, see <http://www.gnu.org/licenses/>.
25 
*
26 
*	Last modified:		26/08/2020
27 
*
28 
*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
29
30 
#ifndef _FITSCAT_H_
31 
#define _FITSCAT_H_
32
33 
#include <stdio.h>
34
35 
#ifdef HAVE_SYS_TYPES_H
36 
#include <sys/types.h>
37 
#endif
38
39 
#ifdef HAVE_CFITSIO
40 
#include CFITSIO_H
41 
#endif
42
43 
#define	MAXCHARS	256	/* max. number of characters */
44 
#define WARNING_NMAX	1000	/* max. number of recorded warnings */
45
46 
/*---------------------------- return messages ------------------------------*/
47
48 
#ifndef	RETURN_OK
49 
#define	RETURN_OK		0
50 
#endif
51 
#ifndef	RETURN_ERROR
52 
#define	RETURN_ERROR		(-1)
53 
#endif
54 
#ifndef	RETURN_FATAL_ERROR
55 
#define	RETURN_FATAL_ERROR	(-2)
56 
#endif
57
58 
/*--------------------------- FITS BitPix coding ----------------------------*/
59
60 
#define		BP_BYTE		8
61 
#define		BP_SHORT	16
62 
#define		BP_LONG		32
63 
#define		BP_LONGLONG	64
64 
#define		BP_FLOAT	(-32)
65 
#define		BP_DOUBLE	(-64)
66
67 
/*-------------------------------- macros -----------------------------------*/
68
69 
/* Standard FITS name suffix*/
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
#define FITS_SUFFIX ".fits" /* size (in bytes) of one FITS block */ #define FBSIZE 2880L /* FITS size after adding padding */ #define PADTOTAL(x) (((x-1)/FBSIZE+1)*FBSIZE) /* extra size to add for padding */ #define PADEXTRA(x) ((FBSIZE - (x%FBSIZE))% FBSIZE) /*--------------------------------- typedefs --------------------------------*/ typedef enum {H_INT, H_FLOAT, H_EXPO, H_BOOL, H_STRING, H_STRINGS, H_COMMENT, H_HCOMMENT, H_KEY} h_type; /* type of FITS-header data */ typedef enum {T_BYTE, T_SHORT, T_LONG, T_LONGLONG, T_FLOAT, T_DOUBLE, T_STRING} t_type; /* Type of data */ typedef enum {WRITE_ONLY, READ_ONLY} access_type_t; /* Type of access */ typedef enum {SHOW_ASCII, SHOW_SKYCAT} output_type; /* Type of output */ typedef float PIXTYPE; /* Pixel type */ typedef unsigned int FLAGTYPE; /* Flag type */ #ifdef HAVE_UNSIGNED_LONG_LONG_INT typedef unsigned long long KINGSIZE_T; /* for large sizes */ typedef unsigned long long ULONGLONG; #else typedef size_t KINGSIZE_T;/* better than nothing */ typedef union {unsigned int l[2];} ULONGLONG; #endif #ifdef HAVE_LONG_LONG_INT typedef long long SLONGLONG; #else typedef union {int l[2];} SLONGLONG; #endif // CFITSIO changed OFF_T to OFF_T2 due to clash with cfitsio lib #if defined(_FILE_OFFSET_BITS) && !defined(OFF_T2) #define OFF_T2 off_t #else #define OFF_T2 long #endif /*------------------------------- constants ---------------------------------*/ extern const int t_size[]; /* size in bytes per t_type (see fitshead.c) */ /*---------------------------------- key ------------------------------------*/ typedef struct structkey { char name[80]; /* name */ char comment[80]; /* a comment */ void *ptr; /* pointer to the data */ h_type htype; /* standard ``h_type'' (display) */ t_type ttype; /* standard ``t_type'' (storage) */ char printf[80]; /* printing format (C Convention) */ char unit[80]; /* physical unit */ char voucd[80]; /* VO ucd */ char vounit[80]; /* VO unit */ int naxis; /* number of dimensions */ int *naxisn; /* pointer to an array of dim. */ int nobj; /* number of objects */
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
int nbytes; /* number of bytes per element */ long pos; /* position within file */ struct structkey *prevkey; /* previous key within the chain */ struct structkey *nextkey; /* next key within the chain */ struct structtab *tab; /* (original) parent tab */ int allocflag; /* true if ptr dynamically allocated */ } keystruct; /*------------------------------- catalog ---------------------------------*/ typedef struct structcat { char filename[MAXCHARS]; /* file name */ FILE *file; /* pointer to the file structure */ struct structtab *tab; /* pointer to the first table */ int ntab; /* number of tables included */ access_type_t access_type; /* READ_ONLY or WRITE_ONLY */ } catstruct; /*-------------------------------- table ----------------------------------*/ typedef struct structtab { int bitpix; /* bits per element */ int bytepix; /* bytes per element */ int bitsgn; /* = 0 if unsigned data */ double bscale; /* data scale factor */ double bzero; /* data offset parameter */ int blank; /* integer code for undefined values */ int blankflag; /* set if a blank keyword was found */ enum {COMPRESS_NONE, COMPRESS_BASEBYTE, COMPRESS_PREVPIX} compress_type; /* image compression type */ char *compress_buf; /* de-compression buffer */ char *compress_bufptr; /* present pixel in buffer */ int compress_curval; /* current pixel or checksum value */ int compress_checkval; /* foreseen pixel or checksum value */ size_t compress_npix; /* remaining pixels in buffer */ int naxis; /* number of dimensions */ int *naxisn; /* array of dimensions */ int tfields; /* number of fields */ int pcount, gcount; /* alignment of the data */ KINGSIZE_T tabsize; /* total table size (bytes) */ char xtension[82]; /* FITS extension type */ char extname[82]; /* FITS extension name */ char *headbuf; /* buffer containing the header */ int headnblock; /* number of FITS blocks */ char *bodybuf; /* buffer containing the body */ OFF_T2 bodypos; /* position of the body in the file */ OFF_T2 headpos; /* position of the head in the file */ struct structcat *cat; /* (original) parent catalog */ struct structtab *prevtab, *nexttab; /* previous and next tab in chain */ int seg; /* segment position */ int nseg; /* number of tab segments */ keystruct *key; /* pointer to keys */ int nkey; /* number of keys */ int swapflag; /* mapped to a swap file ? */ char swapname[MAXCHARS]; /* name of the swapfile */ unsigned int bodysum; /* Checksum of the FITS body */ #ifdef HAVE_CFITSIO fitsfile *infptr; /* a cfitsio pointer to the file */ int hdunum; /* FITS HDU number for this 'table' */ int isTileCompressed; /* is this a tile compressed image? */ long currentElement; /* tracks the current image pixel */ #endif } tabstruct; /*------------------------------- functions ---------------------------------*/ extern catstruct *new_cat(int ncat),
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
*read_cat(char *filename), *read_cats(char **filenames, int ncat); extern tabstruct *asc2bin_tab(catstruct *catin, char *tabinname, catstruct *catout, char *taboutname), *init_readobj(tabstruct *tab, char **pbuf), *name_to_tab(catstruct *cat, char *tabname, int seg), *new_tab(char *tabname), *pos_to_tab(catstruct *cat, int pos, int seg); extern keystruct *name_to_key(tabstruct *tab, char *keyname), *new_key(char *keyname), *pos_to_key(tabstruct *tab, int pos), *read_key(tabstruct *tab, char *keyname); extern void add_cleanupfilename(char *filename), cleanup_files(void), copy_tab_fromptr(tabstruct *tabin, catstruct *catout, int pos), encode_checksum(unsigned int sum, char *str), end_readobj(tabstruct *keytab, tabstruct *tab, char *buf), end_writeobj(catstruct *cat, tabstruct *tab, char *buf), error(int code, const char *msg1, const char *msg2), error_installfunc(void (*func)(const char *msg1, const char *msg2)), fixexponent(char *s), free_body(tabstruct *tab), free_cat(catstruct **cat, int ncat), free_key(keystruct *key), free_tab(tabstruct *tab), init_writeobj(catstruct *cat, tabstruct *tab, char **pbuf), install_cleanup(void (*func)(void)), print_obj(FILE *stream, tabstruct *tab), read_keys(tabstruct *tab, char **keynames, keystruct **keys, int nkeys, unsigned char *mask), read_basic(tabstruct *tab), read_body(tabstruct *tab, PIXTYPE *ptr, size_t size), read_ibody(tabstruct *tab, FLAGTYPE *ptr, size_t size), readbasic_head(tabstruct *tab), remove_cleanupfilename(char *filename), save_cat(catstruct *cat, char *filename), save_tab(catstruct *cat, tabstruct *tab), show_keys(tabstruct *tab, char **keynames, keystruct **keys, int nkeys, unsigned char *mask, FILE *stream, int strflag,int banflag, int leadflag, output_type o_type), swapbytes(void *, int, int), ttypeconv(void *ptrin, void *ptrout, t_type ttypein, t_type ttypeout), voprint_obj(FILE *stream, tabstruct *tab), warning(char *, char *), write_body(tabstruct *tab, PIXTYPE *ptr, size_t size), write_ibody(tabstruct *tab, FLAGTYPE *ptr, size_t size), write_checksum(tabstruct *tab); extern char *tdisptoprintf(char *tdisp, char *str), *printftotdisp(char *cprintf, char *str), *fitsnfind(char *fitsbuf, char *str, int nblock), **tabs_list(catstruct *cat, int *n), **keys_list(tabstruct *tab, int *n), *warning_history(void); extern unsigned int compute_blocksum(char *buf, unsigned int sum), compute_bodysum(tabstruct *tab, unsigned int sum), decode_checksum(char *str); extern int about_cat(catstruct *cat, FILE *stream), about_tab(catstruct *cat, char *tabname, FILE *stream), addhistoryto_cat(catstruct *cat, char *str), add_key(keystruct *key, tabstruct *tab, int pos), addkeyto_head(tabstruct *tab, keystruct *key),
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
addkeywordto_head(tabstruct *tab, char *keyword,char *comment), add_tab(tabstruct *tab, catstruct *cat, int pos), blank_keys(tabstruct *tab), close_cat(catstruct *cat), #ifdef HAVE_CFITSIO close_cfitsio(fitsfile *infptr), #endif copy_key(tabstruct *tabin, char *keyname, tabstruct *tabout, int pos), copy_tab(catstruct *catin, char *tabname, int seg, catstruct *catout, int pos), copy_tabs(catstruct *catin, catstruct *catout), copy_tabs_blind(catstruct *catin, catstruct *catout), ext_head(tabstruct *tab), findkey(char *, char *, int), findnkey(char *, char *, int, int), fitsadd(char *fitsbuf, char *keyword, char *comment), fitsfind(char *fitsbuf, char *keyword), fitspick(char *fitsbuf, char *keyword, void *ptr, h_type *htype, t_type *ttype, char *comment), fitsread(char *fitsbuf, char *keyword, void *ptr, h_type htype, t_type ttype), fitsremove(char *fitsbuf, char *keyword), fitswrite(char *fitsbuf, char *keyword, void *ptr, h_type htype, t_type ttype), get_head(tabstruct *tab), inherit_cat(catstruct *catin, catstruct *catout), init_cat(catstruct *cat), map_cat(catstruct *cat), open_cat(catstruct *cat, access_type_t at), pad_tab(catstruct *cat, KINGSIZE_T size), prim_head(tabstruct *tab), readbintabparam_head(tabstruct *tab), read_field(tabstruct *tab, char **keynames, keystruct **keys, int nkeys, int field, tabstruct *ftab), read_obj(tabstruct *keytab, tabstruct *tab, char *buf), read_obj_at(tabstruct *keytab, tabstruct *tab, char *buf, long pos), remove_key(tabstruct *tab, char *keyname), remove_keys(tabstruct *tab), removekeywordfrom_head(tabstruct *tab, char *keyword), remove_tab(catstruct *cat, char *tabname, int seg), remove_tabs(catstruct *cat), save_head(catstruct *cat, tabstruct *tab), set_maxram(size_t maxram), set_maxvram(size_t maxvram), set_swapdir(char *dirname), tab_row_len(char *, char *), tformof(char *str, t_type ttype, int n), tsizeof(char *str), update_head(tabstruct *tab), update_tab(tabstruct *tab), verify_checksum(tabstruct *tab), write_obj(tabstruct *tab, char *buf), wstrncmp(char *, char *, int); extern PIXTYPE *alloc_body(tabstruct *tab, void (*func)(PIXTYPE *ptr, int npix)); extern FLAGTYPE *alloc_ibody(tabstruct *tab, void (*func)(FLAGTYPE *ptr, int npix)); extern t_type ttypeof(char *str); #endif