Provided by: cpl-plugin-xsh-doc_2.3.0+dfsg-3_all bug

NAME

       xsh_scired_slit_offset - Reduce science exposure in SLIT configuration and on/off mode

SYNOPSIS

       esorex xsh_scired_slit_offset [OPTIONS] FILE.sof

DESCRIPTION

       This recipe reduces science exposure in SLIT configuration and on/off mode Input Frames :
         -  A  set  of  n  Science  frames  (  n  even  ),        Tag = STD_FLUX_SLIT_OFFSET_arm,
       SKY_SLIT_arm
         - Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)
         - A master flat frame (Tag = MASTER_FLAT_SLIT_arm)
         - An order table frame(Tag = ORDER_TABLE_EDGES_SLIT_arm)
         - A wavelength calibration solution frame(Tag = WAVE_TAB_2D_arm)
         - [OPTIONAL] Table with dispersion coefficients (Tag = DISP_TAB_arm)
           It is required if -rectify-conserve-flux=TRUE
         - [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) Products :
         - PREFIX_ORDER2D_arm extracted spectrum, order-by-order, 2D
         - PREFIX_ORDER1D_arm extracted spectrum, order-by-order, 1D
         - PREFIX_MERGE2D_arm merged spectrum, 2D
         - PREFIX_MERGE1D_arm merged spectrum, 1D
         - PREFIX_SKY_arm, 2D sky frame
         - SKY_SLIT_ORDER2D_arm, 2D sky image (order-by-order)
         - SKY_SLIT_MERGE2D_arm, 2D sky image (merged)
         - PREFIX_WAVE_MAP_arm, wave map image
         - PREFIX_SLIT_MAP_arm, slit map image
        - where PREFIX is SCI, FLUX, TELL if input  raw  DPR.TYPE  contains  OBJECT  or  FLUX  or
       TELLURIC
         -  [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)

