Reduce science exposure in SLIT configuration and stare mode
This recipe reduces science exposure in SLIT configuration and stare mode Input Frames :
- A set of n Science frames ( n == 1 or >=3, Tag = OBJECT_SLIT_STARE_UVB)
- A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)
- [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)
- [OPTIONAL]A master dark frame (Tag = MASTER_DARK_arm)
- A master flat frame (Tag = MASTER_FLAT_SLIT_arm)
- An order table frame(Tag = ORDER_TAB_EDGES_SLIT_arm)
- [OPTIONAL] A table with dispersion coefficients (Tag = DISP_TAB_arm, required in poly mode
- [poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm)
- [physical model mode] A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)
- [OPTIONAL] A table specifying multiplying factor for break points (Tag = SKY_SUB_BKPTS_arm) to generate
- [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)
- [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)
- [OPTIONAL,physmod mode] A table listing sky line positions (Tag = SKY_LINE_LIST_arm) this is used to be able to control quality of sky subtraction, for example projecting guess positions on the product SCI_SLIT_STARE_SUB_SKY_arm
- [OPTIONAL] The instrument response table (Tag = RESPONSE_ORDER1D_SLIT_arm)
- [OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm)
- [OPTIONAL] A telluric mask (Tag = TELL_MASK_arm)
Create an object for the recipe xsh_scired_slit_stare.
import cpl
xsh_scired_slit_stare = cpl.Recipe("xsh_scired_slit_stare")
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].
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: 20.0) [default=20.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: -1.0) [default=-1.0].
Spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0) [default=-1.0].
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].
TRUE to use subtract sky single. (bool; default: True) [default=True].
Nb of break points for Bezier curve fitting (without localization) (long; default: 3000) [default=3000].
Nb of break points for Bezier curve fitting (with localization) (long; default: 3000) [default=3000].
Bezier spline order (long; default: 7) [default=7].
Nb of iterations (long; default: 20) [default=20].
Kappa value used to kappa-sigma-clip object (float; default: 5.0) [default=5.0].
Sky subtract Method (BSPLINE, MEDIAN) (str; default: ‘MEDIAN’) [default=”MEDIAN”].
BSPLINE sampling. UNIFORM-uses the user defined nbkpts value, corrected for binning, for all orders. FINE: multiplies the user defined nbkpts value, corrected for binning, by a hard coded coefficient optimized on each arm-order) (str; default: ‘FINE’) [default=”FINE”].
Half size of the running median. If sky-method=MEDIAN . (long; default: 20) [default=20].
Size of edges mask in arcsec (float; default: 0.5) [default=0.5].
Central position of the sky window #1 [arcsec] (float; default: 0.0) [default=0.0].
Half size of sky window #1 [arcsec] (float; default: 0.0) [default=0.0].
Central position of the sky window #2 [arcsec] (float; default: 0.0) [default=0.0].
Half size of the sky window #2 [arcsec] (float; default: 0.0) [default=0.0].
Half size of mask used to define object cross order profile (long; default: 30) [default=30].
TRUE if we do the optimal extraction (bool; default: False) [default=False].
Oversample factor for the science image (long; default: 5) [default=5].
Extraction box [pixel] (long; default: 10) [default=10].
Chunk size [bin] (long; default: 50) [default=50].
Lambda step [nm] (float; default: 0.02) [default=0.02].
Kappa for cosmics ray hits rejection (float; default: 3.0) [default=3.0].
Maximum bad pixels fraction for cosmics ray hits rejection (float; default: 0.4) [default=0.4].
Maximum number of iterations for cosmics ray hits rejection (long; default: 2) [default=2].
Number of iterations (long; default: 1) [default=1].
Extraction method GAUSSIAN | GENERAL (str; default: ‘GAUSSIAN’) [default=”GAUSSIAN”].
TRUE if recipe cuts the UVB spectrum at 556 nm (dichroich) (bool; default: True) [default=True].
The following code snippet shows the default settings for the available parameters.
import cpl
xsh_scired_slit_stare = cpl.Recipe("xsh_scired_slit_stare")
xsh_scired_slit_stare.param.keep_temp = "no"
xsh_scired_slit_stare.param.debug_level = "none"
xsh_scired_slit_stare.param.time_stamp = False
xsh_scired_slit_stare.param.decode_bp = 2144337919
xsh_scired_slit_stare.param.pre_overscan_corr = 1
xsh_scired_slit_stare.param.stack_method = "median"
xsh_scired_slit_stare.param.klow = 5.0
xsh_scired_slit_stare.param.khigh = 5.0
xsh_scired_slit_stare.param.background_edges_margin = 1
xsh_scired_slit_stare.param.background_poly_deg_y = 9
xsh_scired_slit_stare.param.background_poly_deg_x = 9
xsh_scired_slit_stare.param.background_poly_kappa = 10.0
xsh_scired_slit_stare.param.removecrhsingle_sigmalim = 20.0
xsh_scired_slit_stare.param.removecrhsingle_flim = 2.0
xsh_scired_slit_stare.param.removecrhsingle_niter = 4
xsh_scired_slit_stare.param.rectify_kernel = "tanh"
xsh_scired_slit_stare.param.rectify_radius = 2.0
xsh_scired_slit_stare.param.rectify_bin_lambda = -1.0
xsh_scired_slit_stare.param.rectify_bin_slit = -1.0
xsh_scired_slit_stare.param.localize_method = "MANUAL"
xsh_scired_slit_stare.param.localize_chunk_nb = 10
xsh_scired_slit_stare.param.localize_thresh = 0.1
xsh_scired_slit_stare.param.localize_deg_lambda = 0
xsh_scired_slit_stare.param.localize_slit_position = 0.0
xsh_scired_slit_stare.param.localize_slit_hheight = 2.0
xsh_scired_slit_stare.param.localize_kappa = 3.0
xsh_scired_slit_stare.param.localize_niter = 3
xsh_scired_slit_stare.param.localize_use_skymask = False
xsh_scired_slit_stare.param.sky_subtract = True
xsh_scired_slit_stare.param.sky_bspline_nbkpts_first = 3000
xsh_scired_slit_stare.param.sky_bspline_nbkpts_second = 3000
xsh_scired_slit_stare.param.sky_bspline_order = 7
xsh_scired_slit_stare.param.sky_bspline_niter = 20
xsh_scired_slit_stare.param.sky_bspline_kappa = 5.0
xsh_scired_slit_stare.param.sky_method = "MEDIAN"
xsh_scired_slit_stare.param.bspline_sampling = "FINE"
xsh_scired_slit_stare.param.sky_median_hsize = 20
xsh_scired_slit_stare.param.sky_slit_edges_mask = 0.5
xsh_scired_slit_stare.param.sky_position1 = 0.0
xsh_scired_slit_stare.param.sky_hheight1 = 0.0
xsh_scired_slit_stare.param.sky_position2 = 0.0
xsh_scired_slit_stare.param.sky_hheight2 = 0.0
xsh_scired_slit_stare.param.stdextract_interp_hsize = 30
xsh_scired_slit_stare.param.do_optextract = False
xsh_scired_slit_stare.param.optextract_oversample = 5
xsh_scired_slit_stare.param.optextract_box_half_size = 10
xsh_scired_slit_stare.param.optextract_chunk_size = 50
xsh_scired_slit_stare.param.optextract_step_lambda = 0.02
xsh_scired_slit_stare.param.optextract_clip_kappa = 3.0
xsh_scired_slit_stare.param.optextract_clip_frac = 0.4
xsh_scired_slit_stare.param.optextract_clip_niter = 2
xsh_scired_slit_stare.param.optextract_niter = 1
xsh_scired_slit_stare.param.optextract_method = "GAUSSIAN"
xsh_scired_slit_stare.param.cut_uvb_spectrum = True
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_slit_stare = cpl.Recipe("xsh_scired_slit_stare")
[...]
res = xsh_scired_slit_stare( ..., 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, D. Bramich, A. Modigliani. 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, D. Bramich, A. Modigliani <amodigli@eso.org>