xsh_util_efficiency1d.c

Go to the documentation of this file.

/* $Id: xsh_util_efficiency1d.c,v 1.18 2012-04-26 14:08:32 amodigli Exp $
 *
 * This file is part of the XSHOOTER Pipeline
 * Copyright (C) 2002,2003 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
/*
<<<<<<< xsh_util_efficiency1d.c
 * $Author: amodigli $
 * $Date: 2012-04-26 14:08:32 $
 * $Revision: 1.18 $
=======
 * $Author: amodigli $
 * $Date: 2012-04-26 14:08:32 $
 * $Revision: 1.18 $
>>>>>>> 1.13.2.1
 * $Name: not supported by cvs2svn $
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
/*-----------------------------------------------------------------------------
                                Includes
 ----------------------------------------------------------------------------*/
#include <string.h>
#include <math.h>
 
/* cpl */
#include <cpl.h>
 
#include <xsh_dfs.h>
#include <xsh_data_pre.h>
#include <xsh_parameters.h>
#include <xsh_drl.h>
#include <xsh_msg.h>
#include <xsh_pfits.h>
#include <xsh_pfits_qc.h>
#include <xsh_error.h>
#include <xsh_utils_image.h>
#include <xsh_utils_table.h>
#include <xsh_utils_efficiency.h>
 
 
/*-----------------------------------------------------------------------------
                               Defines
 ----------------------------------------------------------------------------*/
 
#define RECIPE_ID "xsh_util_efficiency1d"
#define RECIPE_AUTHOR "A.Modigliani"
#define RECIPE_CONTACT "Andrea.Modigliani@eso.org"
#define PRO_IMA "PRO_IMA_UVB"
#define KEY_VALUE_HPRO_DID                 "PRO-1.15"
 
#define SPEED_LIGHT 2.99792458*1.E8   /* m s-1 */
#define TEL_AREA  51.2e4             /* collecting area in cm2 */
/*-----------------------------------------------------------------------------
                            Functions prototypes
 ----------------------------------------------------------------------------*/
 
static int xsh_util_efficiency1d_create(cpl_plugin *) ;
static int xsh_util_efficiency1d_exec(cpl_plugin *) ;
static int xsh_util_efficiency1d_destroy(cpl_plugin *) ;
static int xsh_util_efficiency1d(cpl_parameterlist *, cpl_frameset *) ;
 
/*-----------------------------------------------------------------------------
                            Static variables
 ----------------------------------------------------------------------------*/
 
static char 
xsh_util_efficiency1d_description_short[] = "Compute efficiency";
static char xsh_util_efficiency1d_description[] =
"This recipe compute efficiency.\n"
"The input files should be tagged as: \n"
"input observed spectrum: RAW_IMA_SLIT_arm,\n"
"input reference spectrum: FLUX_STD_TABLE_arm,\n"
"input atmospheric  extintion table: EXTCOEFF_TABLE_arm)\n"
"The output is a table with efficiency as function of wavelength\n"
"Information on relevant parameters can be found with\n"
"esorex --params xsh_util_efficiency1d\n"
"esorex --help xsh_util_efficiency1d\n"
"\n";
 
