X-shooter Pipeline Reference Manual 3.8.15
Macros | Functions | Variables
xsh_scired_slit_offset
Xshooter Recipes

Macros

#define RECIPE_ID   "xsh_scired_slit_offset"
 
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"
 
#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_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par)
 

Variables

static char xsh_scired_slit_offset_description_short []
 
static char xsh_scired_slit_offset_description []
 

Detailed Description

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

Macro Definition Documentation

◆ RECIPE_AUTHOR

#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"

Definition at line 75 of file xsh_scired_slit_offset.c.

◆ RECIPE_CONTACT

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 76 of file xsh_scired_slit_offset.c.

◆ RECIPE_ID

#define RECIPE_ID   "xsh_scired_slit_offset"

Definition at line 74 of file xsh_scired_slit_offset.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
listthe 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 149 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().

◆ xsh_params_monitor()

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

Definition at line 375 of file xsh_scired_slit_offset.c.

References xsh_localize_obj_param::loc_chunk_nb, xsh_localize_obj_param::nod_step, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rectify_param::rectif_radius, and xsh_msg_dbg_low.

Referenced by xsh_scired_slit_offset().

◆ 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
parametersthe parameters list
framesetthe 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 clean offset frames

< frameset of rectified frames

< frameset of rectified frames

< Final (result) frame

< Final (result) frame

Definition at line 400 of file xsh_scired_slit_offset.c.

References xsh_instrument::arm, assure, calc_curve_qc(), check, check_msg, CLEAN_METHOD, xsh_rectify_param::conserve_flux, get_average_qc_from_raws(), instrument, LOCALIZATION_METHOD, xsh_extract_param::method, xsh_instrument::mode, RECIPE_ID, xsh_add_afc_info(), xsh_add_product_image(), xsh_add_product_orders_spectrum(), xsh_add_product_spectrum(), xsh_add_sdp_product_spectrum(), xsh_add_temporary_file(), XSH_ARM_NIR, XSH_ARM_UVB, XSH_ATMOS_EXT, xsh_begin(), xsh_check_get_map(), xsh_combine_nod(), xsh_compute_resampling_accuracy(), xsh_compute_wavelength_resampling_accuracy(), xsh_dfs_split_offset(), xsh_divide_flat(), xsh_end(), xsh_ensure_raws_input_offset_recipe_is_proper(), xsh_extract_clean(), xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_flux_calibrate(), xsh_frameset_average_pre(), xsh_frameset_check_uniform_exptime(), xsh_frameset_crh_single(), xsh_frameset_ext_table_frames(), xsh_frameset_mflat_divide(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_image_cut_dichroic_uvb(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_nir_corr_if_JH(), xsh_localize_obj(), xsh_mark_tell(), XSH_MERGE2D, xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_extra_qc(), xsh_monitor_spectrum1D_flux(), XSH_MRESPONSE_MERGE1D_SLIT, xsh_msg, xsh_msg_dbg_low, xsh_msg_error, XSH_OBJECT_SLIT_OFFSET, XSH_ORDER2D, xsh_parameters_bary_corr_get(), xsh_parameters_cut_uvb_spectrum_get(), xsh_parameters_get_int(), xsh_parameters_interpolate_bp_get(), xsh_params_monitor(), xsh_pre_frameset_subtract_frame(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify(), xsh_rectify_params_set_defaults(), xsh_remove_crh_single_params_set_defaults(), XSH_RESPONSE_MERGE1D_SLIT, xsh_scired_slit_offset_description_short, xsh_set_recipe_file_prefix(), xsh_set_recipe_sky_file_prefix(), XSH_SKY_MAP, XSH_SKY_SLIT, xsh_slit_offset_get_calibs(), xsh_slit_offset_get_params(), xsh_spectrum_cut_dichroic_uvb(), xsh_spectrum_orders_cut_dichroic_uvb(), XSH_STD_FLUX_SLIT_OFFSET, xsh_subtract_sky_offset(), and XSH_TELL_MASK.

Referenced by xsh_scired_slit_offset_exec().

◆ xsh_scired_slit_offset_create()

static int xsh_scired_slit_offset_create ( cpl_plugin *  plugin)
static

Setup the recipe options.

Parameters
pluginthe plugin
Returns
0 if everything is ok

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

Definition at line 191 of file xsh_scired_slit_offset.c.

References assure, BARY_CORR_NONE, check, COMBINE_MEAN_METHOD, LOC_MANUAL_METHOD, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_bary_corr_create(), xsh_parameters_combine_nod_create(), xsh_parameters_decode_bp(), xsh_parameters_generic(), xsh_parameters_interpolate_bp_create(), xsh_parameters_localize_obj_create(), xsh_parameters_new_boolean(), xsh_parameters_new_int(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), and xsh_parameters_remove_crh_single_create().

Referenced by cpl_plugin_get_info().

◆ xsh_scired_slit_offset_destroy()

static int xsh_scired_slit_offset_destroy ( cpl_plugin *  plugin)
static

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

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 345 of file xsh_scired_slit_offset.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_scired_slit_offset_exec()

static int xsh_scired_slit_offset_exec ( cpl_plugin *  plugin)
static

Execute the plugin instance given by the interface.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 311 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().

Variable Documentation

◆ xsh_scired_slit_offset_description

char xsh_scired_slit_offset_description[]
static

Definition at line 99 of file xsh_scired_slit_offset.c.

Referenced by cpl_plugin_get_info().

◆ xsh_scired_slit_offset_description_short

char xsh_scired_slit_offset_description_short[]
static
Initial value:
=
"Reduce science exposure in SLIT configuration and on/off mode"

Definition at line 96 of file xsh_scired_slit_offset.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_slit_offset().

Generated by doxygen 1.9.6