xsh_util_ifu_build_cube

Macros
#define	RECIPE_ID   "xsh_util_ifu_build_cube"
#define	RECIPE_AUTHOR   "A. Modigliani"
#define	RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Functions
static int	xsh_util_ifu_build_cube_create (cpl_plugin *plugin)
	Setup the recipe options.
static int	xsh_util_ifu_build_cube_exec (cpl_plugin *plugin)
	Interpret the command line options and execute the data processing.
static int	xsh_util_ifu_build_cube_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.
static void	xsh_util_ifu_build_cube (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_util_ifu_build_cube_description_short []
static char	xsh_util_ifu_build_cube_description []

Detailed Description

This recipe ... See man-page for details.

Macro Definition Documentation

RECIPE_AUTHOR

#define RECIPE_AUTHOR   "A. Modigliani"

Definition at line 70 of file xsh_util_ifu_build_cube.c.

RECIPE_CONTACT

#define RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Definition at line 71 of file xsh_util_ifu_build_cube.c.

RECIPE_ID

#define RECIPE_ID   "xsh_util_ifu_build_cube"

Definition at line 69 of file xsh_util_ifu_build_cube.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 124 of file xsh_util_ifu_build_cube.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_util_ifu_build_cube_create(), xsh_util_ifu_build_cube_description, xsh_util_ifu_build_cube_description_short, xsh_util_ifu_build_cube_destroy(), and xsh_util_ifu_build_cube_exec().

xsh_util_ifu_build_cube()

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

Definition at line 292 of file xsh_util_ifu_build_cube.c.

References xsh_instrument::arm, assure, binx, biny, check, instrument, method, xsh_instrument::mode, RECIPE_ID, s, x, xsh_add_product_imagelist(), xsh_add_product_table(), XSH_ARM_NIR, xsh_arm_tostring(), XSH_ARM_UVB, XSH_ARM_VIS, xsh_begin(), xsh_cube_qc_trace_window(), xsh_end(), xsh_find_frame_with_tag(), xsh_find_model_config(), xsh_frame_product(), xsh_free_frame(), xsh_free_frameset(), xsh_free_image(), xsh_free_imagelist(), xsh_free_propertylist(), xsh_free_table(), xsh_free_vector(), XSH_IFU_CFG_TAB, xsh_iml_merge_avg(), xsh_instrument_free(), XSH_MODE_IFU, xsh_model_binxy(), xsh_model_config_load_best(), xsh_model_get_xy(), xsh_msg, xsh_pfits_get_binx(), xsh_pfits_get_biny(), xsh_pfits_set_cdelt1(), xsh_pfits_set_crval1(), XSH_PRE_DATA_TYPE, XSH_PRE_ERRS_TYPE, XSH_PRE_QUAL_TYPE, XSH_RAW_IMA_IFU, xsh_rec_list_create(), xsh_rec_list_free(), xsh_set_recipe_file_prefix(), XSH_SLIT_BIN_SIZE_NARROW_SLIT_NIR, XSH_SLIT_BIN_SIZE_NARROW_SLIT_UVB, XSH_SLIT_BIN_SIZE_NARROW_SLIT_VIS, XSH_SPECTRAL_FORMAT, xsh_util_ifu_build_cube_description_short, XSH_WAVE_BIN_SIZE_NARROW_SLIT_NIR, XSH_WAVE_BIN_SIZE_NARROW_SLIT_UVB, XSH_WAVE_BIN_SIZE_NARROW_SLIT_VIS, and y.

Referenced by xsh_util_ifu_build_cube_exec().

xsh_util_ifu_build_cube_create()

static int xsh_util_ifu_build_cube_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 166 of file xsh_util_ifu_build_cube.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_decode_bp(), and xsh_parameters_generic().

Referenced by cpl_plugin_get_info().

xsh_util_ifu_build_cube_destroy()

static int xsh_util_ifu_build_cube_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 253 of file xsh_util_ifu_build_cube.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

xsh_util_ifu_build_cube_exec()

static int xsh_util_ifu_build_cube_exec ( cpl_plugin *  plugin )

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.

Execute the plugin instance given by the interface

Parameters

plugin

the plugin

Returns

0 if everything is ok

Definition at line 219 of file xsh_util_ifu_build_cube.c.

References assure, xsh_error_dump, xsh_error_reset, and xsh_util_ifu_build_cube().

Referenced by cpl_plugin_get_info().

Variable Documentation

xsh_util_ifu_build_cube_description

char xsh_util_ifu_build_cube_description[]

static

Initial value:

=
"This recipe Produces the spatial geometry of the IFU pattern on the sky\n\
Input Frames : \n\
  - A set of n Science frames ( n == 1 or >=3, \
Tag = OBJECT_IFU_STARE_UVB)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - A master dark frame (Tag = MASTER_DARK_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An order table frame(Tag = ORDER_TABLE_arm)\n\
  - 3 wave solution frames, one per slitlet(Tag = WAVE_SOLUTION_IFU_slitlet_arm)\n\
       where 'slitlet' is DOWN, CEN or UP\n\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)\n\
Products : \n\
  - A Slice Offset Table (similar to a localization table)\n\
        Tag = SLICE_OFFSET_TABLE_arm\n"

Definition at line 94 of file xsh_util_ifu_build_cube.c.

Referenced by cpl_plugin_get_info().

xsh_util_ifu_build_cube_description_short

char xsh_util_ifu_build_cube_description_short[]

static

Initial value:

=
"Produces the spatial geometry of the IFU pattern on the sky"

Definition at line 91 of file xsh_util_ifu_build_cube.c.

Referenced by cpl_plugin_get_info(), and xsh_util_ifu_build_cube().