xsh_2dmap
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_2dmap"
#define RECIPE_AUTHOR   "R. Haigron, P. Bristow, D. Bramich, A. Modigliani"
#define RECIPE_CONTACT   "amodigli@eso.org"

Functions

static int xsh_2dmap_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_2dmap_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_2dmap_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_2dmap (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_verify_2dmap_poly_input (cpl_frame *order_tab_edges_frame, cpl_frame *spectralformat_frame, cpl_frame *theo_tab_frame)
static cpl_error_code xsh_params_set_defaults (cpl_parameterlist *pars, xsh_detect_arclines_param *arclines_p, xsh_instrument *inst)

Variables

static char xsh_2dmap_description_short []
static char xsh_2dmap_description []

Detailed Description

This recipe is used to obtain a first guess dispersion solution and order table. It calculates the geometry of the spectral format from a physical model and compares the 2dmaped line positions to the ones on the calibration frame See man-page for details.


Define Documentation

#define RECIPE_AUTHOR   "R. Haigron, P. Bristow, D. Bramich, A. Modigliani"

Definition at line 78 of file xsh_2dmap.c.

Referenced by cpl_plugin_get_info().

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 79 of file xsh_2dmap.c.

Referenced by cpl_plugin_get_info().

#define RECIPE_ID   "xsh_2dmap"

Definition at line 77 of file xsh_2dmap.c.

Referenced by cpl_plugin_get_info(), create(), xsh_2dmap(), xsh_2dmap_create(), xsh_absorp(), xsh_absorp_create(), xsh_cfg_recover_create(), xsh_cfg_recover_driver(), xsh_cfg_recover_last_step(), xsh_flexcomp(), xsh_flexcomp_create(), xsh_gain(), xsh_geom_ifu(), xsh_geom_ifu_create(), xsh_linear(), xsh_lingain(), xsh_lingain_create(), xsh_lingain_fill_parlist_default_nir(), xsh_lingain_fill_parlist_default_opt(), xsh_lingain_set_saturation_limit(), xsh_mbias(), xsh_mbias_create(), xsh_mdark(), xsh_mdark_create(), xsh_mflat(), xsh_mflat_create(), xsh_orderpos(), xsh_orderpos_create(), xsh_params_set_defaults(), xsh_predict(), xsh_predict_create(), xsh_respon_slit_nod(), xsh_respon_slit_nod_create(), xsh_respon_slit_offset(), xsh_respon_slit_offset_create(), xsh_respon_slit_stare(), xsh_respon_slit_stare_create(), xsh_scired_ifu_offset(), xsh_scired_ifu_offset_create(), xsh_scired_ifu_stare(), xsh_scired_ifu_stare_create(), xsh_scired_slit_nod(), xsh_scired_slit_nod_create(), xsh_scired_slit_offset(), xsh_scired_slit_offset_create(), xsh_scired_slit_stare(), xsh_scired_slit_stare_create(), xsh_util_afc(), xsh_util_afc_create(), xsh_util_apply_response(), xsh_util_apply_response_create(), xsh_util_bpmap_coadd(), xsh_util_bpmap_coadd_create(), xsh_util_bpmap_nl_raw2pre(), xsh_util_bpmap_nl_raw2pre_create(), xsh_util_compute_response(), xsh_util_compute_response_create(), xsh_util_crh_single(), xsh_util_crh_single_create(), xsh_util_efficiency1d(), xsh_util_efficiency1d_create(), xsh_util_efficiency2d(), xsh_util_efficiency2d_create(), xsh_util_efficiency_create(), xsh_util_guess_xy(), xsh_util_guess_xy_create(), xsh_util_ifu_build_cube(), xsh_util_ifu_build_cube_create(), xsh_util_physmod(), xsh_util_physmod_create(), xsh_wavecal(), xsh_wavecal_create(), and xsh_wavecal_get_parameters().


Function Documentation

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.

Parameters:
list the plugin list
Returns:
0 iff everything is ok

This function is exported.

Definition at line 151 of file xsh_2dmap.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_2dmap_create(), xsh_2dmap_description, xsh_2dmap_description_short, xsh_2dmap_destroy(), xsh_2dmap_exec(), and xsh_get_license().

static void xsh_2dmap ( 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.

Definition at line 474 of file xsh_2dmap.c.

References check, cknull_msg, exptime, instrument, RECIPE_ID, xsh_2dmap_description_short, xsh_add_product_image(), xsh_add_product_table(), xsh_add_temporary_file(), XSH_ARC_LINE_LIST, XSH_ARC_LINE_LIST_INTMON, XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_check_input_is_unbinned(), xsh_check_load_master_bpmap(), xsh_create_dispersol_physmod(), xsh_create_model_map(), xsh_create_poly_wavemap(), xsh_data_check_spectralformat(), xsh_detect_arclines(), xsh_detect_arclines_dan(), XSH_DETECT_ARCLINES_TYPE_MODEL, XSH_DETECT_ARCLINES_TYPE_POLY, xsh_dfs_split_nir(), XSH_DISP_TAB, xsh_end(), xsh_error_reset, xsh_find_frame_with_tag(), xsh_find_order_tab_edges(), xsh_frame_table_resid_merge(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_free_table(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_update_from_spectralformat(), XSH_MASTER_BIAS, XSH_MASTER_DARK, XSH_MOD_CFG_OPT_FMT, XSH_MOD_CFG_TAB, xsh_mode_is_physmod(), xsh_model_pipe_anneal(), xsh_msg, xsh_msg_dbg_low, xsh_msg_error, xsh_msg_warning, xsh_parameters_clipping_detect_arclines_get(), xsh_parameters_detect_arclines_get(), xsh_parameters_dispersol_get(), xsh_parameters_get_int(), xsh_params_set_defaults(), xsh_pfits_get_exptime(), xsh_prepare(), xsh_recipe_params_check(), XSH_SLIT_MAP, XSH_SOLUTION_ABSOLUTE, XSH_SPECTRAL_FORMAT, xsh_stringcat_any(), xsh_subtract_bias(), xsh_subtract_dark(), xsh_subtract_nir_on_off(), xsh_table_merge_clean_and_resid_tabs(), XSH_THEO_TAB_MULT, xsh_verify_2dmap_poly_input(), XSH_WAVE, XSH_WAVE_MAP, xsh_wavecal_qclog_intmon(), xsh_wavemap_qc(), and xsh_wavetab_qc().

Referenced by xsh_2dmap_exec().

static int xsh_2dmap_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 193 of file xsh_2dmap.c.

References assure, check, DECODE_BP_FLAG_DEF, RECIPE_ID, xsh_error_dump, XSH_GAUSSIAN_METHOD, xsh_init(), xsh_parameters_clipping_detect_arclines_create(), xsh_parameters_decode_bp(), xsh_parameters_detect_arclines_create(), xsh_parameters_dispersol_create(), xsh_parameters_generic(), xsh_parameters_new_double(), xsh_parameters_new_int(), and xsh_parameters_pre_overscan().

Referenced by cpl_plugin_get_info().

static int xsh_2dmap_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 337 of file xsh_2dmap.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_2dmap_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 305 of file xsh_2dmap.c.

References assure, xsh_2dmap(), and xsh_error_dump.

Referenced by cpl_plugin_get_info().

static cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_detect_arclines_param arclines_p,
xsh_instrument inst 
) [static]
static cpl_error_code xsh_verify_2dmap_poly_input ( cpl_frame *  order_tab_edges_frame,
cpl_frame *  spectralformat_frame,
cpl_frame *  theo_tab_frame 
) [static]

Definition at line 366 of file xsh_2dmap.c.

References check, xsh_free_table(), and xsh_msg_error.

Referenced by xsh_2dmap().


Variable Documentation

char xsh_2dmap_description[] [static]

Definition at line 102 of file xsh_2dmap.c.

Referenced by cpl_plugin_get_info().

char xsh_2dmap_description_short[] [static]
Initial value:
"Creates a wavelength and spatial resampling solution, a clean arc line list"

Definition at line 99 of file xsh_2dmap.c.

Referenced by cpl_plugin_get_info(), and xsh_2dmap().


Generated on 13 Mar 2013 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1