MUSE Pipeline Reference Manual  2.1.1
muse_mask.h
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim:set sw=2 sts=2 et cin: */
3 /*
4  * This file is part of the MUSE Instrument Pipeline
5  * Copyright (C) 2013 European Southern Observatory
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20  * 02110-1301, USA.
21  */
22 
23 #ifndef MUSE_MASK_H
24 #define MUSE_MASK_H
25 
26 /*----------------------------------------------------------------------------*
27  * Includes *
28  *----------------------------------------------------------------------------*/
29 #include <cpl.h>
30 
34 /*----------------------------------------------------------------------------*
35  * Data structures *
36  *----------------------------------------------------------------------------*/
37 
38 /*----------------------------------------------------------------------------*/
42 /*----------------------------------------------------------------------------*/
43 typedef struct {
49  cpl_mask *mask;
56  cpl_propertylist *header;
57 } muse_mask;
58 
61 /*----------------------------------------------------------------------------*
62  * Function prototypes *
63  *----------------------------------------------------------------------------*/
65 muse_mask *muse_mask_load(const char *);
66 cpl_error_code muse_mask_save(muse_mask *, const char *);
68 
69 #endif /* MUSE_MASK_H */
void muse_mask_delete(muse_mask *)
Deallocate memory associated to a muse_mask object.
Definition: muse_mask.c:78
muse_mask * muse_mask_load(const char *)
Load a mask file and its FITS header.
Definition: muse_mask.c:103
cpl_error_code muse_mask_save(muse_mask *, const char *)
Save the data and the FITS headers of a MUSE mask to a file.
Definition: muse_mask.c:143
muse_mask * muse_mask_new(void)
Allocate memory for a new muse object.
Definition: muse_mask.c:61
Handling of "mask" files.
Definition: muse_mask.h:43
cpl_propertylist * header
the FITS header
Definition: muse_mask.h:56
cpl_mask * mask
The mask data.
Definition: muse_mask.h:49