xsh_orderpos

Macros
#define	RECIPE_ID   "xsh_orderpos"
#define	RECIPE_AUTHOR   "L.Guglielmi,R.Haigron,P.Goldoni,F.Royer, A. Modigliani"
#define	RECIPE_CONTACT   "amodigli@eso.org"

Functions
static int	xsh_orderpos_create (cpl_plugin *plugin)
	Setup the recipe options.
static int	xsh_orderpos_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.
static int	xsh_orderpos_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.
static void	xsh_orderpos (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.

Variables
static char	xsh_orderpos_description_short []
static char	xsh_orderpos_description []

Detailed Description

This recipe calculates the position of the orders from a flat illumination See man-page for details.

Macro Definition Documentation

RECIPE_AUTHOR

#define RECIPE_AUTHOR   "L.Guglielmi,R.Haigron,P.Goldoni,F.Royer, A. Modigliani"

Definition at line 69 of file xsh_orderpos.c.

RECIPE_CONTACT

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 70 of file xsh_orderpos.c.

RECIPE_ID

#define RECIPE_ID   "xsh_orderpos"

Definition at line 68 of file xsh_orderpos.c.

Function Documentation

cpl_plugin_get_info()

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.

Definition at line 131 of file xsh_orderpos.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_orderpos_create(), xsh_orderpos_description, xsh_orderpos_description_short, xsh_orderpos_destroy(), and xsh_orderpos_exec().

xsh_orderpos()

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

< The frame where to find orders

< Do NOT deallocated this pointer !

< Do NOT deallocated this pointer !

Definition at line 297 of file xsh_orderpos.c.

References check, check_msg, xsh_detect_continuum_param::fit_window, instrument, xsh_detect_continuum_param::poly_degree, xsh_detect_continuum_param::poly_step, RECIPE_ID, xsh_detect_continuum_param::running_window, xsh_detect_continuum_param::search_window, xsh_add_product_image(), xsh_add_product_table(), XSH_ARM_NIR, xsh_begin(), xsh_check_input_is_unbinned(), xsh_check_load_master_bpmap(), xsh_detect_continuum(), xsh_end(), xsh_error_reset, xsh_find_frame_with_tag(), xsh_find_raw_orderdef_nir(), xsh_find_raw_orderdef_nir_off(), xsh_find_raw_orderdef_vis_uvb(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_update_from_spectralformat(), xsh_instrument_update_lamp(), XSH_LAMP_UNDEFINED, XSH_MASTER_BIAS, XSH_MASTER_DARK, xsh_monitor_flux(), xsh_msg, xsh_msg_dbg_low, xsh_msg_error, xsh_msg_warning, XSH_ORDER_TAB_GUESS, XSH_ORDERDEF, xsh_orderpos_description_short, xsh_parameters_clipping_dcn_get(), xsh_parameters_detect_continuum_get(), xsh_parameters_get_int(), xsh_pre_frame_subtract(), xsh_prepare(), XSH_QC_FLUX, xsh_recipe_params_check(), XSH_SPECTRAL_FORMAT, xsh_subtract_bias(), and xsh_subtract_dark().

Referenced by xsh_orderpos_exec().

xsh_orderpos_create()

static int xsh_orderpos_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 173 of file xsh_orderpos.c.

References assure, check, DETECT_CONTINUUM_POLYNOMIAL_DEGREE, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_clipping_dcn_create(), xsh_parameters_decode_bp(), xsh_parameters_detect_continuum_create(), xsh_parameters_generic(), and xsh_parameters_pre_overscan().

Referenced by cpl_plugin_get_info().

xsh_orderpos_destroy()

static int xsh_orderpos_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 262 of file xsh_orderpos.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

xsh_orderpos_exec()

static int xsh_orderpos_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 227 of file xsh_orderpos.c.

References assure, xsh_error_dump, and xsh_orderpos().

Referenced by cpl_plugin_get_info().

Variable Documentation

xsh_orderpos_description

char xsh_orderpos_description[]

static

Initial value:

=
"This recipe creates the orders centre traces table.\n\
Input Frames for UVB and VIS:\n\
  Raw file (Tag = ORDERDEF_arm_D2)\n\
  Master Dark (Tag = MASTER_DARK_arm)\n\
  Master Bias (Tag = MASTER_BIAS_arm)\n\
Input Frames for NIR:\n\
  Raw file ON(Tag = ORDERDEF_NIR_ON)\n\
  Raw file OFF(Tag = ORDERDEF_NIR_OFF)\n\
Input Frames for all arms\n\
  Guess order table (Tag = ORDER_TAB_GUESS_arm)\n\
  Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm)\n\
  - [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm)\n\
Prepare PRE structures.\n\
For NIR, subtract NIR-OFF from NIR-ON.\n\
For UVB and NIR, Substract the master Bias and master dark.\n\
Detect Orders and calculate the order table.\n\
The final products are:\n\
   An updated Order Table, PRO.CATG=ORDER_TABLE_CENTR_arm.\n\
   A order trace residuals Table, PRO.CATG=ORDERPOS_RESID_TAB_arm.\n\
   The order pos frame bias subtracted, PRO.CATG=ORDERDEF_ON_arm.\n"

Definition at line 93 of file xsh_orderpos.c.

Referenced by cpl_plugin_get_info().

xsh_orderpos_description_short

char xsh_orderpos_description_short[]

static

Initial value:

=
"Create the orders centre traces table file"

Definition at line 90 of file xsh_orderpos.c.

Referenced by cpl_plugin_get_info(), and xsh_orderpos().