xsh_scired_ifu_stare

Macros
#define	RECIPE_ID   "xsh_scired_ifu_stare_drl"
#define	RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#define	RECIPE_CONTACT   "amodigli@eso.org"
#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_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par)
static cpl_error_code	xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg)
	Scales 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 []
static char	xsh_scired_ifu_stare_description_short []
static char	xsh_scired_ifu_stare_description []

Detailed Description

This recipe ... See man-page for details.

Macro Definition Documentation

RECIPE_AUTHOR [1/2]

#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"

Definition at line 73 of file xsh_scired_ifu_stare.c.

RECIPE_AUTHOR [2/2]

#define RECIPE_AUTHOR   "A.Modigliani, J.Vernet, P. Bristow"

Definition at line 75 of file xsh_util_ifu_stare.c.

RECIPE_CONTACT [1/2]

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 74 of file xsh_scired_ifu_stare.c.

RECIPE_CONTACT [2/2]

#define RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Definition at line 76 of file xsh_util_ifu_stare.c.

RECIPE_ID [1/2]

#define RECIPE_ID   "xsh_scired_ifu_stare_drl"

Definition at line 72 of file xsh_scired_ifu_stare.c.

RECIPE_ID [2/2]

#define RECIPE_ID   "xsh_scired_ifu_stare"

Definition at line 74 of file xsh_util_ifu_stare.c.

Function Documentation

cpl_plugin_get_info()

int cpl_plugin_get_info

(

cpl_pluginlist *

list

)

Build the list of available plugins, for this module.

Parameters

list	the plugin list

Returns

0 if everything is ok, -1 otherwise

Create the recipe instance and make it available to the application using the interface. This function is exported.

Definition at line 133 of file xsh_scired_ifu_stare.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_scired_ifu_stare_create(), xsh_scired_ifu_stare_description, xsh_scired_ifu_stare_description_short, xsh_scired_ifu_stare_destroy(), and xsh_scired_ifu_stare_exec().

xsh_params_bin_scale()

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

static

Scales input parameters for binning.

Parameters

raws	the frames list
backg	the structure controlling inter-order bacground computation

In case of failure the cpl_error_code is set.

Definition at line 398 of file xsh_scired_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_params_monitor() [1/2]

static cpl_error_code xsh_params_monitor ( xsh_background_param *  backg, xsh_rectify_param *  rectify_par  )

static

Definition at line 418 of file xsh_util_ifu_stare.c.

References xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rectify_param::rectif_radius, xsh_background_param::sampley, and xsh_msg_dbg_low.

Referenced by xsh_scired_ifu_stare().

xsh_params_monitor() [2/2]

static cpl_error_code xsh_params_monitor ( xsh_background_param *  backg, xsh_rectify_param *  rectify_par, xsh_localize_obj_param *  loc_obj_par  )

static

Definition at line 365 of file xsh_scired_ifu_stare.c.

References xsh_localize_obj_param::loc_chunk_nb, xsh_localize_obj_param::nod_step, xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rectify_param::rectif_radius, xsh_background_param::sampley, and xsh_msg_dbg_low.

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 remove_crh_single

< Output of xsh_divide_flat

< Output of xsh_rectify_ifu

< Output of xsh_localize_object

< Final (result) frame

Definition at line 481 of file xsh_scired_ifu_stare.c.

