The xsh_util_physmod recipe
===============================================================

.. data:: xsh_util_physmod

Synopsis
--------

Generate physical model products

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

This recipe generates the theoretical and the spectral format tables. 
and possibly the model based wave map.

The sof file contains the names of the input FITS file
tagged with XSH_MOD_CFG_TAB_arm.

tagged with ARC_LINE_LIST_arm.

This recipe has the following products:
Model order traces for nine pinholes (PRO CATG = THEO_TAB_MULT_arm)
Model order traces for nine pinholes (PRO CATG = THEO_TAB_IFU_arm)
Model order traces for central pinhole (PRO CATG = THEO_TAB_SING_arm)
Spectral format table (PRO CATG = SPECTRAL_FORMAT_TAB_arm)
Wave map image (PRO CATG = WAVE_MAP_arm)
Slit map image (PRO CATG = SLIT_MAP_arm)

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

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

   Create an object for the recipe xsh_util_physmod.

::

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

Parameters
----------

.. py:attribute:: xsh_util_physmod.param.keep_temp

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

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

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

    X binning  (int; default: 1) [default=1].
.. py:attribute:: xsh_util_physmod.param.biny

    X binning  (int; default: 1) [default=1].
.. py:attribute:: xsh_util_physmod.param.spectral_format_tab

    Generate spectral format table   (bool; default: False) [default=False].
.. py:attribute:: xsh_util_physmod.param.wavemap

    Generate slit and wave maps (time consuming)  (bool; default: False) [default=False].


The following code snippet shows the default settings for the available 
parameters.

::

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

   xsh_util_physmod.param.keep_temp = "no"
   xsh_util_physmod.param.debug_level = "none"
   xsh_util_physmod.param.time_stamp = False
   xsh_util_physmod.param.decode_bp = 2144337919
   xsh_util_physmod.param.binx = 1
   xsh_util_physmod.param.biny = 1
   xsh_util_physmod.param.spectral_format_tab = False
   xsh_util_physmod.param.wavemap = False


You may also set or overwrite some or all parameters by the recipe 
parameter `param`, as shown in the following example:

::

   import cpl
   xsh_util_physmod = cpl.Recipe("xsh_util_physmod")
   [...]
   res = xsh_util_physmod( ..., param = {"keep_temp":"no", "debug_level":"none"})


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

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

Please report any problems to `Andrea Modigliani <amodigli@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:: Andrea Modigliani <amodigli@eso.org>