/usr/share/doc/cpl-plugin-xshoo-doc/html/_sources/xsh_scired_ifu

The xsh_scired_ifu_stare recipe
===============================================================

.. data:: xsh_scired_ifu_stare

Synopsis
--------

Reduce science IFU stare exposures and build a 3D cube

Description
-----------

This recipe reduce science IFU stare exposures with 3D cube generation
Input Frames : 
  - A set of n Science frames ( n == 1 or >=3,     Tag = OBJECT_IFU_STARE_UVB)
  - A spectral format table frame (Tag = SPECTRAL_FORMAT_TAB_arm)
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)
  - A master dark frame (Tag = MASTER_DARK_arm)
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)
  - An order edges table frame(Tag = ORDER_TAB_EDGES_IFU_arm)
  - [physmod] An AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)
  - [poly] An AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm)
  - [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)
  - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)
Products : 
 - Merged 3D data cube (PREFIX_MERGE3D_DATA_OBJ_arm)
 - QC Traces of 3D data cube (PREFIX_MERGE3D_TRACE_OBJ_arm)
 - Order by order 3D data cube (PREFIX_ORDER3D_DATA_OBJ_arm)
 - Order by order 3D qual cube (IFU_CFG_COR_arm)
 - Order by order 3D qual cube (PREFIX_MERGE3D_DATA_SKY_arm)
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC

Constructor
-----------

.. method:: cpl.Recipe("xsh_scired_ifu_stare")
   :noindex:

   Create an object for the recipe xsh_scired_ifu_stare.

::

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

Parameters
----------

.. py:attribute:: xsh_scired_ifu_stare.param.keep_temp

    If 'no', temporary files are deleted. (str; default: 'no') [default="no"].
.. py:attribute:: xsh_scired_ifu_stare.param.debug_level

    Additional xshooter debug level. One of 'none', 'low', 'medium',  'high' (str; default: 'none') [default="none"].
.. py:attribute:: xsh_scired_ifu_stare.param.time_stamp

    Add timestamp to product file name. (bool; default: False) [default=False].
.. py:attribute:: xsh_scired_ifu_stare.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. (long; default:  2144337919) [default=2144337919].
.. py:attribute:: xsh_scired_ifu_stare.param.pre_overscan_corr

    pre-overscan correction.0: no correction1: mean overscan correction2:  mean prescan correction3: (mean pre+mean overscan)/2 correction (long;  default: 1) [default=1].
.. py:attribute:: xsh_scired_ifu_stare.param.stack_method

    Method used to build master frame. (str; default: 'median') [default="median"].
.. py:attribute:: xsh_scired_ifu_stare.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_ifu_stare.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_ifu_stare.param.crh_clip_kappa

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

    Number of iterations in sigma clipping during CRH rejection using  multiple frames (long; default: 5) [default=5].
.. py:attribute:: xsh_scired_ifu_stare.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].
.. py:attribute:: xsh_scired_ifu_stare.param.background_edges_margin

    X margin to order edge to define background sampling points (long;  default: 1) [default=1].
.. py:attribute:: xsh_scired_ifu_stare.param.background_poly_deg_y

    Poly mode fit deg along Y. (long; default: 9) [default=9].
.. py:attribute:: xsh_scired_ifu_stare.param.background_poly_deg_x

    Poly mode fit deg along X. (long; default: 9) [default=9].
.. py:attribute:: xsh_scired_ifu_stare.param.background_poly_kappa

    Poly mode kappa value of kappa-sigma-clip outliers removal. (float;  default: 10.0) [default=10.0].
.. py:attribute:: xsh_scired_ifu_stare.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_ifu_stare.param.rectify_radius

    Rectify Interpolation radius [bin units]. (float; default: 2.0) [default=2.0].
.. py:attribute:: xsh_scired_ifu_stare.param.rectify_bin_lambda

    Wavelength step in the output spectrum [nm] (float; default: -1.0) [default=-1.0].
.. py:attribute:: xsh_scired_ifu_stare.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_ifu_stare.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: False) [default=False].
.. py:attribute:: xsh_scired_ifu_stare.param.trace_obj

    if TRUE trace object position on each IFU slice. In this case order  TAB edges is required (bool; default: False) [default=False].
.. py:attribute:: xsh_scired_ifu_stare.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].
.. py:attribute:: xsh_scired_ifu_stare.param.cut_uvb_spectrum

    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_ifu_stare = cpl.Recipe("xsh_scired_ifu_stare")

   xsh_scired_ifu_stare.param.keep_temp = "no"
   xsh_scired_ifu_stare.param.debug_level = "none"
   xsh_scired_ifu_stare.param.time_stamp = False
   xsh_scired_ifu_stare.param.decode_bp = 2144337919
   xsh_scired_ifu_stare.param.pre_overscan_corr = 1
   xsh_scired_ifu_stare.param.stack_method = "median"
   xsh_scired_ifu_stare.param.klow = 5.0
   xsh_scired_ifu_stare.param.khigh = 5.0
   xsh_scired_ifu_stare.param.crh_clip_kappa = 5.0
   xsh_scired_ifu_stare.param.crh_clip_niter = 5
   xsh_scired_ifu_stare.param.crh_clip_frac = 0.7
   xsh_scired_ifu_stare.param.background_edges_margin = 1
   xsh_scired_ifu_stare.param.background_poly_deg_y = 9
   xsh_scired_ifu_stare.param.background_poly_deg_x = 9
   xsh_scired_ifu_stare.param.background_poly_kappa = 10.0
   xsh_scired_ifu_stare.param.rectify_kernel = "tanh"
   xsh_scired_ifu_stare.param.rectify_radius = 2.0
   xsh_scired_ifu_stare.param.rectify_bin_lambda = -1.0
   xsh_scired_ifu_stare.param.rectify_bin_slit = -1.0
   xsh_scired_ifu_stare.param.compute_map = False
   xsh_scired_ifu_stare.param.trace_obj = False
   xsh_scired_ifu_stare.param.check_afc = True
   xsh_scired_ifu_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_ifu_stare = cpl.Recipe("xsh_scired_ifu_stare")
   [...]
   res = xsh_scired_ifu_stare( ..., param = {"keep_temp":"no", "debug_level":"none"})


.. seealso:: `cpl.Recipe <http://packages.python.org/python-cpl/recipe.html>`_
   for more information about the recipe object.

Bug reports
-----------

Please report any problems to `A.Modigliani, J.Vernet, P. Bristow <Andrea.Modigliani@eso.org>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

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:: A.Modigliani, J.Vernet, P. Bristow <Andrea.Modigliani@eso.org>
cpl-plugin-xshoo-doc 2.9.3+dfsg-1build1 / usr / share / doc / cpl-plugin-xshoo-doc / html / _sources / xsh_scired_ifu_stare.rst.txt
