The visir_img_burst recipe
===============================================================

.. data:: visir_img_burst

Synopsis
--------

Images burst combination recipe

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

visir_img_burst -- VISIR burst mode recipe.

This recipe recombines data observed in chopping and/or nodding mode into one combined image using optionally cross-correlation methods

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

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

   Create an object for the recipe visir_img_burst.

::

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

Parameters
----------

.. py:attribute:: visir_img_burst.param.SI

    starting image where the noise level is ok - -1 for auto mode (long;  default: 1) [default=1].
.. py:attribute:: visir_img_burst.param.IPOS

    index where the pos source changes position in the nodded cube (long;  default: -1) [default=-1].
.. py:attribute:: visir_img_burst.param.INEG

    index where the neg source changes position in the nodded cube (long;  default: -1) [default=-1].
.. py:attribute:: visir_img_burst.param.left_chop

    tell if the source is in the left or right side in the chopped im  (long; default: -1) [default=-1].
.. py:attribute:: visir_img_burst.param.left_nod

    tell if the source is in the left or right side in the nodded im  (long; default: -1) [default=-1].
.. py:attribute:: visir_img_burst.param.sigma_nod

    threshold used for the detection of sources in the images nodded  (float; default: 4.0) [default=4.0].
.. py:attribute:: visir_img_burst.param.sigma_chop

    threshold used for the det. of sources in the images chopped (float;  default: 4.0) [default=4.0].
.. py:attribute:: visir_img_burst.param.sigma_4sources

    threshold used for the detection of the position of 4 sources (float;  default: 4.0) [default=4.0].
.. py:attribute:: visir_img_burst.param.destripe

    Flag to use the destriping (bool; default: False) [default=False].
.. py:attribute:: visir_img_burst.param.morpho

    Flag to use the morphological cleaning in the destriping (bool;  default: False) [default=False].
.. py:attribute:: visir_img_burst.param.debug

    Flag to make a debug computation and save files (bool; default: False) [default=False].
.. py:attribute:: visir_img_burst.param.psf

    Ignored (str; default: '/dev/null') [default="/dev/null"].


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

::

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

   visir_img_burst.param.SI = 1
   visir_img_burst.param.IPOS = -1
   visir_img_burst.param.INEG = -1
   visir_img_burst.param.left_chop = -1
   visir_img_burst.param.left_nod = -1
   visir_img_burst.param.sigma_nod = 4.0
   visir_img_burst.param.sigma_chop = 4.0
   visir_img_burst.param.sigma_4sources = 4.0
   visir_img_burst.param.destripe = False
   visir_img_burst.param.morpho = False
   visir_img_burst.param.debug = False
   visir_img_burst.param.psf = "/dev/null"


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

::

   import cpl
   visir_img_burst = cpl.Recipe("visir_img_burst")
   [...]
   res = visir_img_burst( ..., param = {"SI":1, "IPOS":-1})


.. 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) 2007 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>
