xsh_util_guess_xy.c

Go to the documentation of this file.

/* $Id: xsh_util_guess_xy.c,v 1.4 2012-04-26 14:08:55 amodigli Exp $
 *
 *   This file is part of the ESO X-shooter Pipeline                          
 *   Copyright (C) 2006 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
 */
 
/*
 * $Author: amodigli $
 * $Date: 2012-04-26 14:08:55 $
 * $Revision: 1.4 $
 * $Name: not supported by cvs2svn $
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
  Includes
  ---------------------------------------------------------------------------*/
 
#include <cpl.h>
 
#include "xsh_utils.h"
//#include "xsh_pfits.h"
#include "xsh_dfs.h"
#include "xsh_drl.h"
#include "xsh_pfits.h"
#include <xsh_model_io.h>
#include <xsh_model_kernel.h>
#include <xsh_model_utils.h>
#include <xsh_error.h>
#include <xsh_model_io.h>
#include <xsh_parameters.h>
 
#define RECIPE_ID "xsh_util_guess_xy"
#define RECIPE_AUTHOR "A.Modigliani, P. Bristow"
#define RECIPE_CONTACT "amodigli@eso.org"
 
/*-----------------------------------------------------------------------------
  Functions prototypes
  ---------------------------------------------------------------------------*/
/*
static cpl_frame*
xsh_util_model_SPF_create(cpl_frame* config_frame,xsh_instrument* instrument);
*/
 
static int xsh_util_guess_xy_create(cpl_plugin *);
static int xsh_util_guess_xy_exec(cpl_plugin *);
static int xsh_util_guess_xy_destroy(cpl_plugin *);
static int xsh_util_guess_xy(cpl_parameterlist *, cpl_frameset *);
 
 
/*-----------------------------------------------------------------------------
  Static variables
  ---------------------------------------------------------------------------*/
 
static char xsh_util_guess_xy_description[] =
  "This recipe finds X-Y guesses corresponding to 'grating_order','wavelength','slit' as in input tab. \n"
  "The sof file contains the names of the input FITS file\n"
  "tagged with XSH_MOD_CFG_arm.\n"
  "tagged with ARC_LINE_LIST_arm.\n"
  "This recipe has the following products:\n"
  "Model predictions (PRO CATG = MOD_arm)\n" ;
 
static char xsh_util_guess_xy_description_short[] ="Generate physical model guesses";
 
/*-----------------------------------------------------------------------------
  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_util_guess_xy",
          xsh_util_guess_xy_description_short,
          xsh_util_guess_xy_description,
          "Andrea Modigliani",
          "amodigli@eso.org",
          xsh_get_license(),
          xsh_util_guess_xy_create,
          xsh_util_guess_xy_exec,
          xsh_util_guess_xy_destroy);
 
  cpl_pluginlist_append(list, plugin);
    
  return 0 ;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_guess_xy_create(cpl_plugin * plugin)
{
  cpl_recipe      * recipe ;
  cpl_parameter* p=NULL;
 /* 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 ;
 
  /* 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);
  p = cpl_parameter_new_value("xsh.xsh_model.binx",
                  CPL_TYPE_INT,
                  "X binning ",
                  "xsh.xsh_model", 1);
 
  cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,"binx");
  cpl_parameterlist_append(recipe->parameters,p);
 
 
  p = cpl_parameter_new_value("xsh.xsh_model.biny",
                  CPL_TYPE_INT,
                  "X binning ",
                  "xsh.xsh_model", 1);
 
  cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,"biny");
  cpl_parameterlist_append(recipe->parameters,p);
 
 
 
 cleanup:
 
  return 0 ;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_guess_xy_exec(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 ;
 
  return xsh_util_guess_xy(recipe->parameters, recipe->frames) ;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_guess_xy_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_guess_xy(
                  cpl_parameterlist   *   parameters,
                  cpl_frameset        *   frameset)
{
 
 
  const char* recipe_tags[1] = {XSH_MOD_CFG};
 
  int recipe_tags_size = 1;
 
  cpl_frameset* raws=NULL;
  cpl_frameset* calib=NULL;
  cpl_frame*   wave_list=NULL ;
  cpl_frame*   xsh_config=NULL ;
  xsh_instrument* instrument=NULL;
  cpl_parameter* p=NULL;
  int binx=0;
  int biny=0;
  int i=0;
  int nrow=0;
  double* pord=NULL;
  double* pwav=NULL;
  double* pslit=NULL;
  double x=0;
  double y=0;
  xsh_xs_3 model_config ;
  cpl_table* input_table=NULL;
  const char* input_table_name = NULL;
  //double mm2nm=1.E6;
  double wave=0;
  int ord=0;
  double s=0;
 
  check( xsh_begin( frameset, parameters, &instrument, &raws, &calib,
            recipe_tags, recipe_tags_size, RECIPE_ID,
                    XSH_BINARY_VERSION,
            xsh_util_guess_xy_description_short ) ) ;
  check(xsh_config =  xsh_find_frame_with_tag( calib,XSH_MOD_CFG,
                           instrument));
  check(wave_list = xsh_find_frame_with_tag( calib, XSH_ARC_LINE_LIST,
                         instrument));
  check(p = cpl_parameterlist_find(parameters,"xsh.xsh_model.binx"));
  check(binx = cpl_parameter_get_int(p));
 
  check(p = cpl_parameterlist_find(parameters,"xsh.xsh_model.biny"));
  check(biny = cpl_parameter_get_int(p));
  xsh_msg("cfg frm name=%s",cpl_frame_get_filename(xsh_config));
  check( xsh_model_config_load_best( xsh_config, &model_config));
  xsh_model_binxy(&model_config,binx,biny);
 
 
  input_table_name=cpl_frame_get_filename(wave_list);
  input_table=cpl_table_load(input_table_name,1,0);
  check(nrow=cpl_table_get_nrow(input_table));
  //cpl_table_dump(input_table,1,3,stdout);
  check(pwav=cpl_table_get_data_double(input_table,"wavelength"));
  check(pord=cpl_table_get_data_double(input_table,"grating_order"));
  check(pslit=cpl_table_get_data_double(input_table,"slit"));
  //xsh_model_io_dump(&model_config);
  for(i=0;i<nrow;i++) {
     //wave=pwav[i]*mm2nm;
     wave=pwav[i];
     ord=(int)pord[i];
     s=pslit[i]; 
     check(xsh_model_get_xy(&model_config,instrument,wave,ord,s,&x,&y));
     xsh_msg("ord=%d wav=%10.8g s=%g ==>x=%16.13g y=%16.13g",ord,wave,s,x,y);
  }
 
 cleanup:
  xsh_instrument_free(&instrument);
  xsh_free_frameset(&raws);
  xsh_free_frameset(&calib);
 
  return 0 ;
}