OPTIONS

       --keep-temp <str>
              If  ´no´,  temporary files are deleted. (str; default: ´no´). The full name of this
              option for the EsoRex configuration  file  is  xsh.xsh_scired_slit_offset.keep-temp
              [default = no].

       --debug-level <str>
              Additional  xshooter  debug  level.  One  of  ´none´, ´low´, ´medium´, ´high´ (str;
              default: ´none´). The full name of this option for the EsoRex configuration file is
              xsh.xsh_scired_slit_offset.debug-level [default = none].

       --time-stamp <bool>
              Add  timestamp  to product file name. (bool; default: False). The full name of this
              option for the EsoRex configuration file  is  xsh.xsh_scired_slit_offset.time-stamp
              [default = False].

       --decode-bp <long>
              Integer representation of the bits to be considered bad when decoding the bad pixel
              mask pixel values. (long; default: 2144337919). The full name of  this  option  for
              the  EsoRex  configuration  file is xsh.xsh_scired_slit_offset.decode-bp [default =
              2144337919].

       --pre-overscan-corr <long>
              pre-overscan correction.0: no correction1: mean overscan correction2: mean  prescan
              correction3:  (mean  pre+mean  overscan)/2  correction (long; default: 1). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              xsh.xsh_scired_slit_offset.pre-overscan-corr [default = 1].

       --removecrhsingle-sigmalim <float>
              Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27)
              (float; default: 20.0). The full name of this option for the  EsoRex  configuration
              file is xsh.xsh_scired_slit_offset.removecrhsingle-sigmalim [default = 20.0].

       --removecrhsingle-flim <float>
              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).  The full name of this option for the EsoRex configuration
              file is xsh.xsh_scired_slit_offset.removecrhsingle-flim [default = 2.0].

       --removecrhsingle-niter <long>
              Max number of iterations (long; default: 4). The full name of this option  for  the
              EsoRex   configuration   file  is  xsh.xsh_scired_slit_offset.removecrhsingle-niter
              [default = 4].

       --rectify-kernel <str>
              Name of the Interpolation Kernel Used. Possible values  are:   tanh,  sinc,  sinc2,
              lanczos,  hamming,  hann.  (str; default: ´tanh´). The full name of this option for
              the EsoRex configuration file is xsh.xsh_scired_slit_offset.rectify-kernel [default
              = tanh].

       --rectify-radius <float>
              Rectify  Interpolation  radius [bin units]. (float; default: 2.0). The full name of
              this      option      for      the      EsoRex      configuration      file      is
              xsh.xsh_scired_slit_offset.rectify-radius [default = 2.0].

       --rectify-bin-lambda <float>
              Wavelength  step  in the output spectrum [nm] (float; default: -1.0). The full name
              of     this     option     for     the     EsoRex     configuration     file     is
              xsh.xsh_scired_slit_offset.rectify-bin-lambda [default = -1.0].

       --rectify-bin-slit <float>
              Spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0).
              The  full  name  of  this   option   for   the   EsoRex   configuration   file   is
              xsh.xsh_scired_slit_offset.rectify-bin-slit [default = -1.0].

       --localize-method <str>
              Localization  method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid
              and height on the slit (str; default: ´MANUAL´). The full name of this  option  for
              the   EsoRex   configuration   file  is  xsh.xsh_scired_slit_offset.localize-method
              [default = MANUAL].

       --localize-chunk-nb <long>
              Number of chunks in the full spectrum to localize the object (long;  default:  10).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.localize-chunk-nb [default = 10].

       --localize-thresh <float>
              Threshold relative to the peak intensity below which the edges of  the  object  are
              detected  for  MAXIMUM  localization  (float;  default: 0.1). The full name of this
              option       for       the        EsoRex        configuration        file        is
              xsh.xsh_scired_slit_offset.localize-thresh [default = 0.1].

       --localize-deg-lambda <long>
              Degree  in  lambda  in  the localization polynomial expression slit=f(lambda), used
              only for MAXIMUM and GAUSSIAN (long; default: 0). The full name of this option  for
              the  EsoRex  configuration  file  is xsh.xsh_scired_slit_offset.localize-deg-lambda
              [default = 0].

       --localize-slit-position <float>
              Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.localize-slit-position [default = 0.0].

       --localize-slit-hheight <float>
              Object half height on the slit for MANUAL localization  [arcsec]  (float;  default:
              2.0).  The  full  name  of  this  option  for  the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.localize-slit-hheight [default = 2.0].

       --localize-kappa <float>
              Kappa value for sigma clipping in the localization polynomial fit (float;  default:
              3.0).  The  full  name  of  this  option  for  the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.localize-kappa [default = 3.0].

       --localize-niter <long>
              Number of iterations for sigma clipping in the localization polynomial  fit  (long;
              default:  3).  The  full  name  of this option for the EsoRex configuration file is
              xsh.xsh_scired_slit_offset.localize-niter [default = 3].

       --localize-use-skymask <bool>
              TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.localize-use-skymask [default = False].

       --stdextract-interp-hsize <long>
              Half size of mask used to define object cross order profile  (long;  default:  30).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              xsh.xsh_scired_slit_offset.stdextract-interp-hsize [default = 30].

       --combinenod-method <str>
              Combination method for nodded frames (MEDIAN, MEAN)  (str;  default:  ´MEAN´).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              xsh.xsh_scired_slit_offset.combinenod-method [default = MEAN].

       --gen-sky <bool>
              if TRUE a 2D sky frame, a 2D rectified,  a  2D  merged  sky  are  generated  (bool;
              default:  True).  The full name of this option for the EsoRex configuration file is
              xsh.xsh_scired_slit_offset.gen-sky [default = True].

       Note that it is possible to create a configuration file containing  these  options,  along
       with  suitable default values. Please refer to the details provided by the 'esorex --help'
       command.

SEE ALSO

       The full documentation for the xsh pipeline can be downloaded as  a  PDF  file  using  the
       following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/xsh/xsh-pipeline-manual-12.1.pdf

       An   overview   over   the   existing   ESO  pipelines  can  be  found  on  the  web  page
       http://www.eso.org/sci/software/pipelines/.

       Basic documentation about the EsoRex program can be found at the esorex (1) man page.

       It is possible to call the pipelines  from  python  using  the  python-cpl  package.   See
       http://packages.python.org/python-cpl/index.html for further information.

       The   other   recipes   of   the  xsh  pipeline  are  xsh_cfg_recover(7),  xsh_lingain(7),
       xsh_geom_ifu(7),    xsh_wavecal(7),    xsh_scired_slit_nod(7),     xsh_respon_slit_nod(7),
       xsh_mdark(7),   xsh_respon_slit_offset(7),  xsh_orderpos(7),  xsh_scired_ifu_stare_drl(7),
       xsh_scired_ifu_stare(7),          xsh_flexcomp(7),           xsh_scired_ifu_offset_drl(7),
       xsh_util_physmod(7),  xsh_respon_slit_stare(7),  xsh_2dmap(7), xsh_mflat(7), xsh_mbias(7),
       xsh_predict(7), xsh_scired_ifu_offset(7), xsh_scired_slit_stare(7)

VERSION

       xsh_scired_slit_offset 2.3.0

AUTHOR

       P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani <amodigli@eso.org>

BUG REPORTS

       Please report any problems to amodigli@eso.org. Alternatively, you may send  a  report  to
       the ESO User Support Department <usd-help@eso.org>.

LICENSE

       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