xsh_geom_ifu
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_geom_ifu"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#define RECIPE_CONTACT   "laurent.guglielmi@apc.univ-paris7.fr"

Functions

static int xsh_geom_ifu_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_geom_ifu_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_geom_ifu_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_geom_ifu (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.
static cpl_error_code xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg)
 Scales input parameters for binning.
static cpl_error_code xsh_params_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par)
static cpl_error_code xsh_params_set_defaults (cpl_parameterlist *pars, xsh_instrument *inst, xsh_rectify_param *rectify_par)

Variables

static char xsh_geom_ifu_description_short []
static char xsh_geom_ifu_description []

Detailed Description

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


Define Documentation

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

Definition at line 70 of file xsh_geom_ifu.c.

#define RECIPE_CONTACT   "laurent.guglielmi@apc.univ-paris7.fr"

Definition at line 71 of file xsh_geom_ifu.c.

#define RECIPE_ID   "xsh_geom_ifu"

Definition at line 69 of file xsh_geom_ifu.c.


Function Documentation

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_geom_ifu.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_geom_ifu_create(), xsh_geom_ifu_description, xsh_geom_ifu_description_short, xsh_geom_ifu_destroy(), xsh_geom_ifu_exec(), and xsh_get_license().

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

< Output of remove_crh

< Output of subtract bias

< Output of subtract dark

< Output of subtract background

< Output of xsh_divide_flat

< Output of xsh_rectify_ifu

< Output of xsh_localize_object

< Output of remove_crh_single

Definition at line 492 of file xsh_geom_ifu.c.

References assure, check, check_msg, instrument, xsh_spectralformat::lambda_max, xsh_spectralformat::lambda_min, xsh_spectralformat_list::list, xsh_localize_obj_param::loc_chunk_nb, xsh_localize_obj_param::loc_deg_poly, xsh_instrument::mode, xsh_localize_obj_param::niter, RECIPE_ID, xsh_spectralformat_list::size, size, xsh_add_product_table(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_compute_slice_dist(), xsh_create_map(), xsh_create_model_map(), xsh_dfs_split_nir(), xsh_divide_flat(), xsh_end(), xsh_error_reset, xsh_find_disp_tab(), xsh_find_master_bias(), xsh_find_master_bpmap(), xsh_find_master_dark(), xsh_find_master_flat(), xsh_find_model_config(), xsh_find_order_tab_edges(), xsh_find_slitmap(), xsh_find_spectral_format(), xsh_find_wave_tab_ifu(), xsh_find_wavemap(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_geom_ifu_description_short, XSH_GET_TAG_FROM_ARM, xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_localize_obj_ifu(), XSH_MASTER_DARK, XSH_MOD_CFG_TAB, XSH_MODE_IFU, xsh_model_temperature_update_frame(), xsh_msg, xsh_msg_error, xsh_msg_warning, XSH_OBJECT_IFU_STARE, xsh_order_list_load(), xsh_parameters_background_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_get_boolean(), xsh_parameters_get_double(), xsh_parameters_localize_obj_get(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_prepare(), xsh_rectify_ifu(), xsh_rectify_orders_ifu(), xsh_remove_crh_multiple(), xsh_set_recipe_file_prefix(), XSH_SLIT_MAP_MODEL, XSH_SLIT_STARE_REMOVE_CRH, xsh_spectralformat_list_get_orders(), xsh_spectralformat_list_load(), XSH_SPECTRALFORMAT_TABLE_COLNAME_ORDER, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAX, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMIN, xsh_subtract_background(), xsh_subtract_bias(), xsh_subtract_dark(), XSH_TABLE_LOAD, XSH_TRACE, XSH_WAVE_MAP_MODEL, and XSH_WAVE_TAB_2D.

Referenced by xsh_geom_ifu_exec().

static int xsh_geom_ifu_create ( cpl_plugin *  plugin  )  [static]
static int xsh_geom_ifu_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 381 of file xsh_geom_ifu.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_geom_ifu_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 347 of file xsh_geom_ifu.c.

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

Referenced by cpl_plugin_get_info().

static cpl_error_code xsh_params_bin_scale ( cpl_frameset *  raws,
xsh_background_param backg 
) [static]

Scales input parameters for binning.

Parameters:
raws the frames list
backg the structure controlling inter-order background computation

In case of failure the cpl_error_code is set.

Definition at line 256 of file xsh_geom_ifu.c.

References binx, biny, check, xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_geom_ifu(), xsh_scired_ifu_offset(), and xsh_scired_ifu_stare().

static cpl_error_code xsh_params_monitor ( xsh_background_param backg,
xsh_rectify_param rectify_par,
xsh_localize_obj_param loc_obj_par 
) [static]
static cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_instrument inst,
xsh_rectify_param rectify_par 
) [static]

Variable Documentation

char xsh_geom_ifu_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_geom_ifu.c.

Referenced by cpl_plugin_get_info().

Initial value:
"Produces the spatial geometry of the IFU pattern on the sky"

Definition at line 91 of file xsh_geom_ifu.c.

Referenced by cpl_plugin_get_info(), and xsh_geom_ifu().


Generated on 9 Mar 2011 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1