The xsh_scired_ifu_offset_drl recipe

xsh_scired_ifu_offset_drl

Synopsis

Reduce science exposure in IFU configuration and on/off mode

Description

This recipe reduces science exposure in IFU configuration and on/off mode Input Frames :

  • A set of 2xn Science frames, Tag = OBJECT_IFU_OFFSET_arm, SKY_IFU_arm

  • A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)

  • A master flat frame (Tag = MASTER_FLAT_IFU_arm)

  • An order table frame(Tag = ORDER_TABLE_EDGES_IFU_arm)

  • 3 wave solution frames, one per slitlet (Tag = WAVE_TAB_ARC_IFU_slitlet_arm)

    where ‘slitlet’ is DOWN, CEN or UP

  • [OPTIONAL] A dispersion table (Tag = DISP_TAB_IFU_arm)

  • [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)

Products :

  • 3 Spectrum order tables 2D (1 per slitlet), PRO.CATG=ORDER2D_slitlet_IFU_arm

  • 3 Spectrum order tables 1D (1 per slitlet), PRO.CATG=ORDER1D_slitlet_IFU_arm

  • 3 Spectrum merge tables 2D (1 per slitlet), PRO.CATG=MERGE2D_slitlet_IFU_arm

  • 3 Spectrum merge tables 1D (1 per slitlet), PRO.CATG=MERGE1D_slitlet_IFU_arm

  • 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_arm

Constructor

cpl.Recipe("xsh_scired_ifu_offset_drl")

Create an object for the recipe xsh_scired_ifu_offset_drl.

import cpl
xsh_scired_ifu_offset_drl = cpl.Recipe("xsh_scired_ifu_offset_drl")

Parameters

xsh_scired_ifu_offset_drl.param.keep_temp

If ‘no’, temporary files are deleted. (str; default: ‘no’) [default=”no”].

xsh_scired_ifu_offset_drl.param.debug_level

Additional xshooter debug level. One of ‘none’, ‘low’, ‘medium’, ‘high’ (str; default: ‘none’) [default=”none”].

xsh_scired_ifu_offset_drl.param.time_stamp

Add timestamp to product file name. (bool; default: False) [default=False].

xsh_scired_ifu_offset_drl.param.decode_bp

Integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. Most frequent codes relevant for the user: 0: good pixel, 8: pick-up noise, 16: cosmic-ray removed, 32: cosmic-ray unremoved, 128: calibration file defect, 256: hot pixel, 512: dark pixel, 4096: A/D converted saturation, 32768: non linear pixel, 1048576: extrapolated flux in NIR, 4194304: Interpolated flux during extraction. (int; default: 2144337919) [default=2144337919].

xsh_scired_ifu_offset_drl.param.pre_overscan_corr

pre-overscan correction. 0: no correction 1: mean overscan correction 2: mean prescan correction 3: (mean pre+mean overscan)/2 correction (int; default: 1) [default=1].

xsh_scired_ifu_offset_drl.param.stack_method

Method used to build master frame. (str; default: ‘median’) [default=”median”].

xsh_scired_ifu_offset_drl.param.klow

Kappa used to clip low level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].

xsh_scired_ifu_offset_drl.param.khigh

Kappa used to clip high level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].

xsh_scired_ifu_offset_drl.param.crh_clip_kappa

Kappa value in sigma clipping during CRH rejection using multiple frames (float; default: 5.0) [default=5.0].

xsh_scired_ifu_offset_drl.param.crh_clip_niter

Number of iterations in sigma clipping during CRH rejection using multiple frames (int; default: 5) [default=5].

xsh_scired_ifu_offset_drl.param.crh_clip_frac

Minimal ratio of points accepted / total in sigma clipping during CRH rejection using multiple frames (float; default: 0.7) [default=0.7].

xsh_scired_ifu_offset_drl.param.background_edges_margin

