MUSE Pipeline Reference Manual  2.1.1
muse_basicproc.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) 2008-2014 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 02110-1301, USA.
20  */
21 
22 #ifndef MUSE_BASICPROC_H
23 #define MUSE_BASICPROC_H
24 
25 #include <cpl.h>
26 
27 #include "muse_artifacts.h"
28 #include "muse_datacube.h"
29 #include "muse_imagelist.h"
30 #include "muse_processing.h"
31 #include "muse_pixtable.h"
32 
33 /*----------------------------------------------------------------------------*
34  * Special variable types *
35  *----------------------------------------------------------------------------*/
36 
40 /*----------------------------------------------------------------------------*/
44 /*----------------------------------------------------------------------------*/
45 typedef struct {
46  char *overscan;
47  char *rejection;
48  double ovscsigma;
49  unsigned int ovscignore;
52  char *crmethod;
53  unsigned dcrxbox;
54  unsigned dcrybox;
55  unsigned dcrpasses;
57  float dcrthres;
58 
59  cpl_boolean keepflat;
62 
65 /*----------------------------------------------------------------------------*
66  * Function prototypes *
67  *----------------------------------------------------------------------------*/
68 muse_basicproc_params *muse_basicproc_params_new(cpl_parameterlist *, const char *);
71 
74 cpl_table *muse_basicproc_get_illum(muse_imagelist *, cpl_table *, cpl_table *, cpl_table *);
75 cpl_error_code muse_basicproc_apply_illum(muse_pixtable *, cpl_table *);
77 cpl_error_code muse_basicproc_mask_notch_filter(muse_pixtable *, unsigned char);
79 cpl_error_code muse_basicproc_shift_pixtable(muse_pixtable *, cpl_array *, double, double, float, float, unsigned char);
80 cpl_error_code muse_basicproc_stats_append_header(cpl_image *, cpl_propertylist *, const char *, unsigned);
81 cpl_error_code muse_basicproc_stats_append_header_window(cpl_image *, cpl_propertylist *, const char *, unsigned, int, int, int, int);
82 
83 cpl_error_code muse_basicproc_qc_saturated(muse_image *, const char *);
84 
85 #endif /* MUSE_BASICPROC_H */
muse_imagelist * muse_basicproc_load(muse_processing *, unsigned char, muse_basicproc_params *)
Load the raw input files from disk and do basic processing.
Structure definition of a MUSE datacube.
Definition: muse_datacube.h:48
Structure definition for a collection of muse_images.
muse_imagelist * muse_basicproc_combine_images_lampwise(muse_processing *, unsigned char, muse_basicproc_params *, cpl_frameset ***)
Combine several images into a lampwise image list.
muse_imagelist * muse_basicproc_load_reduced(muse_processing *, unsigned char)
Load reduced input files from disk.
muse_basicproc_params * muse_basicproc_params_new(cpl_parameterlist *, const char *)
Create a new structure of basic processing parameters.
muse_image * flatimage
Structure definition of MUSE three extension FITS file.
Definition: muse_image.h:40
unsigned int ovscignore
void muse_basicproc_params_delete(muse_basicproc_params *)
Free a structure of basic processing parameters.
Structure definition of MUSE pixel table.
cpl_error_code muse_basicproc_shift_pixtable(muse_pixtable *, cpl_array *, double, double, float, float, unsigned char)
Compute wavelength corrections for science data based on reference sky lines.
cpl_error_code muse_basicproc_apply_twilight(muse_pixtable *, muse_datacube *)
Apply an attached flat-field to a pixel table.
cpl_error_code muse_basicproc_stats_append_header_window(cpl_image *, cpl_propertylist *, const char *, unsigned, int, int, int, int)
Compute image statistics of an image window and add them to a header.
cpl_error_code muse_basicproc_stats_append_header(cpl_image *, cpl_propertylist *, const char *, unsigned)
Compute image statistics of an image and add them to a header.
cpl_table * muse_basicproc_get_illum(muse_imagelist *, cpl_table *, cpl_table *, cpl_table *)
Get an illum/attached flat-field from an imagelist and prepare it for use.
cpl_error_code muse_basicproc_mask_notch_filter(muse_pixtable *, unsigned char)
Mask the range of the NaD notch filter in the given pixel table.
muse_basicproc_params * muse_basicproc_params_new_from_propertylist(const cpl_propertylist *)
Create a structure of basic processing parameters from a FITS header.
Structure of basic processing parameters.
cpl_error_code muse_basicproc_apply_illum(muse_pixtable *, cpl_table *)
Apply an illum/attached flat-field to a pixel table.
cpl_error_code muse_basicproc_qc_saturated(muse_image *, const char *)
Add QC parameter about saturated pixels to a muse_image.