Defines | |
#define | RECIPE_ID "xsh_absorp" |
#define | RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, A. Modigliani" |
#define | RECIPE_CONTACT "regis.haigron@obspm.fr,amodigli@eso.org" |
Functions | |
static int | xsh_absorp_create (cpl_plugin *plugin) |
Setup the recipe options. | |
static int | xsh_absorp_exec (cpl_plugin *plugin) |
Execute the plugin instance given by the interface. | |
static int | xsh_absorp_destroy (cpl_plugin *plugin) |
Destroy what has been created by the 'create' function. | |
static cpl_error_code | xsh_absorp (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_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_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par, xsh_opt_extract_param *opt_extract_par, int sub_sky_nbkpts1, int sub_sky_nbkpts2) |
static cpl_error_code | xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg, xsh_opt_extract_param *opt_extract_par, int *sub_sky_nbkpts1, int *sub_sky_nbkpts2) |
Interpret the command line options and execute the data processing. | |
Variables | |
static char | xsh_absorp_description_short [] |
static char | xsh_absorp_description [] |
This recipe ... See man-page for details.
#define RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, A. Modigliani" |
Definition at line 74 of file xsh_absorp.c.
#define RECIPE_CONTACT "regis.haigron@obspm.fr,amodigli@eso.org" |
Definition at line 75 of file xsh_absorp.c.
#define RECIPE_ID "xsh_absorp" |
Definition at line 73 of file xsh_absorp.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 151 of file xsh_absorp.c.
References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_absorp_create(), xsh_absorp_description, xsh_absorp_description_short, xsh_absorp_destroy(), xsh_absorp_exec(), and xsh_get_license().
static cpl_error_code xsh_absorp | ( | 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.
< Nb of breakpoints for the first call to subtract_sky_single
< Nb of breakpoints for the second call to subtract_sky_single
< if 0 DO NOT subtract sky single
< Output of remove_crh
< Output of subtract bias
< Output of subtract dark
< Output of subtract background
< Output of xsh_divide_flat
< Output of xsh_subtract_sky_single
< Output of xsh_subtract_sky_single Second pass (with localization table)
< Output of xsh_rectfiy
< Output of xsh_localize_object
< Output of remove_crh_single
Definition at line 587 of file xsh_absorp.c.
References xsh_instrument::arm, check, check_msg, xsh_rectify_param::conserve_flux, instrument, xsh_remove_crh_single_param::nb_iter, RECIPE_ID, SUBTRACT_SKY_SINGLE_NBKPTS, xsh_absorp_description_short, xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_spectrum(), xsh_add_product_table(), xsh_add_product_vector(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL_MSG, xsh_begin(), xsh_check_divide_flat(), xsh_check_remove_crh_multiple(), xsh_check_subtract_bias(), xsh_check_subtract_dark(), xsh_check_subtract_sky_single(), xsh_compute_absorp(), xsh_end(), xsh_extract(), xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_frame_image_ext_qc_trace_window(), xsh_frame_image_qc_trace_window(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), XSH_GET_TAG_FROM_ARM, xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_nir_corr_if_JH(), xsh_merge_ord(), xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_msg_error, XSH_OBJECT_SLIT_STARE, xsh_opt_extract(), XSH_ORDER2D, xsh_parameters_get_double(), xsh_parameters_get_int(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_pfits_get_naxis2(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify(), xsh_set_recipe_file_prefix(), xsh_slit_stare_correct_crh_and_sky(), xsh_slit_stare_get_calibs(), xsh_slit_stare_get_maps(), xsh_slit_stare_get_params(), XSH_SLIT_STARE_REMOVE_CRH, xsh_stack_frames_get(), XSH_STD_TELL_SLIT_STARE, xsh_subtract_background(), and XSH_TELL_LINE_LIST.
Referenced by xsh_absorp_exec().
static int xsh_absorp_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 193 of file xsh_absorp.c.
References assure, xsh_opt_extract_param::box_hsize, BSPLINE_METHOD, check, xsh_opt_extract_param::chunk_size, xsh_opt_extract_param::clip_frac, xsh_opt_extract_param::clip_kappa, xsh_opt_extract_param::clip_niter, FINE, GAUSS_METHOD, xsh_opt_extract_param::lambda_step, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, xsh_opt_extract_param::method, xsh_opt_extract_param::niter, xsh_opt_extract_param::oversample, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_decode_bp(), xsh_parameters_extract_create(), xsh_parameters_find(), xsh_parameters_generic(), xsh_parameters_localize_obj_create(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_new_int(), xsh_parameters_opt_extract_create(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), xsh_parameters_stack_create(), xsh_parameters_subtract_sky_single_create(), XSH_SLIT_BIN_SIZE_PIPE_NIR, and XSH_WAVE_BIN_SIZE_PIPE_NIR.
Referenced by cpl_plugin_get_info().
static int xsh_absorp_destroy | ( | cpl_plugin * | plugin | ) | [static] |
Destroy what has been created by the 'create' function.
plugin | the plugin |
Definition at line 371 of file xsh_absorp.c.
References assure, xsh_error_reset, and xsh_free_parameterlist().
Referenced by cpl_plugin_get_info().
static int xsh_absorp_exec | ( | cpl_plugin * | plugin | ) | [static] |
Execute the plugin instance given by the interface.
plugin | the plugin |
Definition at line 337 of file xsh_absorp.c.
References assure, xsh_absorp(), xsh_error_dump, and xsh_error_reset.
Referenced by cpl_plugin_get_info().
static cpl_error_code xsh_params_bin_scale | ( | cpl_frameset * | raws, | |
xsh_background_param * | backg, | |||
xsh_opt_extract_param * | opt_extract_par, | |||
int * | sub_sky_nbkpts1, | |||
int * | sub_sky_nbkpts2 | |||
) | [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.
Definition at line 470 of file xsh_absorp.c.
References binx, biny, xsh_opt_extract_param::box_hsize, 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_absorp(), xsh_scired_ifu_offset(), and xsh_scired_ifu_stare().
static cpl_error_code xsh_params_monitor | ( | xsh_background_param * | backg, | |
xsh_rectify_param * | rectify_par, | |||
xsh_localize_obj_param * | loc_obj_par, | |||
xsh_opt_extract_param * | opt_extract_par, | |||
int | sub_sky_nbkpts1, | |||
int | sub_sky_nbkpts2 | |||
) | [static] |
Definition at line 427 of file xsh_absorp.c.
References xsh_opt_extract_param::box_hsize, xsh_opt_extract_param::chunk_size, xsh_opt_extract_param::lambda_step, 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_absorp().
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 400 of file xsh_absorp.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_absorp().
char xsh_absorp_description[] [static] |
Definition at line 99 of file xsh_absorp.c.
Referenced by cpl_plugin_get_info().
char xsh_absorp_description_short[] [static] |
"Create a telluric absorption mask"
Definition at line 96 of file xsh_absorp.c.
Referenced by cpl_plugin_get_info(), and xsh_absorp().