X-shooter Pipeline Reference Manual 3.8.15
Macros | Functions | Variables
xsh_respon_slit_nod

Macros

#define RECIPE_ID   "xsh_respon_slit_nod"
 
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich A. Modigliani"
 
#define RECIPE_CONTACT   "amodigli@eso.org"
 
#define RECIPE_ID   "xsh_scired_slit_nod"
 
#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_respon_slit_nod_create (cpl_plugin *plugin)
 Setup the recipe options.
 
static int xsh_respon_slit_nod_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int xsh_respon_slit_nod_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static cpl_error_code xsh_respon_slit_nod (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 int xsh_scired_slit_nod_create (cpl_plugin *plugin)
 Setup the recipe options.
 
static int xsh_scired_slit_nod_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int xsh_scired_slit_nod_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static void xsh_scired_slit_nod (cpl_parameterlist *parameters, cpl_frameset *frameset)
 Corrects input parameters for binning.
 
static void xsh_get_binning (cpl_frameset *raws, int *binx, int *biny)
 set binning
 

Variables

static char xsh_respon_slit_nod_description_short []
 
static char xsh_respon_slit_nod_description []
 
static char xsh_scired_slit_nod_description_short []
 
static char xsh_scired_slit_nod_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, D. Bramich A. Modigliani"

Definition at line 80 of file xsh_respon_slit_nod.c.

◆ RECIPE_AUTHOR [2/2]

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

Definition at line 78 of file xsh_scired_slit_nod.c.

◆ RECIPE_CONTACT [1/2]

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 81 of file xsh_respon_slit_nod.c.

◆ RECIPE_CONTACT [2/2]

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 79 of file xsh_scired_slit_nod.c.

◆ RECIPE_ID [1/2]

#define RECIPE_ID   "xsh_respon_slit_nod"

Definition at line 79 of file xsh_respon_slit_nod.c.

◆ RECIPE_ID [2/2]

#define RECIPE_ID   "xsh_scired_slit_nod"

Definition at line 77 of file xsh_scired_slit_nod.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 152 of file xsh_respon_slit_nod.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_respon_slit_nod_create(), xsh_respon_slit_nod_description, xsh_respon_slit_nod_description_short, xsh_respon_slit_nod_destroy(), and xsh_respon_slit_nod_exec().

◆ xsh_get_binning()

static void xsh_get_binning ( cpl_frameset *  raws,
int *  binx,
int *  biny 
)
static

set binning

Parameters
rawsinput raw frames
binxx binning
binyy binning

Definition at line 425 of file xsh_scired_slit_nod.c.

References binx, biny, check, XSH_ASSURE_NOT_ILLEGAL_MSG, XSH_ASSURE_NOT_NULL_MSG, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_scired_slit_nod().

◆ xsh_respon_slit_nod()

static cpl_error_code xsh_respon_slit_nod ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
)
static

Interpret the command line options and execute the data processing.

Parameters
parametersthe parameters list
framesetthe frames list xsh_utils_image.c

In case of failure the cpl_error_code is set.

< Final (result) frame

< Final (result) frame

< Final (result) frame

< Final (result) frame

< normalized (T,gain,atm-ext) 1D frame

< normalized (T,gain,atm-ext) 2D frame

Definition at line 402 of file xsh_respon_slit_nod.c.

References xsh_instrument::arm, assure, calc_curve_qc(), calc_resp_qc(), check, CLEAN_METHOD, xsh_rectify_param::conserve_flux, exptime, get_average_qc_from_raws(), get_chromatic_eff(), instrument, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, xsh_localize_obj_param::method, xsh_extract_param::method, xsh_instrument::mode, RECIPE_ID, xsh_combine_nod_param::throwname, xsh_localize_obj_param::use_skymask, xsh_add_afc_info(), xsh_add_product_image(), xsh_add_product_orders_spectrum(), xsh_add_product_pre(), xsh_add_product_spectrum(), xsh_add_product_table(), XSH_ARM_NIR, XSH_ARM_UVB, XSH_ATMOS_EXT, xsh_begin(), xsh_calib_nir_respon_corr_if_JH(), xsh_check_get_map(), xsh_combine_nod(), xsh_compute_efficiency(), xsh_compute_resampling_accuracy(), xsh_compute_response2(), xsh_compute_response_ord(), xsh_compute_wavelength_resampling_accuracy(), xsh_end(), xsh_ensure_raws_number_is_even(), xsh_error_msg, xsh_extract_clean(), xsh_find_frame_with_tag(), xsh_flux_calibrate(), XSH_FLUX_STD_CAT, xsh_frame_table_monitor_flux_qc(), xsh_frameset_check_uniform_exptime(), xsh_frameset_crh_single(), xsh_frameset_uniform_bin(), 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_nir_corr_if_JH(), xsh_localize_obj(), xsh_merge_ord(), xsh_mode_is_physmod(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_extra_qc(), xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_msg_dbg_medium, xsh_msg_error, xsh_msg_warning, xsh_nod_group_by_reloff(), XSH_OBJECT_SLIT_NOD, XSH_ORDER2D, xsh_order_frameset_by_date(), xsh_parameters_get_boolean(), xsh_parameters_get_int(), xsh_parameters_interpolate_bp_get(), xsh_pfits_get_exptime(), xsh_prepare(), xsh_print_rec_status(), xsh_recipe_params_check(), XSH_RESP_FIT_POINTS_CAT, xsh_respon_slit_nod_description_short, xsh_respon_slit_nod_get_calibs(), xsh_scired_nod_get_parameters(), xsh_scired_slit_nod_accurate(), xsh_scired_slit_nod_fast(), xsh_set_recipe_file_prefix(), XSH_SKY_MAP, xsh_stack_frames_get(), XSH_STD_FLUX_SLIT_NOD, XSH_STD_TELL_SLIT_NOD, xsh_subtract_sky_nod(), and XSH_TELL_MOD_CAT.

Referenced by xsh_respon_slit_nod_exec().

◆ xsh_respon_slit_nod_create()

static int xsh_respon_slit_nod_create ( cpl_plugin *  plugin)
static

◆ xsh_respon_slit_nod_destroy()

static int xsh_respon_slit_nod_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 364 of file xsh_respon_slit_nod.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_respon_slit_nod_exec()

static int xsh_respon_slit_nod_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 330 of file xsh_respon_slit_nod.c.

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

Referenced by cpl_plugin_get_info().

◆ xsh_scired_slit_nod()

static void xsh_scired_slit_nod ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
)
static

