X-shooter Pipeline Reference Manual 3.8.15
Functions
It runs Molecfit on a generic input spectrum file to compute an atmospheric model.

Functions

int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 
int xsh_molecfit_calctrans_create (cpl_plugin *plugin)
 Setup the recipe options.
 
int xsh_molecfit_calctrans_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
int xsh_molecfit_calctrans_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
cpl_error_code xsh_molecfit_calc_setup_frameset (cpl_frameset *frameset, cpl_parameterlist *list, const char *arm, const char *input_name)
 
cpl_error_code xsh_molecfit_calctrans_config (cpl_frameset *frameset, const cpl_parameterlist *parlist, cpl_parameterlist *ilist, cpl_parameterlist *iframelist)
 Build the list of available plugins, for this module.
 
int xsh_molecfit_calctrans (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 
int xsh_molecfit_model_create (cpl_plugin *plugin)
 Setup the recipe options.
 
int xsh_molecfit_model_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
int xsh_molecfit_model_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
cpl_error_code xsh_molecfit_setup_frameset (cpl_frameset *frameset, cpl_parameterlist *list, const char *arm, const char *input_name)
 
void xsh_molecfit_model_qc (cpl_propertylist *pl, cpl_table *tab)
 
int xsh_molecfit_model (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 Interpret the command line options and execute the data processing.
 
cpl_error_code xsh_molecfit_model_spec_data_calcs (mf_wrap_fits *data, const char *is_idp, cpl_parameterlist *ilist, mf_wrap_model_parameter *parameters)
 
cpl_error_code xsh_molecfit_model_spec_header_calcs (const char *fname, const char *arm, cpl_parameterlist *ilist)
 
cpl_error_code xsh_molecfit_model_config (cpl_frameset *frameset, const cpl_parameterlist *parlist, cpl_parameterlist *ilist, cpl_parameterlist *iframelist)
 
int xsh_molecfit_telluric_create (cpl_plugin *plugin)
 Setup the recipe options.
 
int xsh_molecfit_telluric_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
int xsh_molecfit_telluric_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
int xsh_molecfit_telluric (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 Interpret the command line options and execute the data processing.
 
cpl_error_code xsh_molecfit_telluric_spec_data_calcs (mf_wrap_fits *data, const char *is_idp, cpl_parameterlist *ilist, mf_wrap_model_parameter *parameters)
 
cpl_error_code xsh_molecfit_telluric_spec_header_calcs (const char *fname, const char *arm, cpl_parameterlist *ilist)
 

Detailed Description

Macros Typedefs: Structured types Functions prototypes

Function Documentation

◆ cpl_plugin_get_info()

int cpl_plugin_get_info ( cpl_pluginlist *  list)

Build the list of available plugins, for this module.

Functions code

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 124 of file xsh_molecfit_calctrans.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_molecfit_calctrans_create(), xsh_molecfit_calctrans_description, xsh_molecfit_calctrans_description_short, xsh_molecfit_calctrans_destroy(), and xsh_molecfit_calctrans_exec().

◆ xsh_molecfit_calc_setup_frameset()

cpl_error_code xsh_molecfit_calc_setup_frameset ( cpl_frameset *  frameset,
cpl_parameterlist *  list,
const char *  arm,
const char *  input_name 
)

Definition at line 292 of file xsh_molecfit_calctrans.c.

Referenced by xsh_molecfit_calctrans().

◆ xsh_molecfit_calctrans()

int xsh_molecfit_calctrans ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist 
)

Global variables Macros Typedefs: Structured types Functions prototypes

Definition at line 538 of file xsh_molecfit_calctrans.c.

References xsh_molecfit_calc_setup_frameset(), and xsh_molecfit_calctrans_config().

Referenced by xsh_molecfit_calctrans_exec().

◆ xsh_molecfit_calctrans_config()

cpl_error_code xsh_molecfit_calctrans_config ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
cpl_parameterlist *  ilist,
cpl_parameterlist *  iframelist 
)

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.

UVB - if we are using the UVB arm, just assume defaults for now.

Definition at line 378 of file xsh_molecfit_calctrans.c.

References xsh_molecfit_utils_find_input_frame().

Referenced by xsh_molecfit_calctrans().

◆ xsh_molecfit_calctrans_create()

int xsh_molecfit_calctrans_create ( cpl_plugin *  plugin)

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 166 of file xsh_molecfit_calctrans.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), and xsh_parameters_new_boolean().

