xsh_util_ifu_stare.c File Reference

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

Go to the source code of this file.

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

Functions
static int	xsh_scired_ifu_stare_create (cpl_plugin *plugin)
	Setup the recipe options.
static int	xsh_scired_ifu_stare_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.
static int	xsh_scired_ifu_stare_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.
static void	xsh_scired_ifu_stare (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_bin_scale (cpl_frameset *raws, xsh_background_param *backg)
	Rescale input parameters for binning.
static cpl_error_code	xsh_params_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par)

Variables
static char	xsh_scired_ifu_stare_description_short []
static char	xsh_scired_ifu_stare_description []

Function Documentation

xsh_params_bin_scale()

static cpl_error_code xsh_params_bin_scale ( cpl_frameset *  raws, xsh_background_param *  backg  )

static

Rescale input parameters for binning.

Parameters

raws	the frameset
backg	the inter-order background parameters

In case of failure the cpl_error_code is set.

Definition at line 275 of file xsh_util_ifu_stare.c.

References binx, biny, check, xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_scired_ifu_stare().

xsh_scired_ifu_stare()

static void xsh_scired_ifu_stare ( 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.

< Output of remove_crh

< Output of subtract bias

< Output of subtract dark

< Output of subtract background

< Output of xsh_divide_flat

Definition at line 446 of file xsh_util_ifu_stare.c.

References assure, check, check_msg, xsh_rectify_param::conserve_flux, instrument, xsh_instrument::mode, RECIPE_ID, xsh_add_product_image(), xsh_add_temporary_file(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_build_ifu_cube(), xsh_build_ifu_map(), xsh_check_subtract_bias(), xsh_create_map(), xsh_create_model_map(), xsh_divide_flat(), xsh_end(), xsh_find_disp_tab(), xsh_find_order_tab_edges(), xsh_find_slitmap(), xsh_find_wavemap(), xsh_frame_check_model_cfg_is_afc_corrected(), xsh_frame_check_model_cfg_is_proper_for_sci(), xsh_frameset_check_uniform_exptime(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), XSH_GET_TAG_FROM_ARM, xsh_ifu_stare_get_calibs(), xsh_ifu_trace_object_calibrate(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MODE_IFU, xsh_mode_set(), XSH_MODE_SLIT, xsh_model_temperature_update_frame(), xsh_msg, XSH_OBJECT_IFU_STARE, xsh_parameters_background_get(), xsh_parameters_bary_corr_get(), xsh_parameters_get_boolean(), xsh_parameters_get_int(), xsh_parameters_rectify_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify_params_set_defaults(), xsh_remove_crh_multiple(), xsh_scired_ifu_stare_description_short, xsh_set_recipe_file_prefix(), XSH_SKY_IFU, XSH_SLIT_MAP_MODEL, XSH_SLIT_STARE_REMOVE_CRH, xsh_stack_frames_get(), XSH_STD_FLUX_IFU_STARE, XSH_STD_TELL_IFU_STARE, xsh_subtract_background(), xsh_subtract_dark(), and XSH_WAVE_MAP_MODEL.

Referenced by xsh_scired_ifu_stare_exec().

xsh_scired_ifu_stare_create()

static int xsh_scired_ifu_stare_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 178 of file xsh_util_ifu_stare.c.

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

xsh_scired_ifu_stare_destroy()

static int xsh_scired_ifu_stare_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 391 of file xsh_util_ifu_stare.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

xsh_scired_ifu_stare_exec()

static int xsh_scired_ifu_stare_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 357 of file xsh_util_ifu_stare.c.

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