uves_extract.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.32 $
00024  * $Name: uves-3_9_0 $
00025  * $Log: uves_extract.h,v $
00026  * Revision 1.32  2007/06/06 08:17:33  amodigli
00027  * replace tab with 4 spaces
00028  *
00029  * Revision 1.31  2007/05/25 11:50:32  jmlarsen
00030  * Re-added ORDER_TRACE_TABLE
00031  *
00032  * Revision 1.30  2007/05/22 11:32:39  jmlarsen
00033  * Removed MIDAS flag for good
00034  *
00035  * Revision 1.29  2007/05/02 13:16:57  jmlarsen
00036  * Added 'constant' profile method for arclamp spectra
00037  *
00038  * Revision 1.28  2007/04/24 12:50:29  jmlarsen
00039  * Replaced cpl_propertylist -> uves_propertylist which is much faster
00040  *
00041  * Revision 1.27  2006/11/15 14:04:08  jmlarsen
00042  * Removed non-const version of parameterlist_get_first/last/next which is already
00043  * in CPL, added const-safe wrapper, unwrapper and deallocator functions
00044  *
00045  * Revision 1.26  2006/09/19 07:15:35  jmlarsen
00046  * Added chip to argument list of uves_extract()
00047  *
00048  * Revision 1.25  2006/08/17 13:56:53  jmlarsen
00049  * Reduced max line length
00050  *
00051  * Revision 1.24  2006/05/16 12:13:07  amodigli
00052  * added QC log
00053  *
00054  * Revision 1.23  2006/05/12 15:04:13  jmlarsen
00055  * Changed gauss/moffat/virtual profile measuring methods to use 
00056  * global polynomials (rather than one polynomial per order)
00057  *
00058  * Revision 1.22  2006/04/24 09:21:18  jmlarsen
00059  * Implemented virtual resampling algorithm
00060  *
00061  * Revision 1.21  2006/02/28 09:15:22  jmlarsen
00062  * Minor update
00063  *
00064  * Revision 1.20  2005/12/19 16:17:56  jmlarsen
00065  * Replaced bool -> int
00066  *
00067  */
00068 #ifndef UVES_EXTRACT_H
00069 #define UVES_EXTRACT_H
00070 
00071 #include <uves_utils_polynomial.h>
00072 #include <uves_chip.h>
00073 
00074 #include <cpl.h>
00075 
00076 #include <stdbool.h>
00077 
00078 typedef enum {EXTRACT_AVERAGE,
00079           EXTRACT_LINEAR,
00080           EXTRACT_2D,
00081           EXTRACT_ARCLAMP,
00082           EXTRACT_WEIGHTED,
00083           EXTRACT_OPTIMAL} extract_method;
00084 
00085 
00086 cpl_parameterlist *uves_extract_define_parameters(void);
00087 
00088 extract_method
00089 uves_get_extract_method(const cpl_parameterlist *parameters, 
00090             const char *context, const char *subcontext);
00091 
00092 cpl_image *
00093 uves_extract(cpl_image *image, 
00094              cpl_image *image_noise, 
00095          const uves_propertylist *image_header,
00096              const cpl_table *ordertable, 
00097              const polynomial *order_locations_raw,
00098              double slit_length, 
00099              double offset,
00100              const cpl_parameterlist *parameters, 
00101              const char *context,
00102              bool extract_partial,
00103          bool DEBUG,
00104          enum uves_chip chip,
00105              uves_propertylist **header, 
00106              cpl_image **spectrum_noise,
00107              cpl_image **sky_spectrum,
00108              cpl_image **sky_spectrum_noise,
00109              cpl_table **cosmic_mask,
00110              cpl_image **cosmic_image,
00111              cpl_table **profile_table,
00112              cpl_image **weights,
00113              cpl_table **info_tbl,
00114              cpl_table **order_trace);
00115 
00116 #endif

Generated on Fri Apr 18 14:11:42 2008 for UVES Pipeline Reference Manual by  doxygen 1.5.1