xsh_util_ronbias.c

Go to the documentation of this file.

/* $Id: xsh_util_ronbias.c,v 1.8 2012-04-26 14:03:20 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
 */
 
/*
 * $Author: amodigli $
 * $Date: 2012-04-26 14:03:20 $
 * $Revision: 1.8 $
 * $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>
 
 
/*-----------------------------------------------------------------------------
                               Defines
 ----------------------------------------------------------------------------*/
 
#define XSH_UTL_RONBIAS_RECIPE_ID "xsh_util_ronbias"
#define XSH_UTL_RONBIAS_RECIPE_AUTHOR "A.Modigliani"
#define XSH_UTL_RONBIAS_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_ronbias_create(cpl_plugin *) ;
static int xsh_util_ronbias_exec(cpl_plugin *) ;
static int xsh_util_ronbias_destroy(cpl_plugin *) ;
static int xsh_util_ronbias(cpl_parameterlist *, cpl_frameset *) ;
 
/*-----------------------------------------------------------------------------
                            Static variables
 ----------------------------------------------------------------------------*/
 
static char 
xsh_util_ronbias_description_short[] = "Rebin images";
static char xsh_util_ronbias_description[] =
"This recipe performs ron computation on a bias pair.\n"
"The input files should be tagged as BIAS_arm)\n"
"The output is a bias frame difference with RON computed as follows:\n"
"The input biase difference is computed. Then a median on nsampl (100) \n"
"random boxes of size xsize*ysize (20x20) is computed \n"
"then the rms of the obtained values is determined and divided by sqrt(2)\n"
"This gives the RON in [ADU]\n"
"Information on relevant parameters can be found with\n"
"esorex --params xsh_util_ronbias\n"
"esorex --help xsh_util_ronbias\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_RONBIAS_RECIPE_ID,
                    xsh_util_ronbias_description_short,
                    xsh_util_ronbias_description,
                    XSH_UTL_RONBIAS_RECIPE_AUTHOR,
                    XSH_UTL_RONBIAS_RECIPE_CONTACT,
                    xsh_get_license(),
                    xsh_util_ronbias_create,
                    xsh_util_ronbias_exec,
                    xsh_util_ronbias_destroy) ;
 
    cpl_pluginlist_append(list, plugin) ;
    
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_ronbias_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_RONBIAS_RECIPE_ID, 
                  recipe->parameters ) ) ;
    xsh_parameters_decode_bp(XSH_UTL_RONBIAS_RECIPE_ID,recipe->parameters,-1);
    /* Fill the parameters list */
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.nsampl", 
                                CPL_TYPE_INT, 
                                "Number of sampling values", 
                                "xsh.xsh_util_ronbias",100);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "nsampl") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
 
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.hsize", 
                                CPL_TYPE_INT, 
                                "Random square boxes size", 
                                "xsh.xsh_util_ronbias",10);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "hsize") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.llx", 
                                CPL_TYPE_INT, 
                                "Lower left X of sampling region", 
                                "xsh.xsh_util_ronbias",-1);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "llx") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.lly", 
                                CPL_TYPE_INT, 
                                "Lower left Y of sampling region", 
                                "xsh.xsh_util_ronbias",-1);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lly") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
 
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.urx", 
                                CPL_TYPE_INT, 
                                "Upper right X of sampling region", 
                                "xsh.xsh_util_ronbias",-1);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "urx") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
    p = cpl_parameter_new_value("xsh.xsh_util_ronbias.ury", 
                                CPL_TYPE_INT, 
                                "Upper right Y of sampling region", 
                                "xsh.xsh_util_ronbias",-1);
    cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "ury") ;
    cpl_parameterlist_append(recipe->parameters, p) ;
 
 
 
 
 
 cleanup: 
 
    /* Return */
    return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_ronbias_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_ronbias(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_ronbias_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_ronbias( cpl_parameterlist   *   parlist, 
        cpl_frameset        *   frames)
{
    cpl_parameter       *   param= NULL ;
 
    int hsize=1;
    int nsampl=0;
    int llx=1;
    int lly=1;
    int urx=1;
    int ury=1;
 
    double ron;
    double ron_err;
 
 
    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_ronbias.nsampl"));
    check(nsampl=cpl_parameter_get_int(param));
 
    check(param=cpl_parameterlist_find(parlist,"xsh.xsh_util_ronbias.hsize"));
    check(hsize=cpl_parameter_get_int(param));
 
 
    check(param=cpl_parameterlist_find(parlist, "xsh.xsh_util_ronbias.llx"));
    check(llx=cpl_parameter_get_int(param));
 
    check(param=cpl_parameterlist_find(parlist, "xsh.xsh_util_ronbias.lly"));
    check(lly=cpl_parameter_get_int(param));
 
    check(param=cpl_parameterlist_find(parlist, "xsh.xsh_util_ronbias.urx"));
    check(urx=cpl_parameter_get_int(param));
 
    check(param=cpl_parameterlist_find(parlist, "xsh.xsh_util_ronbias.ury"));
    check(ury=cpl_parameter_get_int(param));
 
    check(xsh_compute_ron(frames,llx,lly,urx,ury,nsampl,hsize,1,&ron,&ron_err));
 
    xsh_msg("ron=%g ron_err=%g",ron,ron_err);
 
 cleanup:
 
    if (cpl_error_get_code()) {
       return -1 ;
    } else {
       return 0 ;
    }
 
}