X-shooter Pipeline Reference Manual 3.8.15
Functions
Image Shift Along X or Y

Functions

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

 
static int xsh_util_ima_shift_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int xsh_util_ima_shift_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int xsh_util_ima_shift (cpl_parameterlist *parlist, cpl_frameset *framelist)
 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 105 of file xsh_util_ima_shift.c.

References xsh_get_license(), xsh_util_ima_shift_create(), xsh_util_ima_shift_description, xsh_util_ima_shift_description_short, xsh_util_ima_shift_destroy(), xsh_util_ima_shift_exec(), XSH_UTL_IMA_SHIFT_RECIPE_AUTHOR, XSH_UTL_IMA_SHIFT_RECIPE_CONTACT, and XSH_UTL_IMA_SHIFT_RECIPE_ID.

◆ xsh_util_ima_shift()

static int xsh_util_ima_shift ( cpl_parameterlist *  parlist,
cpl_frameset *  framelist 
)
static

Get the command line options and execute the data reduction.

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

Definition at line 243 of file xsh_util_ima_shift.c.

References check, check_msg, n, xsh_frameset_extract(), xsh_free_frameset(), xsh_free_image(), xsh_free_propertylist(), XSH_IMA, xsh_msg, and xsh_msg_error.

Referenced by xsh_util_ima_shift_exec().

◆ xsh_util_ima_shift_create()

static int xsh_util_ima_shift_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 139 of file xsh_util_ima_shift.c.

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

Referenced by cpl_plugin_get_info().

◆ xsh_util_ima_shift_destroy()

static int xsh_util_ima_shift_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 221 of file xsh_util_ima_shift.c.

Referenced by cpl_plugin_get_info().

◆ xsh_util_ima_shift_exec()

static int xsh_util_ima_shift_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 190 of file xsh_util_ima_shift.c.

References xsh_util_ima_shift().

Referenced by cpl_plugin_get_info().