xsh_util_integrate.c

Go to the documentation of this file.

/* $Id: xsh_util_integrate.c,v 1.5 2012-04-26 14:03:50 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
 *
 * $Name: not supported by cvs2svn $
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
/*-----------------------------------------------------------------------------
                                Includes
 ----------------------------------------------------------------------------*/
#include <string.h>
 
/* cpl */
#include <cpl.h>
 
#include <xsh_dfs.h>
#include <xsh_data_pre.h>
#include <xsh_utils.h>
#include <xsh_parameters.h>
#include <xsh_drl.h>
#include <xsh_msg.h>
#include <xsh_pfits.h>
#include <xsh_error.h>
//#include <xsh_utils_wrappers.h>
 
 
/*-----------------------------------------------------------------------------
                               Defines
 ----------------------------------------------------------------------------*/
 
#define XSH_UTL_INTEGRATE_RECIPE_ID "xsh_util_integrate"
#define XSH_UTL_INTEGRATE_RECIPE_AUTHOR "A.Modigliani"
#define XSH_UTL_INTEGRATE_RECIPE_CONTACT "Andrea.Modigliani@eso.org"
#define PRO_IMA "PRO_IMA_UVB"
#define KEY_VALUE_HPRO_DID                 "PRO-1.15"
/*-----------------------------------------------------------------------------
                            Functions prototypes
 ----------------------------------------------------------------------------*/
 
static int xsh_util_integrate_create(cpl_plugin *) ;
static int xsh_util_integrate_exec(cpl_plugin *) ;
static int xsh_util_integrate_destroy(cpl_plugin *) ;
static int xsh_util_integrate(cpl_parameterlist *, cpl_frameset *) ;
 
/*-----------------------------------------------------------------------------
                            Static variables
 ----------------------------------------------------------------------------*/
 
static char 
xsh_util_integrate_description_short[] = "Integrate spectra";
static char xsh_util_integrate_description[] =
"This recipe performs spectra integration (with flux conservation).\n"
"The input files should be list of files\n"
"Information on relevant parameters can be found with\n"
"esorex --params xsh_util_integrate\n"
"esorex --help xsh_util_integrate\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,
                    XSH_UTL_INTEGRATE_RECIPE_ID,
                    xsh_util_integrate_description_short,
                    xsh_util_integrate_description,
                    XSH_UTL_INTEGRATE_RECIPE_AUTHOR,
                    XSH_UTL_INTEGRATE_RECIPE_CONTACT,
                    xsh_get_license(),
                    xsh_util_integrate_create,
                    xsh_util_integrate_exec,
                    xsh_util_integrate_destroy) ;
 
    cpl_pluginlist_append(list, plugin) ;
    
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_integrate_create(cpl_plugin * plugin)
{
    cpl_recipe      * recipe ;
    cpl_parameter   * p ;
 
  /* 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(XSH_UTL_INTEGRATE_RECIPE_ID, 
                  recipe->parameters ) ) ;
    xsh_parameters_decode_bp(XSH_UTL_INTEGRATE_RECIPE_ID,recipe->parameters,-1);
    /* Fill the parameters list */
    p = cpl_parameter_new_range("xsh.xsh_util_integrate.binw", 
                                CPL_TYPE_DOUBLE, 
                                "Sampling bin [nm]", 
                                "xsh.xsh_util_integrate",1,0.01,100);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "binw") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 cleanup: 
 
    /* Return */
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_integrate_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_integrate(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_integrate_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_integrate( cpl_parameterlist   *   parlist, 
                    cpl_frameset        *   frames)
{
 
   const char* recipe_tags[1] = {XSH_RAW_IMA_SLIT};
   int recipe_tags_size = 1;
 
   cpl_parameter       *   param= NULL ;
 
   cpl_frameset* raws = NULL;
   cpl_frameset* calib = NULL;
 
   cpl_frame* std_obs=NULL;
   cpl_frame* std_cat=NULL;
   cpl_frame* atm_ext=NULL;
   cpl_frame* response=NULL;
 
 
   cpl_propertylist* plist=NULL;
 
 
   xsh_instrument* instrument = NULL;
   const char* fname=NULL;
   double binw=0;
   double exptime=0;
   xsh_msg("Welcome to XSHOOTER Pipeline release %d.%d.%d",
           XSH_MAJOR_VERSION,XSH_MINOR_VERSION,XSH_MICRO_VERSION);
 
   /* HOW TO RETRIEVE INPUT PARAMETERS */
   /* --stropt */
   check(param=cpl_parameterlist_find(parlist,"xsh.xsh_util_integrate.binw"));
   check(binw=cpl_parameter_get_double(param));
 
 
  check( xsh_begin( frames, parlist, &instrument, &raws, &calib,
            recipe_tags, recipe_tags_size,
            XSH_UTL_INTEGRATE_RECIPE_ID, XSH_BINARY_VERSION,
            xsh_util_integrate_description_short ) ) ;
 
   std_obs=xsh_find_frame_with_tag(raws,XSH_RAW_IMA_SLIT, instrument);
   std_cat=xsh_find_frame_with_tag(calib,XSH_FLUX_STD_CAT,instrument);
   atm_ext=xsh_find_frame_with_tag(calib,XSH_ATMOS_EXT,instrument);
 
   fname=cpl_frame_get_filename(std_obs);
   plist=cpl_propertylist_load(fname,0);
   exptime=xsh_pfits_get_exptime(plist);
   xsh_msg("exptime=%g",exptime);
 
   check(response=xsh_compute_response(std_obs,std_cat,atm_ext,NULL,
                                       instrument,exptime));
 
  cleanup:
   xsh_free_frame(&response);
   xsh_free_frameset(&raws);
   xsh_free_frameset(&calib);
 
   xsh_instrument_free( &instrument);
   xsh_free_propertylist(&plist);
   if (cpl_error_get_code()) {
      return -1 ;
   } else {
      return 0 ;
   }
 
}