uves_reduce.h

00001 /*
00002  * This file is part of the ESO UVES Pipeline
00003  * Copyright (C) 2004,2005 European Southern Observatory
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this program; if not, write to the Free Software
00017  * Foundation, 51 Franklin St, Fifth Floor, Boston, MA  02111-1307  USA
00018  */
00019 
00020 /*
00021  * $Author: amodigli $
00022  * $Date: 2007/06/06 08:17:33 $
00023  * $Revision: 1.21 $
00024  * $Name: uves-4_2_2 $
00025  * $Log: uves_reduce.h,v $
00026  * Revision 1.21  2007/06/06 08:17:33  amodigli
00027  * replace tab with 4 spaces
00028  *
00029  * Revision 1.20  2007/05/25 11:50:32  jmlarsen
00030  * Re-added ORDER_TRACE_TABLE
00031  *
00032  * Revision 1.19  2007/05/22 11:43:10  jmlarsen
00033  * Removed MIDAS flag for good
00034  *
00035  * Revision 1.18  2007/05/03 15:25:33  jmlarsen
00036  * Fixed const bugs
00037  *
00038  * Revision 1.17  2007/04/24 12:50:29  jmlarsen
00039  * Replaced cpl_propertylist -> uves_propertylist which is much faster
00040  *
00041  * Revision 1.16  2007/01/29 12:12:11  jmlarsen
00042  * Calculate extraction slit length
00043  *
00044  * Revision 1.15  2006/11/06 15:19:41  jmlarsen
00045  * Removed unused include directives
00046  *
00047  * Revision 1.14  2006/05/16 12:13:07  amodigli
00048  * added QC log
00049  *
00050  * Revision 1.13  2006/03/24 13:58:57  jmlarsen
00051  * Changed meaning of VARIANCE_SCIENCE to match MIDAS
00052  *
00053  * Revision 1.12  2005/12/19 16:17:56  jmlarsen
00054  * Replaced bool -> int
00055  *
00056  */
00057 #ifndef UVES_REDUCE_H
00058 #define UVES_REDUCE_H
00059 
00060 #include <uves_utils_polynomial.h>
00061 #include <uves_chip.h>
00062 
00063 #include <cpl.h>
00064 
00065 #include <stdbool.h>
00066 
00067 cpl_parameterlist *uves_reduce_define_parameters(void);
00068 
00069 cpl_error_code uves_reduce(const cpl_image *raw_image, 
00070                            const uves_propertylist *raw_header, 
00071                            const uves_propertylist *rotated_header,
00072                const cpl_image *master_bias,
00073                const cpl_image *master_dark, 
00074                            const uves_propertylist *mdark_header, 
00075                const cpl_image *master_flat, 
00076                            const uves_propertylist *mflat_header,
00077                const cpl_table *ordertable, 
00078                            const polynomial *order_locations,
00079                const cpl_table *linetable[3], 
00080                            const uves_propertylist *linetable_header[3], 
00081                            const polynomial *dispersion_relation[3],
00082                enum uves_chip chip,
00083                /* General */
00084                bool   DEBUG,
00085                /* Backsub */
00086                /* Flat fielding */
00087                /* Extraction */
00088                /* Rebinning  */
00089                const cpl_parameterlist *parameters, 
00090                            const char *context,
00091                /* Output */
00092                cpl_image **x, uves_propertylist **x_header,
00093                cpl_image **fx,
00094                cpl_table **cosmic_mask,
00095                cpl_image **background,
00096                cpl_image **flatfielded_variance,
00097                uves_propertylist **flatfielded_variance_header,
00098                cpl_image **resampled_spectrum,
00099                cpl_image **resampled_mf,
00100                cpl_image **merged_sky,
00101                cpl_image **rebinned_spectrum, 
00102                            cpl_image **rebinned_noise, 
00103                            uves_propertylist **rebinned_header,
00104                cpl_image **merged_spectrum,   
00105                            cpl_image **merged_noise, 
00106                            uves_propertylist **merged_header,
00107                cpl_image **reduced_rebinned_spectrum, 
00108                            cpl_image **reduced_rebinned_noise,
00109                cpl_image **reduced_spectrum , 
00110                            cpl_image **reduced_noise,
00111                            cpl_table **info_tbl,
00112                double *extraction_slit,
00113                cpl_table **order_trace);
00114 
00115 #endif  /* UVES_REDUCE_H */

Generated on Mon Apr 21 10:56:56 2008 for UVES Pipeline Reference Manual by  doxygen 1.5.1