uves_response_utils.c

00001 /*                                                                              *
00002  *   This file is part of the ESO UVES Pipeline                                 *
00003  *   Copyright (C) 2004,2005 European Southern Observatory                      *
00004  *                                                                              *
00005  *   This library 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: jmlarsen $
00022  * $Date: 2007/08/21 13:08:26 $
00023  * $Revision: 1.15 $
00024  * $Name: uves-3_9_0 $
00025  * $Log: uves_response_utils.c,v $
00026  * Revision 1.15  2007/08/21 13:08:26  jmlarsen
00027  * Removed irplib_access module, largely deprecated by CPL-4
00028  *
00029  * Revision 1.14  2007/06/06 08:17:33  amodigli
00030  * replace tab with 4 spaces
00031  *
00032  * Revision 1.13  2007/04/24 12:50:29  jmlarsen
00033  * Replaced cpl_propertylist -> uves_propertylist which is much faster
00034  *
00035  * Revision 1.12  2007/04/10 07:09:48  jmlarsen
00036  * Changed interface of uves_spline_hermite()
00037  *
00038  * Revision 1.11  2006/11/15 15:02:15  jmlarsen
00039  * Implemented const safe workarounds for CPL functions
00040  *
00041  * Revision 1.9  2006/11/15 14:04:08  jmlarsen
00042  * Removed non-const version of parameterlist_get_first/last/next which is
00043  * already in CPL, added const-safe wrapper, unwrapper and deallocator functions
00044  *
00045  * Revision 1.8  2006/11/07 14:04:45  jmlarsen
00046  * Fixed memory error by setting pointer to NULL after cpl_free
00047  *
00048  * Revision 1.7  2006/11/06 15:19:42  jmlarsen
00049  * Removed unused include directives
00050  *
00051  * Revision 1.6  2006/11/03 15:01:21  jmlarsen
00052  * Killed UVES 3d table module and use CPL 3d tables
00053  *
00054  * Revision 1.5  2006/08/17 13:56:53  jmlarsen
00055  * Reduced max line length
00056  *
00057  * Revision 1.4  2006/08/17 09:20:43  jmlarsen
00058  * Get reference object ID from flux table, not raw header
00059  *
00060  * Revision 1.3  2006/06/01 14:43:17  jmlarsen
00061  * Added missing documentation
00062  *
00063  * Revision 1.2  2006/03/24 13:56:13  jmlarsen
00064  * Changed ambigous text message
00065  *
00066  * Revision 1.1  2006/02/03 07:51:04  jmlarsen
00067  * Moved recipe implementations to ./uves directory
00068  *
00069  * Revision 1.2  2005/12/19 16:17:55  jmlarsen
00070  * Replaced bool -> int
00071  *
00072  * Revision 1.1  2005/11/11 13:18:54  jmlarsen
00073  * Reorganized code, renamed source files
00074  *
00075  */
00076 
00077 #ifdef HAVE_CONFIG_H
00078 #  include <config.h>
00079 #endif
00080 
00081 /*----------------------------------------------------------------------------*/
00085 /*----------------------------------------------------------------------------*/
00088 /*-----------------------------------------------------------------------------
00089                                 Includes
00090  -----------------------------------------------------------------------------*/
00091 
00092 #include <uves_response_utils.h>
00093 
00094 #include <uves_utils.h>
00095 #include <uves_utils_wrappers.h>
00096 #include <uves_pfits.h>
00097 #include <uves_error.h>
00098 #include <uves_msg.h>
00099 
00100 #include <cpl.h>
00101 
00102 #include <stdbool.h>
00103 
00104 /*-----------------------------------------------------------------------------
00105                             Defines
00106  -----------------------------------------------------------------------------*/
00107 /*-----------------------------------------------------------------------------
00108                             Functions prototypes
00109  -----------------------------------------------------------------------------*/
00110 
00111 /*-----------------------------------------------------------------------------
00112                             Implementation
00113  -----------------------------------------------------------------------------*/
00114 
00115 /*----------------------------------------------------------------------------*/
00132 /*----------------------------------------------------------------------------*/
00133 cpl_image *
00134 uves_calculate_response(const cpl_image *spectrum, const uves_propertylist *spectrum_header,
00135             const cpl_table *flux_table,
00136             const uves_propertylist *raw_header,
00137             double PACCURACY,
00138             bool inverse,
00139             char **ref_obj_id)
00140 {
00141     cpl_image *response = NULL;             /* Result */
00142     cpl_table *catalogue_flux = NULL;
00143     int nx, norders;
00144     
00145     nx      = cpl_image_get_size_x(spectrum);
00146     norders = cpl_image_get_size_y(spectrum);
00147     
00148     response = cpl_image_new(nx, norders, CPL_TYPE_DOUBLE);
00149 
00150     check( catalogue_flux = uves_align(raw_header, flux_table, PACCURACY, ref_obj_id),
00151        "Cannot read catalogue flux");
00152 
00153     /* Correct for atmospheric extinction, and calculate response */
00154     {
00155     double dlambda;
00156     int order;
00157     
00158     check( dlambda = uves_pfits_get_cdelt1(spectrum_header),
00159            "Error reading bin width from header");
00160     
00161     for (order = 1; order <= norders; order++)
00162         {
00163         double lambda_start;
00164         int x;
00165         
00166         /* If spectrum was already merged, then read cdelt1,
00167          * otherwise read wstart for each order
00168          */
00169         if (norders == 1)
00170             {
00171             check( lambda_start = uves_pfits_get_crval1(spectrum_header),
00172                    "Error reading start wavelength from header");    
00173             }
00174         else
00175             {
00176             check( lambda_start = uves_pfits_get_wstart(spectrum_header, order),
00177                    "Error reading start wavelength from header");    
00178             }
00179         
00180         for (x = 1; x <= nx; x++)
00181             {
00182             int pis_rejected;
00183             double lambda;            
00184             double flux, std_flux, resp;
00185                         int istart = 0;
00186 
00187             lambda = lambda_start + (x-1) * dlambda;
00188             
00189             check( flux = cpl_image_get(spectrum, x, order, &pis_rejected),
00190                    "Error reading flux");
00191             
00192             if (!pis_rejected)
00193                 {
00194                 /* Get interpolated catalogue flux */
00195                 check( std_flux = uves_spline_hermite_table(
00196                        lambda, catalogue_flux,
00197                        "LAMBDA", "F_LAMBDA", &istart),
00198                        "Error interpolating catalogue flux");
00199                 
00200                 if (inverse)
00201                     {
00202                     resp = (flux == 0) ? 0 : std_flux / flux;
00203                     }
00204                 else
00205                     {
00206                     resp = (std_flux == 0) ? 0 : flux / std_flux;
00207                     }
00208                 
00209                 check( cpl_image_set(response, x, order, resp),
00210                        "Error writing response image");
00211                 }
00212             else
00213                 {
00214                 cpl_image_reject(response, x, order);
00215                 }
00216             }
00217         }
00218     }
00219     
00220   cleanup:
00221     uves_free_table(&catalogue_flux);
00222     if (cpl_error_get_code() != CPL_ERROR_NONE)
00223     {
00224         uves_free_image(&response);
00225     }
00226     return response;
00227 }
00228 
00229 
00230 /*----------------------------------------------------------------------------*/
00249 /*----------------------------------------------------------------------------*/
00250 cpl_table *
00251 uves_align(const uves_propertylist *object_header, const cpl_table *flux_table,
00252        double accuracy,
00253        char **ref_name_dynamic)
00254 {
00255     double obj_ra, obj_dec;  /* Object position in degrees    */
00256     int nident = 0;          /* Number of identifications     */
00257     int match_row = 0;       /* Catalogue row number of match */
00258     double min_dist = 0;     /* Accuracy of match             */
00259     double std_ra = 0, std_dec = 0;    /* Catalogue position  */
00260     const char *ref_type = NULL;
00261 
00262     cpl_table *result = NULL;
00263 
00264     int i;
00265 
00266     assure_nomsg( ref_name_dynamic != NULL, CPL_ERROR_NULL_INPUT );
00267     *ref_name_dynamic = NULL;
00268 
00269     check( obj_ra  = uves_pfits_get_ra (object_header), "Could not read right ascension");
00270     check( obj_dec = uves_pfits_get_dec(object_header), "Could not read declination");
00271     
00272     uves_msg("Object RA, DEC = (%e, %e)", obj_ra, obj_dec);
00273 
00274     nident = 0;
00275     for (i = 0; i < cpl_table_get_nrow(flux_table); i++)
00276     {
00277         double ref_ra, ref_dec;
00278         double dist;
00279 
00280         check( ref_ra  = cpl_table_get_double(flux_table, "RA_DEG", i, NULL),
00281            "Could not read catalogue star right ascension");
00282         check( ref_dec = cpl_table_get_double(flux_table, "DEC_DEG", i, NULL),
00283            "Could not read catalogue star declination");
00284 
00285         /* Calculate angular separation in arcsecs
00286          * cos(sep) = sin(d1)sin(d2) + cos(d1)cos(d2)cos(ra1-ra2) 
00287          *
00288          * All input angles are in degrees.
00289          */
00290         
00291         dist = 
00292         SIN_DEG(obj_dec)*SIN_DEG(ref_dec) + 
00293         COS_DEG(obj_dec)*COS_DEG(ref_dec)*COS_DEG(obj_ra - ref_ra);
00294         
00295         dist = uves_max_double(dist, -1);
00296         dist = uves_min_double(dist,  1);
00297         
00298         dist = ACOS_DEG(dist) * 3600;
00299 
00300         uves_msg_debug("Angular separation = %f arcseconds", dist);
00301 
00302 
00303         /* Keep track of best match also if it is not within the pointing accuracy */
00304         if (i == 0 || dist < min_dist)
00305         {
00306             min_dist = dist;
00307             std_ra = ref_ra;
00308             std_dec = ref_dec;
00309         }
00310 
00311 
00312         /* Does it match? */
00313         if (dist < accuracy)
00314         {
00315             nident += 1;
00316             match_row = i;        
00317             min_dist = dist;
00318             std_ra = ref_ra;
00319             std_dec = ref_dec;            
00320         }
00321     }
00322 
00323     assure( nident >= 1, CPL_ERROR_INCOMPATIBLE_INPUT, 
00324         "No catalogue object within %f arcsecs. "
00325         "Nearest object is %f arcsecs away at (RA, DEC) = (%f, %f)", 
00326         accuracy, min_dist, std_ra, std_dec);
00327 
00328     assure( nident <= 1, CPL_ERROR_INCOMPATIBLE_INPUT,
00329         "%d matching catalogue objects found. Confused. "
00330         "Decrease pointing accuracy (currently %f arcsecs) to get fewer matches", 
00331         nident, accuracy);
00332 
00333     check( *ref_name_dynamic = cpl_strdup(
00334            cpl_table_get_string(flux_table, "OBJECT", match_row)),
00335        "Could not read reference object name");
00336     
00337     check( ref_type = cpl_table_get_string(flux_table, "TYPE", match_row),
00338        "Could not read reference object type");
00339     
00340     uves_msg("Object ID is '%s', type = '%s'. Residual between header/catalogue = %f arcsecs",
00341          *ref_name_dynamic, ref_type, min_dist);
00342     
00343     
00344     /* Create (2d) flux table from catalogue table row number 'match_row' */
00345     {
00346     const char *columns[3] = {"LAMBDA", "BIN_WIDTH", "F_LAMBDA"};
00347     int ndata;                      /* Number of elements in column */
00348 
00349     check( ndata = cpl_table_get_int(flux_table, "NDATA", match_row, NULL),
00350            "Error reading length of flux array");
00351     
00352     result = cpl_table_new(ndata);
00353 
00354     for(i = 0; i < 3; i++)
00355         {
00356         const cpl_array *data;
00357         int indx;
00358         
00359         cpl_table_new_column(result, columns[i], CPL_TYPE_DOUBLE);
00360         
00361         data = cpl_table_get_array(flux_table, columns[i], match_row);
00362 
00363         /* Only the 'ndata' first elements of the array are used,
00364            and the array may be longer than this */
00365         uves_msg_debug("3d table array size = %d, ndata = %d",
00366                    cpl_array_get_size(data), ndata);
00367 
00368         assure( cpl_array_get_size(data) >= ndata,
00369             CPL_ERROR_ILLEGAL_INPUT,
00370             "Flux table row %d: column '%s' depth (%d) "
00371             "is less than NDATA (%d)",
00372             match_row, columns[i], cpl_array_get_size(data), ndata);
00373 
00374         for (indx = 0; indx < ndata; indx++)
00375             {
00376             /* 3d columns are float */
00377             cpl_table_set_double(result, columns[i], indx, 
00378                          cpl_array_get_float(data, indx, NULL));
00379             }
00380         }
00381     }
00382   
00383   cleanup:
00384     if (cpl_error_get_code() != CPL_ERROR_NONE)
00385     {
00386         uves_free_table(&result);
00387         if (ref_name_dynamic != NULL) 
00388         {
00389             cpl_free(*ref_name_dynamic);
00390             *ref_name_dynamic = NULL;
00391         }
00392     }
00393 
00394     return result;
00395 }
00396 

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