Referenced by cpl_plugin_get_info().

◆ xsh_molecfit_calctrans_destroy()

int xsh_molecfit_calctrans_destroy ( cpl_plugin *  plugin)

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

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 265 of file xsh_molecfit_calctrans.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_molecfit_calctrans_exec()

int xsh_molecfit_calctrans_exec ( cpl_plugin *  plugin)

Execute the plugin instance given by the interface.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 233 of file xsh_molecfit_calctrans.c.

References assure, xsh_error_dump, and xsh_molecfit_calctrans().

Referenced by cpl_plugin_get_info().

◆ xsh_molecfit_model()

int xsh_molecfit_model ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist 
)

Interpret the command line options and execute the data processing.

Parameters
framesetthe frames list
parlistthe parameters list
Returns
CPL_ERROR_NONE if everything is OK or CPL_ERROR_CODE in other case

Definition at line 629 of file xsh_molecfit_model.c.

References MODEL_RECIPE_ID, xsh_molecfit_model_check_extensions_and_ranges(), xsh_molecfit_model_config(), xsh_molecfit_model_qc(), xsh_molecfit_model_spec_data_calcs(), and xsh_molecfit_setup_frameset().

Referenced by xsh_molecfit_model_exec().

◆ xsh_molecfit_model_config()

cpl_error_code xsh_molecfit_model_config ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
cpl_parameterlist *  ilist,
cpl_parameterlist *  iframelist 
)

Global variables Macros Typedefs: Structured types Functions prototypes

UVB - if we are using the UVB arm, just assume defaults for now.

Definition at line 1284 of file xsh_molecfit_model.c.

References xsh_molecfit_model_spec_header_calcs(), and xsh_molecfit_utils_find_input_frame().

Referenced by xsh_molecfit_model().

◆ xsh_molecfit_model_create()

int xsh_molecfit_model_create ( cpl_plugin *  plugin)

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 165 of file xsh_molecfit_model.c.

References assure, check, MODEL_RECIPE_ID, xsh_error_dump, xsh_init(), XSH_MF_LNFL_LINE_DB_DESC, XSH_MF_PARAMETERS_COLUMN_DFLUX_DESC, XSH_MF_PARAMETERS_COLUMN_FLUX_DESC, XSH_MF_PARAMETERS_COLUMN_LAMBDA_DESC, XSH_MF_PARAMETERS_CONTINUUM_N_DESC, XSH_MF_PARAMETERS_DEFAULT_ERROR_DESC, XSH_MF_PARAMETERS_FIT_CONTINUUM_DESC, XSH_MF_PARAMETERS_FIT_GAUSS_DESC, XSH_MF_PARAMETERS_FIT_LORENTZ_DESC, XSH_MF_PARAMETERS_FIT_RES_BOX_DESC, XSH_MF_PARAMETERS_FIT_TELESCOPE_BACK_DESC, XSH_MF_PARAMETERS_FIT_WLC_DESC, XSH_MF_PARAMETERS_FTOL_DESC, XSH_MF_PARAMETERS_KERN_FAC_DESC, XSH_MF_PARAMETERS_KERN_MODE_DESC, XSH_MF_PARAMETERS_PWV_DESC, XSH_MF_PARAMETERS_RES_BOX_DESC, XSH_MF_PARAMETERS_RES_GAUSS_DESC, XSH_MF_PARAMETERS_RES_LORENTZ_DESC, XSH_MF_PARAMETERS_TELESCOPE_BACK_CONST_DESC, XSH_MF_PARAMETERS_VAR_KERN_DESC, XSH_MF_PARAMETERS_WLC_CONST_DESC, XSH_MF_PARAMETERS_WLC_N_DESC, XSH_MF_PARAMETERS_XTOL_DESC, XSH_MOLECFIT_PARAMETER_FIT_DESC, XSH_MOLECFIT_PARAMETER_LIST_DESC, XSH_MOLECFIT_PARAMETER_PIXEL_RANGE_EXCLUDE_DESC, XSH_MOLECFIT_PARAMETER_RELATIVE_VALUE_DESC, XSH_MOLECFIT_PARAMETER_USE_INPUT_KERNEL_DESC, XSH_MOLECFIT_PARAMETER_WAVE_RANGE_EXCLUDE_DESC, XSH_MOLECFIT_PARAMETER_WAVE_RANGE_INCLUDE_DESC, xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_new_int(), and xsh_parameters_new_string().