/*-----------------------------------------------------------------------------
                                Functions code
 ----------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
int cpl_plugin_get_info(cpl_pluginlist * list)
{
    cpl_recipe  *   recipe = cpl_calloc(1, sizeof *recipe ) ;
    cpl_plugin  *   plugin = &recipe->interface ;
 
    cpl_plugin_init(plugin,
                    CPL_PLUGIN_API,
                    XSH_BINARY_VERSION,
                    CPL_PLUGIN_TYPE_RECIPE,
                    RECIPE_ID,
                    xsh_util_efficiency1d_description_short,
                    xsh_util_efficiency1d_description,
                    RECIPE_AUTHOR,
                    RECIPE_CONTACT,
                    xsh_get_license(),
                    xsh_util_efficiency1d_create,
                    xsh_util_efficiency1d_exec,
                    xsh_util_efficiency1d_destroy) ;
 
    cpl_pluginlist_append(list, plugin) ;
    
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_efficiency1d_create(cpl_plugin * plugin)
{
    cpl_recipe      * recipe ;
 
  /* Reset library state */
  xsh_init();
 
    /* Get the recipe out of the plugin */
    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE) 
        recipe = (cpl_recipe *)plugin ;
    else return -1 ;
    cpl_error_reset();
 
 
    /* Create the parameters list in the cpl_recipe object */
    recipe->parameters = cpl_parameterlist_new() ; 
 
 
    /* Set generic parameters (common to all recipes) */
    check( xsh_parameters_generic(RECIPE_ID, 
                  recipe->parameters ) ) ;
    xsh_parameters_decode_bp(RECIPE_ID,recipe->parameters,-1);
 cleanup: 
 
    /* Return */
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_efficiency1d_exec(cpl_plugin * plugin)
{
    cpl_recipe  *   recipe ;
     int code=0;
     cpl_errorstate initial_errorstate = cpl_errorstate_get();
 
    /* Get the recipe out of the plugin */
    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE) 
        recipe = (cpl_recipe *)plugin ;
    else return -1 ;
    cpl_error_reset();
 
    code = xsh_util_efficiency1d(recipe->parameters, recipe->frames) ;
 
 
    if (!cpl_errorstate_is_equal(initial_errorstate)) {                      
        /* Dump the error history since recipe execution start.                
           At this point the recipe cannot recover from the error */           
        cpl_errorstate_dump(initial_errorstate, CPL_FALSE, NULL);              
    } 
 
    return code ;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_efficiency1d_destroy(cpl_plugin * plugin)
{
    cpl_recipe  *   recipe ;
    
    /* Get the recipe out of the plugin */
    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE) 
        recipe = (cpl_recipe *)plugin ;
    else return -1 ;
 
    cpl_parameterlist_delete(recipe->parameters) ; 
    return 0 ;
}
 
 
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int 
xsh_util_efficiency1d( cpl_parameterlist   *   parlist, 
               cpl_frameset        *   frames)
{
  const char* recipe_tags[1] = {XSH_RAW_IMA_SLIT};
  int recipe_tags_size = 1;
 
  xsh_instrument* instrument=NULL;
 
  cpl_frameset* raws=NULL;
  cpl_frameset* calib=NULL;
  cpl_frame* frm_std_cat=NULL;
  cpl_frame* frm_atmext=NULL;
  cpl_frame* frm_eff=NULL;
  cpl_frame* frm_sci=NULL;
 
  xsh_msg("Welcome to XSHOOTER Pipeline release %d.%d.%d",
      XSH_MAJOR_VERSION,XSH_MINOR_VERSION,XSH_MICRO_VERSION);
 
   
  check( xsh_begin( frames, parlist, &instrument, &raws, &calib,
            recipe_tags, recipe_tags_size,
            RECIPE_ID, XSH_BINARY_VERSION,
            xsh_util_efficiency1d_description_short ) ) ;
   
  /* HOW TO RETRIEVE INPUT PARAMETERS */
  /* --stropt */
  frm_atmext=xsh_find_frame_with_tag(calib,XSH_ATMOS_EXT,instrument);
  if(frm_atmext==NULL) {
    xsh_msg_error("Provide atmospheric extinction frame");
    return CPL_ERROR_DATA_NOT_FOUND;
  }
 
  frm_std_cat=xsh_find_frame_with_tag(calib,XSH_FLUX_STD_CAT,instrument);
  if(frm_std_cat==NULL) {
    xsh_msg_error("Provide std star catalog frame");
    return CPL_ERROR_DATA_NOT_FOUND;
  }
 
  if( (frm_sci=xsh_find_frame_with_tag(frames,XSH_RAW_IMA_SLIT, 
                       instrument)) == NULL) {    
     goto cleanup;
  } 
 
  check(frm_eff=xsh_efficiency_compute(frm_sci,frm_std_cat,frm_atmext,
                       instrument));
 
  check(xsh_frame_table_monitor_flux_qc(frm_eff,"WAVELENGTH","EFF","EFF",
                    instrument));
 
 
  check(xsh_add_product_table(frm_eff, frames,parlist, 
                    RECIPE_ID, instrument,NULL));
 
 
 cleanup:
 
  xsh_free_frame(&frm_eff);
  xsh_free_frameset(&raws);
  xsh_free_frameset(&calib);
  xsh_instrument_free( &instrument);
 
  if (cpl_error_get_code()) {
    return -1 ;
  } else {
    return 0 ;
  }
 
}