The visir_img_ff recipe
===============================================================

.. data:: visir_img_ff

Synopsis
--------

Flat field recipe

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

This recipe computes the flatfield.

The files listed in the Set Of Frames (sof-file) must be tagged either
VISIR-flatfield-raw-file.fits IM_CAL_FLAT or
VISIR-flatfield-raw-file.fits IM_TECH_FLAT or
VISIR-flatfield-raw-file.fits SPEC_CAL_FLAT or
VISIR-flatfield-raw-file.fits SPEC_TECH_FLAT

The corresponding primary product will have a FITS card
'HIERARCH ESO PRO CATG' with a value of
IMG_FF or
IMG_FF_TECH or
SPEC_FF or
SPEC_FF_TECH

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

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

   Create an object for the recipe visir_img_ff.

::

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

Parameters
----------

.. py:attribute:: visir_img_ff.param.low

    Low threshold for the bad pixel map (float; default: 0.2) [default=0.2].
.. py:attribute:: visir_img_ff.param.high

    High threshold for the bad pixel map (float; default: 5.0) [default=5.0].


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

::

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

   visir_img_ff.param.low = 0.2
   visir_img_ff.param.high = 5.0


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_ff = cpl.Recipe("visir_img_ff")
   [...]
   res = visir_img_ff( ..., param = {"low":0.2, "high":5.0})


.. 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 `Lars Lundin <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) 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 <https://support.eso.org>