.TH XSH_RESPON_SLIT_OFFSET "7" "2.5.2" "xsh_respon_slit_offset" "xshoo recipes"
.SH NAME
xsh_respon_slit_offset \- Compute the response function in SLIT and on/off mode

.SH SYNOPSIS
esorex
.B xsh_respon_slit_offset
[OPTIONS] FILE.sof

.SH 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)
  \- [OPTIONAL] A telluric model catalog (Tag = TELL_MOD_CAT_arm arm=VIS,NIR)
  \- A standard star fluxes catalog (Tag = FLUX_STD_CATALOG_arm Type = FLX)
  \- A table to set response sampling points (Tag = RESP_FIT_POINTS_CAT_arm)
  \- An atmospheric extinction table (Tag = ATMOS_EXT_arm)
  \- [OPTIONAL] An master response curve table (Tag = MRESPONSE_MERGE1D_SLIT_arm)
    if provided this is the one used to flux calibrate the spectra
Products : 
Products : 
  \- [If STD is in catal] The response ord\-by\-ord function (Tag = RESPONSE_ORDER1D_SLIT_arm)
  \- [If STD is in catal] The response merged function (Tag = RESPONSE_MERGE1D_SLIT_arm)
  \- 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
 \- [If STD is in catal] Flux calibrated order\-by\-order 2D spectrum (Tag = PREFIX_FLUX_ORDER2D_arm)
 \- [If STD is in catal] Flux calibrated order\-by\-order 1D spectrum (Tag = PREFIX_FLUX_ORDER1D_arm)
 \- [If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUX_MERGE2D_arm)
 \- [If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUX_MERGE1D_arm)
 \- PREFIX_SKY_arm, 2D sky frame
 \- SKY_SLIT_ORDER2D_arm, 2D sky image (order\-by\-order)
 \- SKY_SLIT_MERGE2D_arm, 2D sky image (merged)
 \- [If STD is in catal] The efficiency (Tag = EFFICIENCY_arm)
 \- 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

