The visir_util_run_swarp recipe
===============================================================

.. data:: visir_util_run_swarp

Synopsis
--------

Run swarp program to coadd images.

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

WARNING: this recipe is intented to be run in a temporary directory, it does not clean up behind itself
The files listed in the Set Of Frames (sof-file) must be tagged:
VISIR-chopnod-corrected-file.fits BKG_CORRECTED
VISIR-error-map.fits ERROR_MAP
It will produce the coaddition of each input frame separately and of all frames together.

The single frame product(s) will have a FITS card
'HIERARCH ESO PRO CATG' with a value of: COADDED_IMAGE and COADDED_WEIGHT
The total coaddition will have the tags COADDED_IMAGE_COMBINED and COADDED_WEIGHT_COMBINED

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

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

   Create an object for the recipe visir_util_run_swarp.

::

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

Parameters
----------

.. py:attribute:: visir_util_run_swarp.param.output_all

    Output a coadded image for each input file in addition to the complete  coaddition. (bool; default: False) [default=False].
.. py:attribute:: visir_util_run_swarp.param.extra_config

    Additional configuration parameters (str; default: 'NONE') [default="NONE"].
.. py:attribute:: visir_util_run_swarp.param.config_fname

    Swarp configure file name. (str; default: '/usr/share/cpl-  plugins/visir-4.4.2/config/visir_default.swarp') [default="/usr/share/cpl-plugins/visir-4.4.2/config/visir_default.swarp"].
.. py:attribute:: visir_util_run_swarp.param.nprocs

    Maximum number of swarp processes that can be spawned simultaneously.  (int; default: -1) [default=-1].


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

::

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

   visir_util_run_swarp.param.output_all = False
   visir_util_run_swarp.param.extra_config = "NONE"
   visir_util_run_swarp.param.config_fname = "/usr/share/cpl-plugins/visir-4.4.2/config/visir_default.swarp"
   visir_util_run_swarp.param.nprocs = -1


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_run_swarp = cpl.Recipe("visir_util_run_swarp")
   [...]
   res = visir_util_run_swarp( ..., param = {"output_all":False, "extra_config":"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 `Julian Taylor <https://support.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) 2012 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:: Julian Taylor <https://support.eso.org>