GIRAFFE Pipeline Reference Manual

giframe.h

00001 /* $Id: giframe.h,v 1.26 2008/01/08 14:20:43 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/08 14:20:43 $
00024  * $Revision: 1.26 $
00025  * $Name: giraffe-2_5_1 $
00026  */
00027 
00028 #ifndef GIFRAME_H
00029 #define GIFRAME_H
00030 
00031 #include <cpl_macros.h>
00032 #include <cpl_propertylist.h>
00033 #include <cpl_frame.h>
00034 #include <cpl_frameset.h>
00035 
00036 #include <giimage.h>
00037 #include <gitable.h>
00038 
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 
00045 /*
00046  * Raw frames
00047  */
00048 
00049 #define GIFRAME_BIAS          "BIAS"
00050 #define GIFRAME_DARK          "DARK"
00051 #define GIFRAME_FIBER_FLAT    "FIBER_FLAT"
00052 #define GIFRAME_ARC_SPECTRUM  "ARC_SPECTRUM"
00053 #define GIFRAME_SCIENCE       "SCIENCE"
00054 #define GIFRAME_STANDARD      "STD"
00055 
00056 /*
00057  * Calibration data
00058  */
00059 
00060 #define GIFRAME_BADPIXEL_MAP  "BAD_PIXEL_MAP"
00061 #define GIFRAME_GRATING       "GRATING_DATA"
00062 #define GIFRAME_SLITGEOMETRY  "SLIT_GEOMETRY"
00063 #define GIFRAME_SLITMASTER    "SLIT_GEOMETRY_MASTER"
00064 #define GIFRAME_SLITSETUP     "SLIT_GEOMETRY_SETUP"
00065 #define GIFRAME_LINE_MASK     "LINE_MASK"
00066 #define GIFRAME_LINE_CATALOG  "LINE_CATALOG"
00067 
00068 /*
00069  * Products
00070  */
00071 
00072 #define GIFRAME_BIAS_MASTER              "MASTER_BIAS"
00073 #define GIFRAME_DARK_MASTER              "MASTER_DARK"
00074 
00075 #define GIFRAME_FIBER_FLAT_MASTER        "MASTER_FIBER_FLAT"
00076 #define GIFRAME_FIBER_FLAT_EXTSPECTRA    "FF_EXTSPECTRA"
00077 #define GIFRAME_FIBER_FLAT_EXTERRORS     "FF_EXTERRORS"
00078 #define GIFRAME_FIBER_FLAT_EXTPIXELS     "FF_EXTPIXELS"
00079 #define GIFRAME_FIBER_FLAT_EXTTRACE      "FF_EXTTRACES"
00080 #define GIFRAME_FIBER_FLAT_EXTMODEL      "FF_EXTMODEL"
00081 
00082 #define GIFRAME_LOCALIZATION_CENTROID    "FF_LOCCENTROID"
00083 #define GIFRAME_LOCALIZATION_WIDTH       "FF_LOCWIDTH"
00084 #define GIFRAME_LOCALIZATION_FIT         "FF_LOCFIT"
00085 
00086 #define GIFRAME_PSF_CENTROID             "FF_PSFCENTROID"
00087 #define GIFRAME_PSF_WIDTH                "FF_PSFWIDTH"
00088 #define GIFRAME_PSF_FIT                  "FF_PSFFIT"
00089 
00090 #define GIFRAME_ARC_LAMP_EXTSPECTRA      "ARC_EXTSPECTRA"
00091 #define GIFRAME_ARC_LAMP_EXTERRORS       "ARC_EXTERRORS"
00092 #define GIFRAME_ARC_LAMP_EXTPIXELS       "ARC_EXTPIXELS"
00093 #define GIFRAME_ARC_LAMP_EXTTRACE        "ARC_EXTTRACES"
00094 #define GIFRAME_ARC_LAMP_RBNSPECTRA      "ARC_RBNSPECTRA"
00095 #define GIFRAME_ARC_LAMP_RBNERRORS       "ARC_RBNERRORS"
00096 
00097 #define GIFRAME_WAVELENGTH_SOLUTION      "DISPERSION_SOLUTION"
00098 #define GIFRAME_LINE_DATA                "LINE_DATA"
00099 #define GIFRAME_PSF_DATA                 "FIBER_PROFILE"
00100 
00101 #define GIFRAME_SCIENCE_REDUCED          "SCIENCE_REDUCED"
00102 #define GIFRAME_SCIENCE_EXTSPECTRA       "SCIENCE_EXTSPECTRA"
00103 #define GIFRAME_SCIENCE_EXTERRORS        "SCIENCE_EXTERRORS"
00104 #define GIFRAME_SCIENCE_EXTPIXELS        "SCIENCE_EXTPIXELS"
00105 #define GIFRAME_SCIENCE_EXTTRACE         "SCIENCE_EXTTRACES"
00106 #define GIFRAME_SCIENCE_RBNSPECTRA       "SCIENCE_RBNSPECTRA"
00107 #define GIFRAME_SCIENCE_RBNERRORS        "SCIENCE_RBNERRORS"
00108 #define GIFRAME_SCIENCE_RCSPECTRA        "SCIENCE_RCSPECTRA"
00109 #define GIFRAME_SCIENCE_RCERRORS         "SCIENCE_RCERRORS"
00110 #define GIFRAME_SCIENCE_CUBE_SPECTRA     "SCIENCE_CUBE_SPECTRA"
00111 #define GIFRAME_SCIENCE_CUBE_ERRORS      "SCIENCE_CUBE_ERRORS"
00112 
00113 #define GIFRAME_STANDARD_REDUCED         "STD_REDUCED"
00114 #define GIFRAME_STANDARD_EXTSPECTRA      "STD_EXTSPECTRA"
00115 #define GIFRAME_STANDARD_EXTERRORS       "STD_EXTERRORS"
00116 #define GIFRAME_STANDARD_EXTPIXELS       "STD_EXTPIXELS"
00117 #define GIFRAME_STANDARD_EXTTRACE        "STD_EXTTRACES"
00118 #define GIFRAME_STANDARD_RBNSPECTRA      "STD_RBNSPECTRA"
00119 #define GIFRAME_STANDARD_RBNERRORS       "STD_RBNERRORS"
00120 #define GIFRAME_STANDARD_RCSPECTRA       "STD_RCSPECTRA"
00121 #define GIFRAME_STANDARD_RCERRORS        "STD_RCERRORS"
00122 #define GIFRAME_STANDARD_CUBE_SPECTRA    "STD_CUBE_SPECTRA"
00123 #define GIFRAME_STANDARD_CUBE_ERRORS     "STD_CUBE_ERRORS"
00124 
00125 #define GIFRAME_SCATTERED_LIGHT_MODEL    "SCATTERED_LIGHT_MODEL"
00126 
00127 
00128 /*
00129  * Miscellaneous
00130  */
00131 
00132 #define GIFRAME_FIBER_SETUP  "FIBER_SETUP"
00133 
00134 
00135 /*
00136  * Generic frame creation utilities
00137  */
00138 
00139 typedef cxint (*GiFrameCreator)(cxcptr, cpl_propertylist *, const cxchar *,
00140                                 cxcptr);
00141 
00142 cpl_frame *giraffe_frame_create(const cxchar *tag, cpl_frame_level level,
00143                                 const cpl_propertylist *properties,
00144                                 cxcptr object, cxcptr data,
00145                                 GiFrameCreator creator);
00146 
00147 
00148 /*
00149  * Special frame creation utilities
00150  */
00151 
00152 cpl_frame *giraffe_frame_create_image(GiImage *image, const cxchar *tag,
00153                                       cpl_frame_level level, cxbool save,
00154                                       cxbool update);
00155 cpl_frame *giraffe_frame_create_table(GiTable *table, const cxchar *tag,
00156                                       cpl_frame_level level, cxbool save,
00157                                       cxbool update);
00158 cxint giraffe_frame_attach_table(cpl_frame *frame, GiTable *table,
00159                                  const cxchar *tag, cxbool update);
00160 
00161 /*
00162  * Frame retrieval utilities
00163  */
00164 
00165 cpl_frame *giraffe_get_frame(const cpl_frameset *set, const cxchar *tag,
00166                              cpl_frame_group group);
00167 
00168 cpl_frame *giraffe_get_slitgeometry(const cpl_frameset *set);
00169 
00170 
00171 #ifdef __cplusplus
00172 }
00173 #endif
00174 
00175 #endif /* GIFRAME_H */

This file is part of the GIRAFFE Pipeline Reference Manual 2.5.1.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Tue Mar 18 10:47:42 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004