X-shooter Pipeline Reference Manual 3.8.15
Functions

Functions

int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 
static int xsh_util_integrate_create (cpl_plugin *plugin)
 Setup the recipe options

 
static int xsh_util_integrate_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int xsh_util_integrate_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int xsh_util_integrate (cpl_parameterlist *parlist, cpl_frameset *frames)
 Get the command line options and execute the data reduction.
 

Detailed Description

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

This function is exported.

Definition at line 98 of file xsh_util_integrate.c.

References xsh_get_license(), xsh_util_integrate_create(), xsh_util_integrate_description, xsh_util_integrate_description_short, xsh_util_integrate_destroy(), xsh_util_integrate_exec(), XSH_UTL_INTEGRATE_RECIPE_AUTHOR, XSH_UTL_INTEGRATE_RECIPE_CONTACT, and XSH_UTL_INTEGRATE_RECIPE_ID.

◆ xsh_util_integrate()

static int xsh_util_integrate ( cpl_parameterlist *  parlist,
cpl_frameset *  frames 
)
static

Get the command line options and execute the data reduction.

Parameters
parlistthe parameters list
framesthe frames list
Returns
0 if everything is ok

Definition at line 229 of file xsh_util_integrate.c.

References check, exptime, instrument, XSH_ATMOS_EXT, xsh_begin(), xsh_compute_response(), xsh_find_frame_with_tag(), XSH_FLUX_STD_CAT, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_instrument_free(), xsh_msg, xsh_pfits_get_exptime(), XSH_RAW_IMA_SLIT, xsh_util_integrate_description_short, and XSH_UTL_INTEGRATE_RECIPE_ID.

Referenced by xsh_util_integrate_exec().

◆ xsh_util_integrate_create()

static int xsh_util_integrate_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 132 of file xsh_util_integrate.c.

References check, xsh_init(), xsh_parameters_decode_bp(), xsh_parameters_generic(), and XSH_UTL_INTEGRATE_RECIPE_ID.

Referenced by cpl_plugin_get_info().

◆ xsh_util_integrate_destroy()

static int xsh_util_integrate_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 207 of file xsh_util_integrate.c.

Referenced by cpl_plugin_get_info().

◆ xsh_util_integrate_exec()

static int xsh_util_integrate_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 176 of file xsh_util_integrate.c.

References xsh_util_integrate().

Referenced by cpl_plugin_get_info().