The visir_util_inputs recipe
===============================================================

.. data:: visir_util_inputs

Synopsis
--------

Conversion of raw images to nodded images

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

The files listed in the Set Of Frames (sof-file) must be tagged:
VISIR-raw-file.fits RAW
Additionally, a bad pixel map
may be added to the Set Of Frames with tag: BPM.

Additionally, a flat field
may be added to the Set Of Frames with tag: FLAT.


The product(s) will have a FITS card
'HIERARCH ESO PRO CATG' with a value of:
IMG_COMBINED

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

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

   Create an object for the recipe visir_util_inputs.

::

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

Parameters
----------

.. py:attribute:: visir_util_inputs.param.nod

    An optional ASCII specification of the nodding positions (in case they  are missing from the FITS-file). The file must consist of one line per  input FITS-file and each line must consist of an integer (which is  ignored) followed by a 0 or 1 (to indicate object or sky).  (str;  default: '') [default=""].
.. py:attribute:: visir_util_inputs.param.auto_bpm

    Automatic detection and correction of bad pixels (bool; default: True) [default=True].
.. py:attribute:: visir_util_inputs.param.g

    Automatic filtering of glitches (bool; default: False) [default=False].
.. py:attribute:: visir_util_inputs.param.p

    Automatic purging of half-cycle images whose median deviates more than  a factor three from the mean of the medians of half-cycle images or  whose standard deviation deviates more than a factor three from the  mean of their standard deviations (bool; default: False) [default=False].
.. py:attribute:: visir_util_inputs.param.destripe_iterations

    Max number of destriping iterations (0 to disable destriping).  Horizontal destriping is done first and if no horizontal striping is  detected, vertical destriping is performed (long; default: 15) [default=15].
.. py:attribute:: visir_util_inputs.param.destripe_morpho

    Destripe with morphological cleaning (bool; default: False) [default=False].


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

::

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

   visir_util_inputs.param.nod = ""
   visir_util_inputs.param.auto_bpm = True
   visir_util_inputs.param.g = False
   visir_util_inputs.param.p = False
   visir_util_inputs.param.destripe_iterations = 15
   visir_util_inputs.param.destripe_morpho = False


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

::

   import cpl
   visir_util_inputs = cpl.Recipe("visir_util_inputs")
   [...]
   res = visir_util_inputs( ..., param = {"nod":"", "auto_bpm":True})


.. 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 `Lars Lundin <llundin@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 VISIR Instrument Pipeline
Copyright (C) 2004, 2005 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., 51 Franklin St, Fifth Floor, Boston, 
MA  02111-1307  USA

.. codeauthor:: Lars Lundin <llundin@eso.org>
