The sinfo_utl_skymap recipe
===============================================================

.. data:: sinfo_utl_skymap

Synopsis
--------

Flags sky lines as bad pixels, with map generation

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

This recipe flags as bad pixels sky lines.

Input are sky frames with tag SKY
Output image is called out_skymap.fits
Information on relevant parameters can be found with
esorex --params sinfo_utl_skymap
esorex --help sinfo_utl_skymap


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

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

   Create an object for the recipe sinfo_utl_skymap.

::

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

Parameters
----------

.. py:attribute:: sinfo_utl_skymap.param.xsize

    X box size (long; default: 1) [default=1].
.. py:attribute:: sinfo_utl_skymap.param.ysize

    Y box size (long; default: 30) [default=30].
.. py:attribute:: sinfo_utl_skymap.param.thresh

    Threshold (float; default: 30.0) [default=30.0].


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

::

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

   sinfo_utl_skymap.param.xsize = 1
   sinfo_utl_skymap.param.ysize = 30
   sinfo_utl_skymap.param.thresh = 30.0


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

::

   import cpl
   sinfo_utl_skymap = cpl.Recipe("sinfo_utl_skymap")
   [...]
   res = sinfo_utl_skymap( ..., param = {"xsize":1, "ysize":30})


.. 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 `Andrea Modigliani <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 SINFONI Instrument Pipeline
Copyright (C) 2002,2003 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 <Andrea.Modigliani@eso.org>