References assure, check, xsh_rectify_param::conserve_flux, instrument, method, xsh_background_param::method, xsh_instrument::mode, RECIPE_ID, xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_pre_3d(), xsh_add_product_table(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_ILLEGAL_MSG, xsh_begin(), xsh_blaze_image(), xsh_check_afc(), xsh_check_get_map(), xsh_check_remove_crh_multiple(), xsh_check_subtract_bias(), xsh_check_subtract_dark(), xsh_cube(), xsh_cube_qc_trace_window(), xsh_divide_by_blaze(), xsh_divide_flat(), xsh_end(), xsh_error_reset, xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_find_master_bpmap(), xsh_find_master_flat(), xsh_find_offset_tab_ifu(), xsh_find_spectral_format(), xsh_find_wave_tab(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), XSH_GET_TAG_FROM_ARM, XSH_IFU_STARE_REMOVE_CRH, xsh_ifu_wavetab_create(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_update_from_spectralformat(), xsh_localize_obj_ifu(), XSH_MASTER_BIAS, XSH_MASTER_DARK, xsh_merge_ord_ifu(), XSH_MOD_CFG_OPT_AFC, XSH_MODE_IFU, xsh_msg, xsh_msg_error, xsh_msg_warning, XSH_OBJECT_IFU_STARE, XSH_ORDER_TAB_AFC_IFU, xsh_parameters_background_get(), xsh_parameters_bary_corr_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_extract_get(), xsh_parameters_get_boolean(), xsh_parameters_get_double(), xsh_parameters_get_string(), xsh_parameters_localize_obj_get(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_pfits_get_naxis2(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify_ifu(), xsh_rectify_params_set_defaults(), XSH_REGDEBUG, xsh_remove_crh_single(), xsh_scired_ifu_stare_description_short, xsh_set_recipe_file_prefix(), xsh_shift_offsettab(), XSH_SHIFT_TAB_IFU, xsh_stack_frames_get(), XSH_STD_FLUX_IFU_STARE, XSH_STD_TELL_IFU_STARE, xsh_stringcat_any(), and xsh_subtract_background().

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 175 of file xsh_scired_ifu_stare.c.

References assure, BARY_CORR_NONE, check, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, 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_extract_create(), xsh_parameters_generic(), xsh_parameters_interpolate_bp_create(), xsh_parameters_localize_obj_create(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), xsh_parameters_stack_create(), XSH_SLIT_BIN_SIZE_PIPE_NIR, and XSH_WAVE_BIN_SIZE_PIPE_NIR.

Referenced by cpl_plugin_get_info().

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 335 of file xsh_scired_ifu_stare.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

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 301 of file xsh_scired_ifu_stare.c.

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

Referenced by cpl_plugin_get_info().

Variable Documentation

xsh_scired_ifu_stare_description [1/2]

char xsh_scired_ifu_stare_description[]

static

Initial value:

=
"This recipe reduces science exposure in IFU configuration and stare mode\n\
Input Frames : \n\
  - A set of n Science frames ( n == 1 or >=3, \
Tag = OBJECT_IFU_STARE_arm or STD_TELL_IFU_STARE_arm or STD_FLUX_IFU_STARE_arm)\n\
  - A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - [OPTIONAL]A master dark frame (Tag = MASTER_DARK_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An AFC corrected order table frame (Tag = ORDER_TAB_AFC_IFU_arm)\n\
  - [physmod] An AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)\n\
  - [poly] An AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm) \n\
  - [OPTIONAL] An AFC corrected dispersion solution frame (Tag = DISP_TAB_AFC_arm)\n\
  - [OPTIONAL] A slit map (Tag = SLIT_MAP_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)\n\
  - [OPTIONAL] A mask of telluric lines (Tag = TELL_MASK_arm)\n\
Products : \n\
  - 3 Spectrum order tables 2D (1 per slitlet), PRO.CATG=ORDER2D_slitlet_IFU_arm\n\
  - 3 Spectrum merge tables 2D (1 per slitlet), PRO.CATG=MERGE2D_slitlet_IFU_arm\n\
  - 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_arm\n"

Definition at line 97 of file xsh_scired_ifu_stare.c.

Referenced by cpl_plugin_get_info().

xsh_scired_ifu_stare_description [2/2]

char xsh_scired_ifu_stare_description[]

static

Initial value:

=
"This recipe reduce science IFU stare exposures with 3D cube generation\n\
Input Frames : \n\
  - A set of n Science frames ( n == 1 or >=3, \
    Tag = OBJECT_IFU_STARE_UVB)\n\
  - A spectral format table frame (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - A master dark frame (Tag = MASTER_DARK_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An order edges table frame(Tag = ORDER_TAB_EDGES_IFU_arm)\n\
  - [physmod] An AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)\n\
  - [poly] An AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm)\n\
  - [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)\n\
  - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)\n\
Products : \n\
 - Merged 3D data cube (PREFIX_MERGE3D_DATA_OBJ_arm)\n\
 - QC Traces of 3D data cube (PREFIX_MERGE3D_TRACE_OBJ_arm)\n\
 - Order by order 3D data cube (PREFIX_ORDER3D_DATA_OBJ_arm)\n\
 - Order by order 3D qual cube (IFU_CFG_COR_arm)\n\
 - Order by order 3D qual cube (PREFIX_MERGE3D_DATA_SKY_arm)\n\
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC\n"

Definition at line 99 of file xsh_util_ifu_stare.c.

xsh_scired_ifu_stare_description_short [1/2]

char xsh_scired_ifu_stare_description_short[]

static

Initial value:

=
"Reduce science exposure in IFU configuration and stare mode"

Definition at line 94 of file xsh_scired_ifu_stare.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_ifu_stare().

xsh_scired_ifu_stare_description_short [2/2]

char xsh_scired_ifu_stare_description_short[]

static

Initial value:

=
"Reduce science IFU stare exposures and build a 3D cube"

Definition at line 96 of file xsh_util_ifu_stare.c.

Referenced by xsh_scired_ifu_stare().