X-shooter Pipeline Reference Manual 3.8.15
Functions
Remove CRH single

Functions

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

 
static int xsh_util_crh_single_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int xsh_util_crh_single_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int xsh_util_crh_single (cpl_parameterlist *parameters, cpl_frameset *frameset)
 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 110 of file xsh_util_crh_single.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_util_crh_single_create(), xsh_util_crh_single_description, xsh_util_crh_single_description_short, xsh_util_crh_single_destroy(), and xsh_util_crh_single_exec().

◆ xsh_util_crh_single()

static int xsh_util_crh_single ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
)
static

Get the command line options and execute the data reduction.

Parameters
parametersthe parameters list
framesetthe frames list
Returns
0 if everything is ok

Definition at line 242 of file xsh_util_crh_single.c.

References check, instrument, RECIPE_ID, xsh_add_product_image(), xsh_begin(), xsh_frame_product(), xsh_free_frame(), XSH_GET_TAG_FROM_ARM, XSH_IMA, xsh_instrument_arm_tostring(), xsh_msg, xsh_msg_error, xsh_parameters_remove_crh_single_get(), xsh_remove_crh_single(), and xsh_util_crh_single_description_short.

Referenced by xsh_util_crh_single_exec().

◆ xsh_util_crh_single_create()

static int xsh_util_crh_single_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 144 of file xsh_util_crh_single.c.

References check, RECIPE_ID, xsh_init(), xsh_parameters_decode_bp(), xsh_parameters_generic(), and xsh_parameters_remove_crh_single_create().

Referenced by cpl_plugin_get_info().

◆ xsh_util_crh_single_destroy()

static int xsh_util_crh_single_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 218 of file xsh_util_crh_single.c.

Referenced by cpl_plugin_get_info().

◆ xsh_util_crh_single_exec()

static int xsh_util_crh_single_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 187 of file xsh_util_crh_single.c.

References xsh_util_crh_single().

Referenced by cpl_plugin_get_info().