Corrects input parameters for binning.

Parameters
binxx bin
binyy bin

In case of failure the cpl_error_code is set.

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.

Definition at line 507 of file xsh_scired_slit_nod.c.

References xsh_instrument::arm, assure, binx, biny, calc_curve_qc(), check, CLEAN_METHOD, xsh_rectify_param::conserve_flux, xsh_remove_crh_single_param::crh_frac_max, xsh_remove_crh_single_param::f_lim, get_average_qc_from_raws(), instrument, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, xsh_localize_obj_param::method, xsh_extract_param::method, xsh_instrument::mode, xsh_remove_crh_single_param::nb_iter, RECIPE_ID, xsh_remove_crh_single_param::sigma_lim, xsh_combine_nod_param::throwname, xsh_localize_obj_param::use_skymask, xsh_add_afc_info(), xsh_add_product_image(), xsh_add_product_orders_spectrum(), xsh_add_product_pre(), xsh_add_product_spectrum(), xsh_add_sdp_product_spectrum(), XSH_ARM_NIR, XSH_ARM_UVB, xsh_begin(), xsh_combine_nod(), xsh_compute_resampling_accuracy(), xsh_compute_wavelength_resampling_accuracy(), xsh_end(), xsh_ensure_raws_number_is_even(), xsh_error_msg, xsh_extract_clean(), xsh_find_frame_with_tag(), xsh_flux_calibrate(), xsh_frameset_check_uniform_exptime(), xsh_frameset_crh_single(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_get_binning(), XSH_GET_TAG_FROM_ARM, xsh_image_cut_dichroic_uvb(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_nir_corr_if_JH(), xsh_localize_obj(), xsh_mark_tell(), xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_extra_qc(), xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_nod_group_by_reloff(), XSH_OBJECT_SLIT_NOD, XSH_ORDER2D, xsh_order_frameset_by_date(), xsh_parameters_bary_corr_get(), xsh_parameters_cut_uvb_spectrum_get(), xsh_parameters_get_boolean(), xsh_parameters_get_int(), xsh_parameters_interpolate_bp_get(), xsh_prepare(), xsh_recipe_params_check(), xsh_remove_crh_single_params_set_defaults(), xsh_scired_nod_get_parameters(), xsh_scired_slit_nod_accurate(), xsh_scired_slit_nod_description_short, xsh_scired_slit_nod_fast(), xsh_scired_slit_nod_get_calibs(), xsh_set_recipe_file_prefix(), XSH_SKY_MAP, xsh_spectrum_cut_dichroic_uvb(), xsh_spectrum_orders_cut_dichroic_uvb(), xsh_stack_frames_get(), XSH_STD_FLUX_SLIT_NOD, XSH_STD_TELL_SLIT_NOD, xsh_subtract_sky_nod(), and XSH_TELL_MASK.

Referenced by xsh_scired_slit_nod_exec().

◆ xsh_scired_slit_nod_create()

static int xsh_scired_slit_nod_create ( cpl_plugin *  plugin)
static

◆ xsh_scired_slit_nod_destroy()

static int xsh_scired_slit_nod_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 374 of file xsh_scired_slit_nod.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

◆ xsh_scired_slit_nod_exec()

static int xsh_scired_slit_nod_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 340 of file xsh_scired_slit_nod.c.

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

Variable Documentation

◆ xsh_respon_slit_nod_description

char xsh_respon_slit_nod_description[]
static

Definition at line 104 of file xsh_respon_slit_nod.c.

Referenced by cpl_plugin_get_info().

◆ xsh_respon_slit_nod_description_short

char xsh_respon_slit_nod_description_short[]
static
Initial value:
=
"Reduce STD star frames in SLIT configuration and nod mode"

Definition at line 101 of file xsh_respon_slit_nod.c.

Referenced by cpl_plugin_get_info(), and xsh_respon_slit_nod().

◆ xsh_scired_slit_nod_description

char xsh_scired_slit_nod_description[]
static

Definition at line 102 of file xsh_scired_slit_nod.c.

◆ xsh_scired_slit_nod_description_short

char xsh_scired_slit_nod_description_short[]
static
Initial value:
=
"Reduce science frames in SLIT configuration and nod mode"

Definition at line 99 of file xsh_scired_slit_nod.c.

Referenced by xsh_scired_slit_nod().