.SH OPTIONS
.TP
\fB\-\-keep\-temp\fR \fI<str>\fR
If \'no\', temporary files are deleted. (str; default: \'no\'). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.keep\-temp\fR [default = \fIno\fR].
.TP
\fB\-\-debug\-level\fR \fI<str>\fR
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 \fBxsh.xsh_respon_slit_offset.debug\-level\fR [default = \fInone\fR].
.TP
\fB\-\-time\-stamp\fR \fI<bool>\fR
Add timestamp to product file name. (bool; default: False). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.time\-stamp\fR [default = \fIFalse\fR].
.TP
\fB\-\-decode\-bp\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.decode\-bp\fR [default = \fI2144337919\fR].
.TP
\fB\-\-pre\-overscan\-corr\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.pre\-overscan\-corr\fR [default = \fI1\fR].
.TP
\fB\-\-removecrhsingle\-sigmalim\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.removecrhsingle\-sigmalim\fR [default = \fI20.0\fR].
.TP
\fB\-\-removecrhsingle\-flim\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.removecrhsingle\-flim\fR [default = \fI2.0\fR].
.TP
\fB\-\-removecrhsingle\-niter\fR \fI<long>\fR
Max number of iterations (long; default: 4). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.removecrhsingle\-niter\fR [default = \fI4\fR].
.TP
\fB\-\-rectify\-kernel\fR \fI<str>\fR
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 \fBxsh.xsh_respon_slit_offset.rectify\-kernel\fR [default = \fItanh\fR].
.TP
\fB\-\-rectify\-radius\fR \fI<float>\fR
Rectify Interpolation radius [bin units]. (float; default: 2.0). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.rectify\-radius\fR [default = \fI2.0\fR].
.TP
\fB\-\-rectify\-bin\-lambda\fR \fI<float>\fR
Wavelength step in the output spectrum [nm] (float; default: \-1.0). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.rectify\-bin\-lambda\fR [default = \fI\-1.0\fR].
.TP
\fB\-\-rectify\-bin\-slit\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.rectify\-bin\-slit\fR [default = \fI\-1.0\fR].
.TP
\fB\-\-localize\-method\fR \fI<str>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-method\fR [default = \fIMANUAL\fR].
.TP
\fB\-\-localize\-chunk\-nb\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-chunk\-nb\fR [default = \fI10\fR].
.TP
\fB\-\-localize\-thresh\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-thresh\fR [default = \fI0.1\fR].
.TP
\fB\-\-localize\-deg\-lambda\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-deg\-lambda\fR [default = \fI0\fR].
.TP
\fB\-\-localize\-slit\-position\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-slit\-position\fR [default = \fI0.0\fR].
.TP
\fB\-\-localize\-slit\-hheight\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-slit\-hheight\fR [default = \fI2.0\fR].
.TP
\fB\-\-localize\-kappa\fR \fI<float>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-kappa\fR [default = \fI3.0\fR].
.TP
\fB\-\-localize\-niter\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-niter\fR [default = \fI3\fR].
.TP
\fB\-\-localize\-use\-skymask\fR \fI<bool>\fR
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 \fBxsh.xsh_respon_slit_offset.localize\-use\-skymask\fR [default = \fIFalse\fR].
.TP
\fB\-\-stdextract\-interp\-hsize\fR \fI<long>\fR
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 \fBxsh.xsh_respon_slit_offset.stdextract\-interp\-hsize\fR [default = \fI30\fR].
.TP
\fB\-\-combinenod\-method\fR \fI<str>\fR
Combination method for nodded frames (MEDIAN, MEAN) (str; default:
\'MEAN\'). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.combinenod\-method\fR [default = \fIMEAN\fR].
.TP
\fB\-\-gen\-sky\fR \fI<bool>\fR
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 \fBxsh.xsh_respon_slit_offset.gen\-sky\fR [default = \fITrue\fR].
.TP
\fB\-\-correct\-tellurics\fR \fI<bool>\fR
TRUE if during response computation we apply telluric correction
(bool; default: True). The full name of this option for the EsoRex configuration
file is \fBxsh.xsh_respon_slit_offset.correct\-tellurics\fR [default = \fITrue\fR].

.PP
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.

.SH SEE ALSO
The full documentation for the xshoo pipeline can be downloaded as 
a PDF file using the following URL:
.IP
.B ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo\-pipeline\-manual\-12.1.pdf
.PP
An overview over the existing ESO pipelines can be found on the web page
\fBhttp://www.eso.org/sci/software/pipelines/\fR.
.PP
Basic documentation about the EsoRex program can be found at the esorex (1) 
man page.
.PP
It is possible to call the pipelines from python using the python\-cpl package.
See \fBhttp://packages.python.org/python\-cpl/index.html\fR for further
information.
.PP
The other recipes of the xshoo pipeline are
.IR xsh_cfg_recover (7),
.IR xsh_lingain (7),
.IR xsh_geom_ifu (7),
.IR xsh_wavecal (7),
.IR xsh_scired_slit_nod (7),
.IR xsh_respon_slit_nod (7),
.IR xsh_mdark (7),
.IR xsh_orderpos (7),
.IR xsh_scired_ifu_stare_drl (7),
.IR xsh_scired_ifu_stare (7),
.IR xsh_flexcomp (7),
.IR xsh_scired_ifu_offset_drl (7),
.IR xsh_util_physmod (7),
.IR xsh_respon_slit_stare (7),
.IR xsh_2dmap (7),
.IR xsh_mflat (7),
.IR xsh_mbias (7),
.IR xsh_predict (7),
.IR xsh_scired_ifu_offset (7),
.IR xsh_scired_slit_stare (7),
.IR xsh_scired_slit_offset (7)

.SH VERSION
xsh_respon_slit_offset 2.5.2

.SH AUTHOR
D. Bramich, A.Modigliani <amodigli@eso.org>

.SH 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>.

.SH 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
