GIRAFFE Pipeline Reference Manual

gifov.h

00001 /* $Id$
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$
00023  * $Date$
00024  * $Revision$
00025  * $Name$
00026  */
00027 
00028 #ifndef GIFOV_H
00029 #define GIFOV_H
00030 
00031 #include <cxslist.h>
00032 
00033 #include <cpl_macros.h>
00034 #include <cpl_array.h>
00035 #include <cpl_parameterlist.h>
00036 
00037 #include <giimage.h>
00038 #include <gitable.h>
00039 #include <gicube.h>
00040 #include <girebinning.h>
00041 
00042 
00043 #ifdef __cplusplus
00044 extern "C" {
00045 #endif
00046 
00047 
00048     struct GiFieldOfViewConfig {
00049         cxdouble minimum;
00050         cxdouble maximum;
00051         cxbool cube;
00052     };
00053 
00054     typedef struct GiFieldOfViewConfig GiFieldOfViewConfig;
00055 
00056     struct GiFieldOfView {
00057         GiInstrumentMode mode;
00058 
00059         cpl_array* ssn;
00060 
00061         struct {
00062             GiImage* spectra;
00063             GiImage* errors;
00064         } fov;
00065 
00066         struct {
00067             cx_slist* spectra;
00068             cx_slist* errors;
00069         } images;
00070 
00071         struct {
00072             cx_slist* spectra;
00073             cx_slist* errors;
00074         } cubes;
00075     };
00076 
00077     typedef struct GiFieldOfView GiFieldOfView;
00078 
00079 
00080     /*
00081      * Spectrum localization
00082      */
00083 
00084     cxint giraffe_fov_build(GiFieldOfView* result,
00085                             GiRebinning* rebinning, GiTable* fibers,
00086                             GiTable* wsolution, GiTable* grating,
00087                             GiTable* slitgeometry,
00088                             GiFieldOfViewConfig* config);
00089 
00090 
00091     /*
00092      * Convenience functions
00093      */
00094 
00095     GiFieldOfView* giraffe_fov_new(void);
00096     void giraffe_fov_delete(GiFieldOfView* self);
00097     void giraffe_fov_clear(GiFieldOfView* self);
00098 
00099     cxint giraffe_fov_save_cubes(const GiFieldOfView* self,
00100                                  cpl_propertylist* properties,
00101                                  const cxchar* filename, cxptr data);
00102 
00103 
00104     GiFieldOfViewConfig* giraffe_fov_config_create(cpl_parameterlist* list);
00105     void giraffe_fov_config_destroy(GiFieldOfViewConfig* config);
00106     void giraffe_fov_config_add(cpl_parameterlist* list);
00107 
00108 
00109 #ifdef __cplusplus
00110 }
00111 #endif
00112 
00113 #endif /* GIFOV_H */

This file is part of the GIRAFFE Pipeline Reference Manual 2.8.8.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Mar 4 10:50:27 2011 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004