X margin to order edge to define background sampling points (int; default: 1) [default=1].

xsh_scired_ifu_offset_drl.param.background_poly_deg_y

Poly mode fit deg along Y. (int; default: 9) [default=9].

xsh_scired_ifu_offset_drl.param.background_poly_deg_x

Poly mode fit deg along X. (int; default: 9) [default=9].

xsh_scired_ifu_offset_drl.param.background_poly_kappa

Poly mode kappa value of kappa-sigma-clip outliers removal. (float; default: 10.0) [default=10.0].

xsh_scired_ifu_offset_drl.param.removecrhsingle_sigmalim

Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 5.0) [default=5.0].

xsh_scired_ifu_offset_drl.param.removecrhsingle_flim

Minimum contrast between the Laplacian image and the fine structure image that a point must have to be flagged as CRH. (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 2.0) [default=2.0].

xsh_scired_ifu_offset_drl.param.removecrhsingle_niter

Max number of iterations (int; default: 4) [default=4].

xsh_scired_ifu_offset_drl.param.rectify_kernel

Name of the Interpolation Kernel Used. Possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: ‘tanh’) [default=”tanh”].

xsh_scired_ifu_offset_drl.param.rectify_radius

Rectify Interpolation radius [bin units]. (float; default: 2.0) [default=2.0].

xsh_scired_ifu_offset_drl.param.rectify_bin_lambda

Wavelength step in the output spectrum [nm] (float; default: 0.06) [default=0.06].

xsh_scired_ifu_offset_drl.param.rectify_bin_slit

Spatial step along the slit in the output spectrum [arcsec] (float; default: 0.21) [default=0.21].

xsh_scired_ifu_offset_drl.param.localize_method

Localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: ‘MANUAL’) [default=”MANUAL”].

xsh_scired_ifu_offset_drl.param.localize_chunk_nb

Number of chunks in the full spectrum to localize the object (int; default: 10) [default=10].

xsh_scired_ifu_offset_drl.param.localize_thresh

Threshold relative to the peak intensity below which the edges of the object are detected for MAXIMUM localization (float; default: 0.1) [default=0.1].

xsh_scired_ifu_offset_drl.param.localize_deg_lambda

Degree in lambda in the localization polynomial expression slit=f(lambda), used only for MAXIMUM and GAUSSIAN (int; default: 0) [default=0].

xsh_scired_ifu_offset_drl.param.localize_slit_position

Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0) [default=0.0].

xsh_scired_ifu_offset_drl.param.localize_slit_hheight

Object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0) [default=2.0].

xsh_scired_ifu_offset_drl.param.localize_kappa

Kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0) [default=3.0].

xsh_scired_ifu_offset_drl.param.localize_niter

Number of iterations for sigma clipping in the localization polynomial fit (int; default: 3) [default=3].

xsh_scired_ifu_offset_drl.param.localize_use_skymask

TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False) [default=False].

xsh_scired_ifu_offset_drl.param.extract_method

Method used for extraction (LOCALIZATION, NOD) (str; default: ‘LOCALIZATION’) [default=”LOCALIZATION”].

xsh_scired_ifu_offset_drl.param.stdextract_interp_hsize

Half size of mask used to define object cross order profile (int; default: 30) [default=30].

xsh_scired_ifu_offset_drl.param.shift_offsettab_low

Global shift of the lower slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0) [default=0.0].

xsh_scired_ifu_offset_drl.param.shift_offsettab_up

Global shift of the upper slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0) [default=0.0].

xsh_scired_ifu_offset_drl.param.compute_map

if TRUE recompute (wave and slit) maps from the dispersion solution. If sky-subtract is set to TRUE this must be set to TRUE. (bool; default: True) [default=True].

xsh_scired_ifu_offset_drl.param.check_afc

