xsh_util_ifu_offset.c File Reference

#include <xsh_error.h>
#include <xsh_utils.h>
#include <xsh_msg.h>
#include <xsh_dfs.h>
#include <xsh_pfits.h>
#include <xsh_data_spectrum1D.h>
#include <xsh_utils_image.h>
#include <xsh_model_io.h>
#include <xsh_model_utils.h>
#include <xsh_utils_ifu.h>
#include <xsh_utils_scired_slit.h>
#include <xsh_model_arm_constants.h>
#include <xsh_drl.h>
#include <xsh_drl_check.h>
#include <cpl.h>

Go to the source code of this file.

Macros
#define	RECIPE_ID   "xsh_scired_ifu_offset"
#define	RECIPE_AUTHOR   "A.Modigliani, J.Vernet, P. Bristow"
#define	RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Functions
static int	xsh_scired_ifu_offset_create (cpl_plugin *plugin)
	Setup the recipe options.
static int	xsh_scired_ifu_offset_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.
static int	xsh_scired_ifu_offset_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.
static void	xsh_scired_ifu_offset (cpl_parameterlist *parameters, cpl_frameset *frameset)
	Interpret the command line options and execute the data processing.
int	cpl_plugin_get_info (cpl_pluginlist *list)
	Build the list of available plugins, for this module.
static cpl_error_code	xsh_params_monitor (xsh_rectify_param *rectify_par)
	monitor parameters value

Variables
static char	xsh_scired_ifu_offset_description_short []
static char	xsh_scired_ifu_offset_description []

Function Documentation

xsh_scired_ifu_offset()

static void xsh_scired_ifu_offset ( cpl_parameterlist *  parameters, cpl_frameset *  frameset  )

static

Interpret the command line options and execute the data processing.

Parameters

parameters	the parameters list
frameset	the frames list

In case of failure the cpl_error_code is set.

< frameset of subtracted offset frames

< frameset of clean frames after divide flat

< Comined frame

< Rectifid frame set

< Final (result) frame

< frameset of rectified frames

< frameset of rectified frames

Definition at line 463 of file xsh_util_ifu_offset.c.

References assure, check, xsh_rectify_param::conserve_flux, instrument, xsh_instrument::mode, RECIPE_ID, xsh_rectify_param::rectify_full_slit, xsh_add_product_image(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_build_ifu_cube(), xsh_build_ifu_map(), xsh_check_get_map(), xsh_check_load_master_bpmap(), xsh_combine_offset(), xsh_dfs_split_offset(), xsh_end(), xsh_ensure_raws_input_offset_recipe_is_proper(), xsh_error_reset, xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_find_master_flat(), xsh_find_order_tab_edges(), xsh_find_spectral_format(), xsh_frameset_check_uniform_exptime(), xsh_frameset_crh_single(), xsh_frameset_mflat_divide(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), XSH_IFU_CFG_COR, XSH_IFU_CFG_TAB, xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MASTER_BIAS, XSH_MASTER_DARK, XSH_MOD_CFG_OPT_AFC, XSH_MODE_IFU, xsh_msg, xsh_msg_error, xsh_msg_warning, XSH_OBJECT_IFU_OFFSET, xsh_parameters_bary_corr_get(), xsh_parameters_get_boolean(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_monitor(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify_params_set_defaults(), xsh_scired_ifu_offset_description_short, xsh_set_recipe_file_prefix(), xsh_set_recipe_sky_file_prefix(), XSH_SKY_IFU, XSH_SKY_MAP, XSH_SLICE_OFFSET, xsh_stack_frames_get(), XSH_STD_FLUX_IFU_OFFSET, XSH_STD_TELL_IFU_OFFSET, xsh_stringcat_any(), xsh_subtract_sky_offset(), xsh_util_frameset_collapse_mean(), and XSH_WAVE_TAB_AFC.

Referenced by xsh_scired_ifu_offset_exec().

xsh_scired_ifu_offset_create()

static int xsh_scired_ifu_offset_create ( cpl_plugin *  plugin )

static

Setup the recipe options.

Parameters

plugin

the plugin

Returns

0 if everything is ok

Create the recipe instance and make it available to the application using the interface.

Definition at line 176 of file xsh_util_ifu_offset.c.

References assure, BARY_CORR_NONE, check, LOC_MANUAL_METHOD, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_bary_corr_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_decode_bp(), xsh_parameters_generic(), xsh_parameters_localize_obj_create(), xsh_parameters_new_boolean(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), and xsh_parameters_stack_create().

xsh_scired_ifu_offset_destroy()

static int xsh_scired_ifu_offset_destroy ( cpl_plugin *  plugin )

static

Destroy what has been created by the 'create' function.

Parameters

plugin

the plugin

Returns

0 if everything is ok

Definition at line 425 of file xsh_util_ifu_offset.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

xsh_scired_ifu_offset_exec()

static int xsh_scired_ifu_offset_exec ( cpl_plugin *  plugin )

static

Execute the plugin instance given by the interface.

Parameters

plugin

the plugin

Returns

0 if everything is ok

Definition at line 288 of file xsh_util_ifu_offset.c.

References assure, xsh_error_dump, xsh_error_reset, and xsh_scired_ifu_offset().