Defines | |
#define | RECIPE_ID "xsh_scired_slit_offset" |
#define | RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer" |
#define | RECIPE_CONTACT "amodigli@eso.org" |
Functions | |
static int | xsh_scired_slit_offset_create (cpl_plugin *plugin) |
Setup the recipe options. | |
static int | xsh_scired_slit_offset_exec (cpl_plugin *plugin) |
Execute the plugin instance given by the interface. | |
static int | xsh_scired_slit_offset_destroy (cpl_plugin *plugin) |
Destroy what has been created by the 'create' function. | |
static void | xsh_scired_slit_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_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par) |
static cpl_error_code | xsh_params_set_defaults (cpl_parameterlist *pars, const char *rec_id, xsh_instrument *inst, xsh_rectify_param *rectify_par, xsh_background_param *backg) |
static cpl_error_code | xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg) |
Scale relevant input parameters for binning. | |
Variables | |
static char | xsh_scired_slit_offset_description_short [] |
static char | xsh_scired_slit_offset_description [] |
This recipe ... See man-page for details.
#define RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer" |
Definition at line 73 of file xsh_scired_slit_offset.c.
#define RECIPE_CONTACT "amodigli@eso.org" |
Definition at line 74 of file xsh_scired_slit_offset.c.
#define RECIPE_ID "xsh_scired_slit_offset" |
Definition at line 72 of file xsh_scired_slit_offset.c.
int cpl_plugin_get_info | ( | cpl_pluginlist * | list | ) |
Build the list of available plugins, for this module.
list | the plugin list |
Create the recipe instance and make it available to the application using the interface. This function is exported.
Definition at line 136 of file xsh_scired_slit_offset.c.
References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_scired_slit_offset_create(), xsh_scired_slit_offset_description, xsh_scired_slit_offset_description_short, xsh_scired_slit_offset_destroy(), and xsh_scired_slit_offset_exec().
static cpl_error_code xsh_params_bin_scale | ( | cpl_frameset * | raws, | |
xsh_background_param * | backg | |||
) | [static] |
Scale relevant input parameters for binning.
raws | the frames list | |
backg | structure to control inter-order background computation |
In case of failure the cpl_error_code is set.
Definition at line 401 of file xsh_scired_slit_offset.c.
References binx, biny, check, xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_free_propertylist(), xsh_msg, xsh_pfits_get_binx(), and xsh_pfits_get_biny().
Referenced by xsh_scired_slit_offset().
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 344 of file xsh_scired_slit_offset.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, xsh_background_param::smooth_x, xsh_background_param::smooth_y, and xsh_msg_dbg_low.
Referenced by xsh_scired_slit_offset().
static cpl_error_code xsh_params_set_defaults | ( | cpl_parameterlist * | pars, | |
const char * | rec_id, | |||
xsh_instrument * | inst, | |||
xsh_rectify_param * | rectify_par, | |||
xsh_background_param * | backg | |||
) | [static] |
Definition at line 369 of file xsh_scired_slit_offset.c.
References check, xsh_background_param::radius_x, RECIPE_ID, XSH_ARM_NIR, xsh_instrument_get_arm(), xsh_parameters_find(), and xsh_rectify_params_set_defaults().
Referenced by xsh_scired_slit_offset().
static void xsh_scired_slit_offset | ( | cpl_parameterlist * | parameters, | |
cpl_frameset * | frameset | |||
) | [static] |
Interpret the command line options and execute the data processing.
parameters | the parameters list | |
frameset | the frames list |
In case of failure the cpl_error_code is set.
< Output of xsh_localize_object
< Output of remove_crh_single
< frameset of subtracted offset frames
< frameset of subtracted background frames
< frameset of clean offset frames
< frameset of rectified frames
< frameset of rectified frames
< Final (result) frame
< Final (result) frame
Definition at line 495 of file xsh_scired_slit_offset.c.
References xsh_instrument::arm, assure, check, check_msg, xsh_rectify_param::conserve_flux, instrument, LOCALIZATION_METHOD, xsh_extract_param::method, xsh_instrument::mode, RECIPE_ID, xsh_add_product_image(), xsh_add_product_spectrum(), xsh_add_temporary_file(), XSH_ARM_NIR, XSH_ATMOS_EXT, xsh_begin(), xsh_combine_nod(), xsh_compute_resampling_accuracy(), xsh_dfs_split_offset(), xsh_divide_flat(), xsh_end(), xsh_ensure_raws_input_offset_recipe_is_proper(), xsh_extract(), xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_flux_calibrate(), xsh_frameset_average_pre(), xsh_frameset_ext_table_frames(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_nir_corr_if_JH(), xsh_localize_obj(), xsh_mark_tell(), XSH_MERGE2D, xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_flux(), XSH_MRESPONSE_MERGE1D_SLIT, xsh_msg, xsh_msg_dbg_low, xsh_msg_error, XSH_OBJECT_SLIT_OFFSET, XSH_ORDER2D, xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_pre_frameset_subtract_frame(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify(), xsh_remove_crh_single(), XSH_RESPONSE_MERGE1D_SLIT, xsh_scired_slit_offset_description_short, xsh_set_recipe_file_prefix(), xsh_set_recipe_sky_file_prefix(), XSH_SKY_SLIT, xsh_slit_offset_get_calibs(), xsh_slit_offset_get_params(), XSH_STD_FLUX_SLIT_OFFSET, xsh_subtract_background(), xsh_subtract_sky_offset(), and XSH_TELL_MASK.
Referenced by xsh_scired_slit_offset_exec().
static int xsh_scired_slit_offset_create | ( | cpl_plugin * | plugin | ) | [static] |
Setup the recipe options.
plugin | the plugin |
Create the recipe instance and make it available to the application using the interface.
Definition at line 178 of file xsh_scired_slit_offset.c.
References assure, check, COMBINE_MEAN_METHOD, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, RECIPE_ID, WEIGHTED_MERGE_METHOD, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_combine_nod_create(), xsh_parameters_extract_create(), xsh_parameters_find(), xsh_parameters_generic(), xsh_parameters_localize_obj_create(), xsh_parameters_merge_ord_create(), xsh_parameters_new_boolean(), xsh_parameters_optimal_extract_create(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), and xsh_parameters_remove_crh_single_create().
Referenced by cpl_plugin_get_info().
static int xsh_scired_slit_offset_destroy | ( | cpl_plugin * | plugin | ) | [static] |
Destroy what has been created by the 'create' function.
plugin | the plugin |
Definition at line 314 of file xsh_scired_slit_offset.c.
References assure, xsh_error_reset, and xsh_free_parameterlist().
Referenced by cpl_plugin_get_info().
static int xsh_scired_slit_offset_exec | ( | cpl_plugin * | plugin | ) | [static] |
Execute the plugin instance given by the interface.
plugin | the plugin |
Definition at line 280 of file xsh_scired_slit_offset.c.
References assure, xsh_error_dump, xsh_error_reset, and xsh_scired_slit_offset().
Referenced by cpl_plugin_get_info().
char xsh_scired_slit_offset_description[] [static] |
"This recipe reduces science exposure in SLIT configuration and on/off mode\n\ Input Frames : \n\ - A set of n Science frames ( n even ), \ Tag = STD_FLUX_SLIT_OFFSET_arm, SKY_SLIT_arm\n\ - Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\ - A master flat frame (Tag = MASTER_FLAT_SLIT_arm)\n\ - An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm)\n\ - A wavelength calibration solution frame(Tag = WAVE_TAB_2D_arm)\n\ - [OPTIONAL] Table with dispersion coefficients (Tag = DISP_TAB_arm)\n\ It is required if -rectify-conserve-flux=TRUE\n\ - [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)\n\ - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)\n\ - [OPTIONAL] The instrument response table (Tag = RESPONSE_MERGE1D_SLIT_arm)\n\ - [OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm)\n\ - [OPTIONAL] A telluric mask (Tag = TELL_MASK_arm)\n\ Products : \n\ - PREFIX_ORDER2D_arm extracted spectrum, order-by-order, 2D\n\ - PREFIX_ORDER1D_arm extracted spectrum, order-by-order, 1D\n\ - PREFIX_MERGE2D_arm merged spectrum, 2D\n\ - PREFIX_MERGE1D_arm merged spectrum, 1D\n\ - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC\n\ - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUXCAL2D_MERGE2D_arm (2 dimension)\n\ - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUXCAL1D_MERGE1D_arm (1 dimension)\n"
Definition at line 97 of file xsh_scired_slit_offset.c.
Referenced by cpl_plugin_get_info().
char xsh_scired_slit_offset_description_short[] [static] |
"Reduce science exposure in SLIT configuration and on/off mode"
Definition at line 94 of file xsh_scired_slit_offset.c.
Referenced by cpl_plugin_get_info(), and xsh_scired_slit_offset().