GIRAFFE Pipeline Reference Manual

giextract.h

00001 /* $Id: giextract.h,v 1.11 2008/01/10 16:12:19 rpalsa Exp $
00002  *
00003  * This file is part of the GIRAFFE Pipeline
00004  * Copyright (C) 2002-2006 European Southern Observatory
00005  *
00006  * This program is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 2 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software
00018  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 /*
00022  * $Author: rpalsa $
00023  * $Date: 2008/01/10 16:12:19 $
00024  * $Revision: 1.11 $
00025  * $Name: giraffe-2_10 $
00026  */
00027 
00028 #ifndef GIEXTRACT_H
00029 #define GIEXTRACT_H
00030 
00031 #include <cpl_macros.h>
00032 #include <cpl_parameterlist.h>
00033 
00034 #include <giimage.h>
00035 #include <gitable.h>
00036 #include <gilocalization.h>
00037 #include <giextraction.h>
00038 
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 
00045 enum GiExtractMethod {
00046     GIEXTRACT_SUM,
00047     GIEXTRACT_HORNE,
00048     GIEXTRACT_OPTIMAL
00049 };
00050 
00051 typedef enum GiExtractMethod GiExtractMethod;
00052 
00053 
00054 struct GiExtractConfig {
00055     GiExtractMethod emethod;
00056 
00057     cxdouble ron;
00058 
00059     struct {
00060         cxchar* model;
00061         cxdouble sigma;
00062         cxint iterations;
00063     } psf;
00064 
00065     struct {
00066         cxint ewidth;
00067         cxint mingood;
00068     } horne;
00069 
00070     struct {
00071         cxint bkgorder;
00072         cxdouble wfactor;
00073         cxdouble fraction;
00074     } optimal;
00075 
00076 };
00077 
00078 typedef struct GiExtractConfig GiExtractConfig;
00079 
00080 
00081 /*
00082  * Spectrum extraction
00083  */
00084 
00085 cxint giraffe_extract_spectra(GiExtraction* result, GiImage* image,
00086                               GiTable* fibers, GiLocalization* sloc,
00087                               GiImage* bpixel, GiImage* slight,
00088                               GiExtractConfig* config);
00089 
00090 /*
00091  * Convenience functions
00092  */
00093 
00094 GiExtractConfig* giraffe_extract_config_create(cpl_parameterlist* list);
00095 void giraffe_extract_config_destroy(GiExtractConfig* config);
00096 
00097 void giraffe_extract_config_add(cpl_parameterlist *list);
00098 
00099 #ifdef __cplusplus
00100 }
00101 #endif
00102 
00103 #endif /* GIEXTRACT_H */

This file is part of the GIRAFFE Pipeline Reference Manual 2.10.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Thu Mar 7 14:11:02 2013 by doxygen 1.4.7 written by Dimitri van Heesch, © 1997-2004