Input AFC corrected model/wave solution and science frame check.If TRUE the recipe verify that the input mode/wave solution is AFC corrected, its INS.OPTIi.NAME is ‘Pin_0.5 ‘, and its OBS.ID and OBS.TARG.NAME values matches with the corresponding values of the science frame. (bool; default: True) [default=True].

xsh_scired_ifu_offset_drl.param.flat_method

method adopted for flat: (str; default: ‘master’) [default=”master”].

The following code snippet shows the default settings for the available parameters.

import cpl
xsh_scired_ifu_offset_drl = cpl.Recipe("xsh_scired_ifu_offset_drl")

xsh_scired_ifu_offset_drl.param.keep_temp = "no"
xsh_scired_ifu_offset_drl.param.debug_level = "none"
xsh_scired_ifu_offset_drl.param.time_stamp = False
xsh_scired_ifu_offset_drl.param.decode_bp = 2144337919
xsh_scired_ifu_offset_drl.param.pre_overscan_corr = 1
xsh_scired_ifu_offset_drl.param.stack_method = "median"
xsh_scired_ifu_offset_drl.param.klow = 5.0
xsh_scired_ifu_offset_drl.param.khigh = 5.0
xsh_scired_ifu_offset_drl.param.crh_clip_kappa = 5.0
xsh_scired_ifu_offset_drl.param.crh_clip_niter = 5
xsh_scired_ifu_offset_drl.param.crh_clip_frac = 0.7
xsh_scired_ifu_offset_drl.param.background_edges_margin = 1
xsh_scired_ifu_offset_drl.param.background_poly_deg_y = 9
xsh_scired_ifu_offset_drl.param.background_poly_deg_x = 9
xsh_scired_ifu_offset_drl.param.background_poly_kappa = 10.0
xsh_scired_ifu_offset_drl.param.removecrhsingle_sigmalim = 5.0
xsh_scired_ifu_offset_drl.param.removecrhsingle_flim = 2.0
xsh_scired_ifu_offset_drl.param.removecrhsingle_niter = 4
xsh_scired_ifu_offset_drl.param.rectify_kernel = "tanh"
xsh_scired_ifu_offset_drl.param.rectify_radius = 2.0
xsh_scired_ifu_offset_drl.param.rectify_bin_lambda = 0.06
xsh_scired_ifu_offset_drl.param.rectify_bin_slit = 0.21
xsh_scired_ifu_offset_drl.param.localize_method = "MANUAL"
xsh_scired_ifu_offset_drl.param.localize_chunk_nb = 10
xsh_scired_ifu_offset_drl.param.localize_thresh = 0.1
xsh_scired_ifu_offset_drl.param.localize_deg_lambda = 0
xsh_scired_ifu_offset_drl.param.localize_slit_position = 0.0
xsh_scired_ifu_offset_drl.param.localize_slit_hheight = 2.0
xsh_scired_ifu_offset_drl.param.localize_kappa = 3.0
xsh_scired_ifu_offset_drl.param.localize_niter = 3
xsh_scired_ifu_offset_drl.param.localize_use_skymask = False
xsh_scired_ifu_offset_drl.param.extract_method = "LOCALIZATION"
xsh_scired_ifu_offset_drl.param.stdextract_interp_hsize = 30
xsh_scired_ifu_offset_drl.param.shift_offsettab_low = 0.0
xsh_scired_ifu_offset_drl.param.shift_offsettab_up = 0.0
xsh_scired_ifu_offset_drl.param.compute_map = True
xsh_scired_ifu_offset_drl.param.check_afc = True
xsh_scired_ifu_offset_drl.param.flat_method = "master"

You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:

import cpl
xsh_scired_ifu_offset_drl = cpl.Recipe("xsh_scired_ifu_offset_drl")
[...]
res = xsh_scired_ifu_offset_drl( ..., param = {"keep_temp":"no", "debug_level":"none"})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to P.Goldoni, L.Guglielmi, R. Haigron, F. Royer. Alternatively, you may send a report to the ESO User Support Department.