◆ xsh_molecfit_model_destroy()

int xsh_molecfit_model_destroy ( cpl_plugin *  plugin)

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

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 447 of file xsh_molecfit_model.c.

References assure, and xsh_free_parameterlist().

◆ xsh_molecfit_model_exec()

int xsh_molecfit_model_exec ( cpl_plugin *  plugin)

Execute the plugin instance given by the interface.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 415 of file xsh_molecfit_model.c.

References assure, xsh_error_dump, and xsh_molecfit_model().

◆ xsh_molecfit_model_qc()

void xsh_molecfit_model_qc ( cpl_propertylist *  pl,
cpl_table *  tab 
)

Definition at line 548 of file xsh_molecfit_model.c.

References xsh_string_toupper().

Referenced by xsh_molecfit_model().

◆ xsh_molecfit_model_spec_data_calcs()

cpl_error_code xsh_molecfit_model_spec_data_calcs ( mf_wrap_fits *  data,
const char *  is_idp,
cpl_parameterlist *  ilist,
mf_wrap_model_parameter *  parameters 
)

Definition at line 1089 of file xsh_molecfit_model.c.

Referenced by xsh_molecfit_model().

◆ xsh_molecfit_model_spec_header_calcs()

cpl_error_code xsh_molecfit_model_spec_header_calcs ( const char *  fname,
const char *  arm,
cpl_parameterlist *  ilist 
)

Definition at line 1143 of file xsh_molecfit_model.c.

Referenced by xsh_molecfit_model_config().

◆ xsh_molecfit_setup_frameset()

cpl_error_code xsh_molecfit_setup_frameset ( cpl_frameset *  frameset,
cpl_parameterlist *  list,
const char *  arm,
const char *  input_name 
)

Definition at line 473 of file xsh_molecfit_model.c.

Referenced by xsh_molecfit_model().

◆ xsh_molecfit_telluric()

int xsh_molecfit_telluric ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist 
)

Interpret the command line options and execute the data processing.

Parameters
framesetthe frames list
parlistthe parameters list
Returns
CPL_ERROR_NONE if everything is OK or CPL_ERROR_CODE in other case

Definition at line 398 of file xsh_molecfit_telluric.c.

References method, and xsh_molecfit_utils_find_input_frame().

Referenced by xsh_molecfit_telluric_exec().

◆ xsh_molecfit_telluric_create()

int xsh_molecfit_telluric_create ( cpl_plugin *  plugin)

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 165 of file xsh_molecfit_telluric.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_new_double(), xsh_parameters_new_int(), and xsh_parameters_new_string().

◆ xsh_molecfit_telluric_destroy()

int xsh_molecfit_telluric_destroy ( cpl_plugin *  plugin)

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

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 284 of file xsh_molecfit_telluric.c.

References assure, and xsh_free_parameterlist().

◆ xsh_molecfit_telluric_exec()

int xsh_molecfit_telluric_exec ( cpl_plugin *  plugin)

Execute the plugin instance given by the interface.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 252 of file xsh_molecfit_telluric.c.

References assure, xsh_error_dump, and xsh_molecfit_telluric().

◆ xsh_molecfit_telluric_spec_data_calcs()

cpl_error_code xsh_molecfit_telluric_spec_data_calcs ( mf_wrap_fits *  data,
const char *  is_idp,
cpl_parameterlist *  ilist,
mf_wrap_model_parameter *  parameters 
)

Definition at line 485 of file xsh_molecfit_telluric.c.

◆ xsh_molecfit_telluric_spec_header_calcs()

cpl_error_code xsh_molecfit_telluric_spec_header_calcs ( const char *  fname,
const char *  arm,
cpl_parameterlist *  ilist 
)

Definition at line 539 of file xsh_molecfit_telluric.c.

Generated by doxygen 1.9.6