xsh_util_ima_shift.c

Go to the documentation of this file.

/* $Id: xsh_util_ima_shift.c,v 1.6 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
 */
 
/*
 * $Author: amodigli $
 * $Date: 2012-04-26 14:03:50 $
 * $Revision: 1.6 $
 * $Name: not supported by cvs2svn $
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
/*-----------------------------------------------------------------------------
  Includes
  ----------------------------------------------------------------------------*/
#include <string.h>
 
/* cpl */
#include <cpl.h>
 
/* irplib */
#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_error.h>
 
 
/*-----------------------------------------------------------------------------
  Defines
  ----------------------------------------------------------------------------*/
 
#define XSH_UTL_IMA_SHIFT_RECIPE_ID "xsh_util_ima_shift"
#define XSH_UTL_IMA_SHIFT_RECIPE_AUTHOR "A.Modigliani"
#define XSH_UTL_IMA_SHIFT_RECIPE_CONTACT "Andrea.Modigliani@eso.org"
#define PRO_IMA "PRO_IMA"
#define KEY_VALUE_HPRO_DID                 "PRO-1.15"
/*-----------------------------------------------------------------------------
  Functions prototypes
  ----------------------------------------------------------------------------*/
 
static int xsh_util_ima_shift_create(cpl_plugin *) ;
static int xsh_util_ima_shift_exec(cpl_plugin *) ;
static int xsh_util_ima_shift_destroy(cpl_plugin *) ;
static int xsh_util_ima_shift(cpl_parameterlist *, cpl_frameset *) ;
 
/*-----------------------------------------------------------------------------
  Static variables
  ----------------------------------------------------------------------------*/
 
static char 
xsh_util_ima_shift_description_short[] = "Shift an image along X or Y";
static char xsh_util_ima_shift_description[] =
  "This recipe performs image shift along x or y.\n"
  "The input file is an image tagged as 'IMA'.\n"
  "The output is a shifted image\n"
  "xsh.xsh_util_ima_shift.shiftx having alias 'shiftx'\n"
  "xsh.xsh_util_ima_shift.shifty having alias 'shifty'\n"
  "Information on relevant parameters can be found with\n"
  "esorex --params xsh_util_ima_shift\n"
  "esorex --help xsh_util_ima_shift\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_IMA_SHIFT_RECIPE_ID,
          xsh_util_ima_shift_description_short,
          xsh_util_ima_shift_description,
          XSH_UTL_IMA_SHIFT_RECIPE_AUTHOR,
          XSH_UTL_IMA_SHIFT_RECIPE_CONTACT,
          xsh_get_license(),
          xsh_util_ima_shift_create,
          xsh_util_ima_shift_exec,
          xsh_util_ima_shift_destroy) ;
 
  cpl_pluginlist_append(list, plugin) ;
    
  return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_ima_shift_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_IMA_SHIFT_RECIPE_ID, 
                recipe->parameters ) ) ;
  xsh_parameters_decode_bp(XSH_UTL_IMA_SHIFT_RECIPE_ID,recipe->parameters,-1);
 
  p = cpl_parameter_new_value("xsh.xsh_util_ima_shift.shiftx", 
                  CPL_TYPE_INT, 
                  "A possible X shift", 
                  "xsh.xsh_util_ima_shiftx",0);
  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "shiftx") ;
  cpl_parameterlist_append(recipe->parameters, p) ;
 
  p = cpl_parameter_new_value("xsh.xsh_util_ima_shift.shifty", 
                  CPL_TYPE_INT, 
                  "A possible Y shift", 
                  "xsh.xsh_util_ima_shifty",0);
  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "shifty") ;
  cpl_parameterlist_append(recipe->parameters, p) ;
 
 cleanup: 
 
  /* Return */
  return 0;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
static int xsh_util_ima_shift_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_ima_shift(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_ima_shift_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_ima_shift( cpl_parameterlist   *   parlist, 
            cpl_frameset        *   framelist)
{
  cpl_parameter       *   param= NULL ;
  int                 shiftx=0 ;
  int                 shifty=0 ;
  cpl_image           *   ima=NULL ;
  char          name_o[256];
  cpl_propertylist    *   plist=NULL ;
  cpl_frameset * raw_set=NULL;
  int nraw=0;
  int n=0;
  int i=0;
  cpl_frame* frm=NULL;
  const char* name=NULL;
 
  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_ima_shift.shiftx"));
  check(shiftx=cpl_parameter_get_int(param));
 
  check(param=cpl_parameterlist_find(parlist, 
                     "xsh.xsh_util_ima_shift.shifty"));
  check(shifty=cpl_parameter_get_int(param));
  
 
  n=cpl_frameset_get_size(framelist);
  if(n<1) {
    xsh_msg_error("Empty input frame list!");
    goto cleanup ;
  }
 
  /* HOW TO ACCESS INPUT DATA */
  check_msg(raw_set=xsh_frameset_extract(framelist,XSH_IMA),
        "Found no input frames with tag %s",XSH_IMA);
  check(nraw=cpl_frameset_get_size(raw_set));
  if (nraw<1) {
    xsh_msg_error("Found no input frames with tag %s",XSH_IMA);
    goto cleanup;
  } else {
    for(i=0;i<nraw;i++) {
      check(frm=cpl_frameset_get_frame(raw_set,i));
      check(name=cpl_frame_get_filename(frm));
      check(ima=cpl_image_load(name,CPL_TYPE_FLOAT,0,0));
      check(cpl_image_shift(ima,shiftx,shifty));
      check(plist=cpl_propertylist_load(name,0));
      check(sprintf(name_o,"shiftx%d_shifty%d_%s",shiftx,shifty,name));
      xsh_msg("name_o=%s",name_o);
      check(cpl_image_save(ima,name_o,CPL_BPP_IEEE_FLOAT,plist,CPL_IO_DEFAULT));
      xsh_free_propertylist(&plist);
      xsh_free_image(&ima);
    }
  }
  xsh_free_frameset(&raw_set);
 
 cleanup:
  xsh_free_propertylist(&plist);
  xsh_free_image(&ima);
  xsh_free_frameset(&raw_set);
 
  if (cpl_error_get_code()) {
    return -1 ;
  } else {
    return 0 ;
  }
}