xsh_respon_slit_nod
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_respon_slit_nod"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#define RECIPE_CONTACT   "amodigli@eso.org"
#define RECIPE_ID   "xsh_scired_slit_nod"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#define RECIPE_CONTACT   "amodigli@eso.org"

Functions

static int xsh_respon_slit_nod_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_respon_slit_nod_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_respon_slit_nod_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static cpl_error_code xsh_respon_slit_nod (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 void xsh_get_binning (cpl_frameset *raws, int *binx, int *biny)
 set binning
static int xsh_scired_slit_nod_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_scired_slit_nod_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_scired_slit_nod_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_scired_slit_nod (cpl_parameterlist *parameters, cpl_frameset *frameset)
 Interpret the command line options and execute the data processing.
static cpl_error_code xsh_params_bin_scale (int binx, int biny)
 Corrects input parameters for binning.

Variables

static char xsh_respon_slit_nod_description_short []
static char xsh_respon_slit_nod_description []
static char xsh_scired_slit_nod_description_short []
static char xsh_scired_slit_nod_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 74 of file xsh_scired_slit_nod.c.

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

Definition at line 77 of file xsh_respon_slit_nod.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 75 of file xsh_scired_slit_nod.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 78 of file xsh_respon_slit_nod.c.

#define RECIPE_ID   "xsh_scired_slit_nod"

Definition at line 73 of file xsh_scired_slit_nod.c.

#define RECIPE_ID   "xsh_respon_slit_nod"

Definition at line 76 of file xsh_respon_slit_nod.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 136 of file xsh_scired_slit_nod.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_scired_slit_nod_create(), xsh_scired_slit_nod_description, xsh_scired_slit_nod_description_short, xsh_scired_slit_nod_destroy(), and xsh_scired_slit_nod_exec().

static void xsh_get_binning ( cpl_frameset *  raws,
int *  binx,
int *  biny 
) [static]

set binning

Parameters:
raws input raw frames
binx x binning
biny y binning

Definition at line 387 of file xsh_scired_slit_nod.c.

References check, XSH_ASSURE_NOT_ILLEGAL_MSG, XSH_ASSURE_NOT_NULL_MSG, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_respon_slit_nod(), and xsh_scired_slit_nod().

static cpl_error_code xsh_params_bin_scale ( int  binx,
int  biny 
) [static]

Corrects input parameters for binning.

Parameters:
binx x bin
biny y bin

In case of failure the cpl_error_code is set.

Definition at line 423 of file xsh_scired_slit_nod.c.

static cpl_error_code xsh_respon_slit_nod ( 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.

< Final (result) frame

< Final (result) frame

< Final (result) frame

< Final (result) frame

< normalized (T,gain,atm-ext) 1D frame

< normalized (T,gain,atm-ext) 2D frame

Definition at line 417 of file xsh_respon_slit_nod.c.

References assure, check, exptime, instrument, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, xsh_extract_param::method, xsh_localize_obj_param::method, xsh_instrument::mode, RECIPE_ID, xsh_combine_nod_param::throwname, xsh_localize_obj_param::use_skymask, xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_spectrum(), xsh_add_product_table(), xsh_add_product_table_multi(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, XSH_ATMOS_EXT, xsh_begin(), xsh_combine_nod(), xsh_compute_response(), xsh_compute_response_ord(), xsh_efficiency_compute(), xsh_end(), xsh_ensure_raws_number_is_even(), xsh_error_msg, xsh_extract(), xsh_find_frame_with_tag(), xsh_flux_calibrate(), XSH_FLUX_STD_CAT, xsh_frame_table_monitor_flux_qc(), xsh_frameset_dump_nod_info(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_get_binning(), xsh_get_noffsets(), xsh_get_offsets(), XSH_GET_TAG_FROM_ARM, XSH_HIGH_ABS_WIN, xsh_instrument_free(), xsh_instrument_get_arm(), xsh_localize_obj(), xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_msg_dbg_medium, xsh_msg_error, xsh_nod_group_by_reloff(), xsh_nod_prepare_set(), XSH_OBJECT_SLIT_NOD, XSH_ORDER2D, xsh_order_frameset_by_date(), xsh_parameters_clipping_crh_get(), xsh_parameters_get_boolean(), xsh_pfits_get_exptime(), xsh_prepare(), xsh_respon_slit_nod_description_short, xsh_scired_nod_get_parameters(), xsh_scired_slit_nod_accurate(), xsh_scired_slit_nod_fast(), xsh_scired_slit_nod_get_calibs(), xsh_set_recipe_file_prefix(), XSH_STD_FLUX_SLIT_NOD, XSH_STD_TELL_SLIT_NOD, and xsh_subtract_sky_nod().

Referenced by xsh_respon_slit_nod_exec().

static int xsh_respon_slit_nod_create ( cpl_plugin *  plugin  )  [static]
static int xsh_respon_slit_nod_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 339 of file xsh_respon_slit_nod.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

static int xsh_respon_slit_nod_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 305 of file xsh_respon_slit_nod.c.

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

static void xsh_scired_slit_nod ( 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 491 of file xsh_scired_slit_nod.c.

References assure, binx, biny, check, instrument, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, xsh_extract_param::method, xsh_localize_obj_param::method, xsh_instrument::mode, RECIPE_ID, xsh_combine_nod_param::throwname, xsh_localize_obj_param::use_skymask, xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_spectrum(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_combine_nod(), xsh_end(), xsh_ensure_raws_number_is_even(), xsh_error_msg, xsh_extract(), xsh_flux_calibrate(), xsh_frameset_dump_nod_info(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_get_binning(), xsh_get_noffsets(), xsh_get_offsets(), XSH_GET_TAG_FROM_ARM, xsh_instrument_free(), xsh_instrument_get_arm(), xsh_localize_obj(), xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_nod_group_by_reloff(), xsh_nod_prepare_set(), XSH_OBJECT_SLIT_NOD, XSH_ORDER2D, xsh_order_frameset_by_date(), xsh_parameters_clipping_crh_get(), xsh_parameters_get_boolean(), xsh_prepare(), xsh_scired_nod_get_parameters(), xsh_scired_slit_nod_accurate(), xsh_scired_slit_nod_description_short, xsh_scired_slit_nod_fast(), xsh_scired_slit_nod_get_calibs(), xsh_set_recipe_file_prefix(), XSH_STD_FLUX_SLIT_NOD, XSH_STD_TELL_SLIT_NOD, and xsh_subtract_sky_nod().

Referenced by xsh_scired_slit_nod_exec().

static int xsh_scired_slit_nod_create ( cpl_plugin *  plugin  )  [static]
static int xsh_scired_slit_nod_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 336 of file xsh_scired_slit_nod.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_scired_slit_nod_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 302 of file xsh_scired_slit_nod.c.

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

Referenced by cpl_plugin_get_info().


Variable Documentation

Initial value:
"This recipe reduces science exposure in SLIT configuration and NOD mode\n\
Input Frames : \n\
  - A set of n Science frames ( n even ), \
Tag = OBJECT_SLIT_NOD_arm\n\
  - Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_SLIT_arm)\n\
  - An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm)\n\
  - [poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm)\n\
  - [poly mode] A wave map frame(Tag = WAVE_MAP_arm)\n\
  - [poly mode] A disp table frame(Tag = DISP_TAB_arm)\n\
  - [physical model mode]A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = MASTER_BP_MAP_arm)\n\
  - [OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm)\n\
Products : \n\
  - [If STD is in catal] The response function (Tag = PREFIX_RESPONSE_ORDER1D_SLIT_arm)\n\
  - [If STD is in catal] The response function (Tag = PREFIX_RESPONSE_MERGE1D_SLIT_arm)\n\
  - PREFIX_ORDER2D_arm (2 dimension)\n\
  - PREFIX_ORDER1D_arm (1 dimension)\n\
  - PREFIX_MERGE2D_arm (2 dimension)\n\
  - PREFIX_MERGE1D_arm (1 dimension)\n\
  - [If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUXCAL2D_arm)\n\
  - [If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUXCAL1D_arm)\n\
  - [If STD is in catal] The efficiency (Tag = EFFICIENCY_SLIT_arm)\n\
  - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC"

Definition at line 101 of file xsh_respon_slit_nod.c.

Initial value:
"Reduce STD star frames in SLIT configuration and nod mode"

Definition at line 98 of file xsh_respon_slit_nod.c.

Referenced by xsh_respon_slit_nod().

Initial value:
"This recipe reduces science exposure in SLIT configuration and NOD mode\n\
Input Frames : \n\
  - A set of n Science frames ( n even ), \
Tag = OBJECT_SLIT_NOD_arm\n\
  - Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_SLIT_arm)\n\
  - An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm)\n\
  - [poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm)\n\
  - [poly mode] A wave map frame(Tag = WAVE_MAP_arm)\n\
  - [poly mode] A disp table frame(Tag = DISP_TAB_arm)\n\
  - [physical model mode]A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = MASTER_BP_MAP_arm)\n\
  - [OPTIONAL] The instrument response table (Tag = RESPONSE_MERGE1D_SLIT_arm)\n\
  - [OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm)\n\
Products : \n\
  - PREFIX_ORDER2D_arm (2 dimension)\n\
  - PREFIX_ORDER1D_arm (1 dimension)\n\
  - PREFIX_MERGE2D_arm (2 dimension)\n\
  - PREFIX_MERGE1D_arm (1 dimension)\n\
  - [OPTIONAL, if response and atm ext are provided]  PREFIX_FLUXCAL2D_arm (2 dimension)\n\
  - [OPTIONAL, if response and atm ext are provided]  PREFIX_FLUXCAL1D_arm (1 dimension)\n\
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC"

Definition at line 98 of file xsh_scired_slit_nod.c.

Referenced by cpl_plugin_get_info().

Initial value:
"Reduce science frames in SLIT configuration and nod mode"

Definition at line 95 of file xsh_scired_slit_nod.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_slit_nod().


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