The xsh_scired_slit_nod recipe =============================================================== .. data:: xsh_scired_slit_nod Synopsis -------- Reduce science frames in SLIT configuration and nod mode Description ----------- This recipe reduces science exposure in SLIT configuration and NOD mode Input Frames : - A set of n Science frames ( n even ), Tag = OBJECT_SLIT_NOD_arm - Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm) - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm) - A master flat frame (Tag = MASTER_FLAT_SLIT_arm) - An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm) - [poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm) - [poly mode] A wave map frame(Tag = WAVE_MAP_arm) - [poly mode] A disp table frame(Tag = DISP_TAB_arm) - [physical model mode]A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm) - [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm) - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm) - [OPTIONAL] The instrument response table (Tag = RESPONSE_MERGE1D_SLIT_arm) - [OPTIONAL] An atmospheric extinction table (Tag = ATMOS_EXT_arm) - [OPTIONAL] A telluric mask (Tag = TELL_MASK_arm) - [OPTIONAL] The instrument master response table (Tag = MRESPONSE_MERGE1D_SLIT_arm). If both master and individual response are provided the individual response is preferred. Products : - PREFIX_ORDER2D_arm (2 dimension) - PREFIX_ORDER1D_arm (1 dimension) - PREFIX_MERGE2D_arm (2 dimension) - PREFIX_MERGE1D_arm (1 dimension) - PREFIX_WAVE_MAP_arm, wave map image - PREFIX_SLIT_MAP_arm, slit map image - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_ORDER2D_arm (2 dimension) - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_ORDER1D_arm (1 dimension) - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_MERGE2D_arm (2 dimension) - [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_MERGE1D_arm (1 dimension) - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC Constructor ----------- .. method:: cpl.Recipe("xsh_scired_slit_nod") :noindex: Create an object for the recipe xsh_scired_slit_nod. :: import cpl xsh_scired_slit_nod = cpl.Recipe("xsh_scired_slit_nod") Parameters ---------- .. py:attribute:: xsh_scired_slit_nod.param.keep_temp If 'no', temporary files are deleted. (str; default: 'no') [default="no"]. .. py:attribute:: xsh_scired_slit_nod.param.debug_level Additional xshooter debug level. One of 'none', 'low', 'medium', 'high' (str; default: 'none') [default="none"]. .. py:attribute:: xsh_scired_slit_nod.param.time_stamp Add timestamp to product file name. (bool; default: False) [default=False]. .. py:attribute:: xsh_scired_slit_nod.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: 1875902463) [default=1875902463]. .. py:attribute:: xsh_scired_slit_nod.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]. .. py:attribute:: xsh_scired_slit_nod.param.stack_method Method used to build master frame. (str; default: 'median') [default="median"]. .. py:attribute:: xsh_scired_slit_nod.param.klow Kappa used to clip low level values, when method is set to 'mean' (float; default: 5.0) [default=5.0]. .. py:attribute:: xsh_scired_slit_nod.param.khigh Kappa used to clip high level values, when method is set to 'mean' (float; default: 5.0) [default=5.0]. .. py:attribute:: xsh_scired_slit_nod.param.removecrhsingle_sigmalim Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 20.0) [default=20.0]. .. py:attribute:: xsh_scired_slit_nod.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]. .. py:attribute:: xsh_scired_slit_nod.param.removecrhsingle_niter Max number of iterations (int; default: 4) [default=4]. .. py:attribute:: xsh_scired_slit_nod.param.rectify_kernel Name of the Interpolation Kernel Used. Possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: 'tanh') [default="tanh"]. .. py:attribute:: xsh_scired_slit_nod.param.rectify_radius Rectify Interpolation radius [bin units]. (float; default: 2.0) [default=2.0]. .. py:attribute:: xsh_scired_slit_nod.param.rectify_bin_lambda Wavelength step in the output spectrum [nm] (float; default: -1.0) [default=-1.0]. .. py:attribute:: xsh_scired_slit_nod.param.rectify_bin_slit Spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0) [default=-1.0]. .. py:attribute:: xsh_scired_slit_nod.param.rectify_fast Fast if TRUE (Rect[B-A] = -Rect[A-B]), in that case only entire pixel shifts are applied. (bool; default: True) [default=True]. .. py:attribute:: xsh_scired_slit_nod.param.localize_method Localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: 'MANUAL') [default="MANUAL"]. .. py:attribute:: xsh_scired_slit_nod.param.localize_chunk_nb Number of chunks in the full spectrum to localize the object (int; default: 10) [default=10]. .. py:attribute:: xsh_scired_slit_nod.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]. .. py:attribute:: xsh_scired_slit_nod.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]. .. py:attribute:: xsh_scired_slit_nod.param.localize_slit_position Object position on the slit for MANUAL localization [arcsec]. It refers to the object position in the first frame of the nodding sequence (float; default: 0.0) [default=0.0]. .. py:attribute:: xsh_scired_slit_nod.param.localize_slit_hheight Object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0) [default=2.0]. .. py:attribute:: xsh_scired_slit_nod.param.localize_kappa Kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0) [default=3.0]. .. py:attribute:: xsh_scired_slit_nod.param.localize_niter Number of iterations for sigma clipping in the localization polynomial fit (int; default: 3) [default=3]. .. py:attribute:: xsh_scired_slit_nod.param.localize_use_skymask TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False) [default=False]. .. py:attribute:: xsh_scired_slit_nod.param.localize_nod_throw Step (arcsec) between A and B images in nodding mode. (float; default: 0.0) [default=0.0]. .. py:attribute:: xsh_scired_slit_nod.param.extract_method Method used for extraction (LOCALIZATION, NOD) (str; default: 'NOD') [default="NOD"]. .. py:attribute:: xsh_scired_slit_nod.param.stdextract_interp_hsize Half size of mask used to define object cross order profile (int; default: 30) [default=30]. .. py:attribute:: xsh_scired_slit_nod.param.combinenod_throwlist Name of ascii file containing the list of throw shifts with respect to the first exposure (str; default: 'throwlist.asc') [default="throwlist.asc"]. .. py:attribute:: xsh_scired_slit_nod.param.combinenod_method Combination method for nodded frames (MEDIAN, MEAN) (str; default: 'MEAN') [default="MEAN"]. .. py:attribute:: xsh_scired_slit_nod.param.max_slit Lower Slit Limit (localize and extract (float; default: 5.7) [default=5.7]. .. py:attribute:: xsh_scired_slit_nod.param.min_slit Upper Slit Limit (localize and extract (float; default: -5.3) [default=-5.3]. .. py:attribute:: xsh_scired_slit_nod.param.correct_sky_by_median TRUE if the resampled spectrum at each wavelength is median subtracted to remove sky lines (bool; default: True) [default=True]. .. py:attribute:: xsh_scired_slit_nod.param.cut_uvb_spectrum TRUE if recipe cuts the UVB spectrum at 556 nm (dichroich) (bool; default: True) [default=True]. .. py:attribute:: xsh_scired_slit_nod.param.generate_SDP_format TRUE if additional files should be generated in Science Data Product (SDP) format. (bool; default: False) [default=False]. .. py:attribute:: xsh_scired_slit_nod.param.dummy_association_keys Sets the number of dummy (empty) ASSONi, ASSOCi and ASSOMi keywords to create. (int; default: 0) [default=0]. .. py:attribute:: xsh_scired_slit_nod.param.scale_combine_nod_method frame scaling when nod frames are combined: 0 (no-scaling); 1 (scaling) (int; default: 1) [default=1]. The following code snippet shows the default settings for the available parameters. :: import cpl xsh_scired_slit_nod = cpl.Recipe("xsh_scired_slit_nod") xsh_scired_slit_nod.param.keep_temp = "no" xsh_scired_slit_nod.param.debug_level = "none" xsh_scired_slit_nod.param.time_stamp = False xsh_scired_slit_nod.param.decode_bp = 1875902463 xsh_scired_slit_nod.param.pre_overscan_corr = 1 xsh_scired_slit_nod.param.stack_method = "median" xsh_scired_slit_nod.param.klow = 5.0 xsh_scired_slit_nod.param.khigh = 5.0 xsh_scired_slit_nod.param.removecrhsingle_sigmalim = 20.0 xsh_scired_slit_nod.param.removecrhsingle_flim = 2.0 xsh_scired_slit_nod.param.removecrhsingle_niter = 4 xsh_scired_slit_nod.param.rectify_kernel = "tanh" xsh_scired_slit_nod.param.rectify_radius = 2.0 xsh_scired_slit_nod.param.rectify_bin_lambda = -1.0 xsh_scired_slit_nod.param.rectify_bin_slit = -1.0 xsh_scired_slit_nod.param.rectify_fast = True xsh_scired_slit_nod.param.localize_method = "MANUAL" xsh_scired_slit_nod.param.localize_chunk_nb = 10 xsh_scired_slit_nod.param.localize_thresh = 0.1 xsh_scired_slit_nod.param.localize_deg_lambda = 0 xsh_scired_slit_nod.param.localize_slit_position = 0.0 xsh_scired_slit_nod.param.localize_slit_hheight = 2.0 xsh_scired_slit_nod.param.localize_kappa = 3.0 xsh_scired_slit_nod.param.localize_niter = 3 xsh_scired_slit_nod.param.localize_use_skymask = False xsh_scired_slit_nod.param.localize_nod_throw = 0.0 xsh_scired_slit_nod.param.extract_method = "NOD" xsh_scired_slit_nod.param.stdextract_interp_hsize = 30 xsh_scired_slit_nod.param.combinenod_throwlist = "throwlist.asc" xsh_scired_slit_nod.param.combinenod_method = "MEAN" xsh_scired_slit_nod.param.max_slit = 5.7 xsh_scired_slit_nod.param.min_slit = -5.3 xsh_scired_slit_nod.param.correct_sky_by_median = True xsh_scired_slit_nod.param.cut_uvb_spectrum = True xsh_scired_slit_nod.param.generate_SDP_format = False xsh_scired_slit_nod.param.dummy_association_keys = 0 xsh_scired_slit_nod.param.scale_combine_nod_method = 1 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_nod = cpl.Recipe("xsh_scired_slit_nod") [...] res = xsh_scired_slit_nod( ..., param = {"keep_temp":"no", "debug_level":"none"}) .. seealso:: `cpl.Recipe `_ for more information about the recipe object. Bug reports ----------- 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 `_. Copyright --------- 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 .. codeauthor:: P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich A. Modigliani