MUSE Pipeline Reference Manual  0.18.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  *
5  * This file is part of the MUSE Instrument Pipeline
6  * Copyright (C) 2005-2011 European Southern Observatory
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 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 
31 /*----------------------------------------------------------------------------*
32  * Data structures *
33  *----------------------------------------------------------------------------*/
34 
38 /*----------------------------------------------------------------------------*/
42 /*----------------------------------------------------------------------------*/
43 typedef struct {
49  cpl_mask *mask;
56  cpl_propertylist *header;
57 } muse_mask;
58 
61 /*----------------------------------------------------------------------------*
62  * Function prototypes *
63  *----------------------------------------------------------------------------*/
64 
66 muse_mask *muse_mask_load(const char *);
67 cpl_error_code muse_mask_save(muse_mask *, const char *);
69 
70 #endif /* MUSE_MASK_H */
muse_mask * muse_mask_new(void)
Allocate memory for a new muse object.
Definition: muse_mask.c:53
muse_mask * muse_mask_load(const char *)
Load a mask file and its FITS header.
Definition: muse_mask.c:92
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:133
Handling of "mask" files.
Definition: muse_mask.h:43
cpl_propertylist * header
the FITS header
Definition: muse_mask.h:56
void muse_mask_delete(muse_mask *)
Deallocate memory associated to a muse_mask object.
Definition: muse_mask.c:70
cpl_mask * mask
The mask data.
Definition: muse_mask.h:49