GIRAFFE Pipeline Reference Manual

gireconstruct.h

00001 /* $Id: gireconstruct.h,v 1.9 2007/05/02 11:34:18 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: 2007/05/02 11:34:18 $
00024  * $Revision: 1.9 $
00025  * $Name: giraffe-2_5_2 $
00026  */
00027 
00028 #ifndef GIRECONSTRUCT_H
00029 #define GIRECONSTRUCT_H
00030 
00031 #include <cpl_macros.h>
00032 #include <cpl_parameterlist.h>
00033 
00034 #include <giimage.h>
00035 #include <gitable.h>
00036 #include <gicube.h>
00037 #include <girebinning.h>
00038 
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 
00045     struct GiReconstructConfig {
00046         cxdouble minimum;
00047         cxdouble maximum;
00048         cxbool cube;
00049     };
00050 
00051     typedef struct GiReconstructConfig GiReconstructConfig;
00052 
00053 
00054     struct GiReconstruction {
00055         GiImage* spectra;
00056         GiImage* errors;
00057         GiCube* cube_spectra;
00058         GiCube* cube_errors;
00059     };
00060 
00061     typedef struct GiReconstruction GiReconstruction;
00062 
00063 
00064     /*
00065     * Spectrum localization
00066     */
00067 
00068     cxint giraffe_reconstruction_build(GiReconstruction* result,
00069                                     GiRebinning* rebinning, GiTable* fibers,
00070                                     GiTable* wsolution, GiTable* grating,
00071                                     GiTable* slitgeometry,
00072                                     GiReconstructConfig* config);
00073 
00074 
00075     /*
00076     * Convenience functions
00077     */
00078 
00079     GiReconstruction* giraffe_reconstruction_new(void);
00080     void giraffe_reconstruction_delete(GiReconstruction* reconstruction);
00081     void giraffe_reconstruction_destroy(GiReconstruction* reconstruction);
00082 
00083 
00084     GiReconstructConfig*
00085         giraffe_reconstruct_config_create(cpl_parameterlist* list);
00086     void giraffe_reconstruct_config_destroy(GiReconstructConfig* config);
00087 
00088     void giraffe_reconstruct_config_add(cpl_parameterlist* list);
00089 
00090 
00091 #ifdef __cplusplus
00092 }
00093 #endif
00094 
00095 #endif /* GIRECONSTRUCT_H */

This file is part of the GIRAFFE Pipeline Reference Manual 2.5.2.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Jun 13 14:36:23 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004