Reduce science exposure in IFU configuration and on/off mode
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)
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")
If ‘no’, temporary files are deleted. (str; default: ‘no’) [default=”no”].
Additional xshooter debug level. One of ‘none’, ‘low’, ‘medium’, ‘high’ (str; default: ‘none’) [default=”none”].
Add timestamp to product file name. (bool; default: False) [default=False].
Integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. (long; default: 2144337919) [default=2144337919].
pre-overscan correction.0: no correction1: mean overscan correction2: mean prescan correction3: (mean pre+mean overscan)/2 correction (long; default: 1) [default=1].
Method used to build master frame. (str; default: ‘median’) [default=”median”].
Kappa used to clip low level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].
Kappa used to clip high level values, when method is set to ‘mean’ (float; default: 5.0) [default=5.0].
Kappa value in sigma clipping during CRH rejection using multiple frames (float; default: 5.0) [default=5.0].
Number of iterations in sigma clipping during CRH rejection using multiple frames (long; default: 5) [default=5].
Minimal ratio of points accepted / total in sigma clipping during CRH rejection using multiple frames (float; default: 0.7) [default=0.7].
X margin to order edge to define background sampling points (long; default: 1) [default=1].
Poly mode fit deg along Y. (long; default: 9) [default=9].
Poly mode fit deg along X. (long; default: 9) [default=9].
Poly mode kappa value of kappa-sigma-clip outliers removal. (float; default: 10.0) [default=10.0].
Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 5.0) [default=5.0].
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].
Max number of iterations (long; default: 4) [default=4].
Name of the Interpolation Kernel Used. Possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: ‘tanh’) [default=”tanh”].
Rectify Interpolation radius [bin units]. (float; default: 2.0) [default=2.0].
Wavelength step in the output spectrum [nm] (float; default: 0.06) [default=0.06].
Spatial step along the slit in the output spectrum [arcsec] (float; default: 0.21) [default=0.21].
Localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: ‘MANUAL’) [default=”MANUAL”].
Number of chunks in the full spectrum to localize the object (long; default: 10) [default=10].
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].
Degree in lambda in the localization polynomial expression slit=f(lambda), used only for MAXIMUM and GAUSSIAN (long; default: 0) [default=0].
Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0) [default=0.0].
Object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0) [default=2.0].
Kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0) [default=3.0].
Number of iterations for sigma clipping in the localization polynomial fit (long; default: 3) [default=3].
TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False) [default=False].
Method used for extraction (LOCALIZATION, NOD) (str; default: ‘LOCALIZATION’) [default=”LOCALIZATION”].
Half size of mask used to define object cross order profile (long; default: 30) [default=30].
Global shift of the lower slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0) [default=0.0].
Global shift of the upper slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0) [default=0.0].
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].
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].
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.
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.
This file is part of the X-shooter Instrument Pipeline Copyright (C) 2006 European Southern Observatory
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Code author: P.Goldoni, L.Guglielmi, R. Haigron, F. Royer <amodigli@eso.org>