The vimos_ima_fringe recipe
===============================================================

.. data:: vimos_ima_fringe

Synopsis
--------

Fringe frame creation for imaging

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

vimos_ima_fringe -- VIMOS fringe frame creation recipe.


Take a list of science frames and correct them to remove bias, dark
and flat field signatures. Combine the images to form a new master
fringe frame

The program accepts the following files in the SOF:

    Tag                   Description
    OBJECT                A list of raw science images
    MASTER_BIAS           A master bias frame
    MASTER_DARK           A master dark frame
    MASTER_TWILIGHT_FLAT  A master flat frame
    MASTER_CONF           A master confidence map
    MASTER_READGAIN       A master readgain table
All of these are required.


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

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

   Create an object for the recipe vimos_ima_fringe.

::

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

Parameters
----------

.. py:attribute:: vimos_ima_fringe.param.prettynames

    Use pretty product names? (bool; default: False) [default=False].
.. py:attribute:: vimos_ima_fringe.param.psm_ipix

    Minimum pixel area for each detected object (int; default: 5) [default=5].
.. py:attribute:: vimos_ima_fringe.param.psm_thresh

    Detection threshold in sigma above sky (float; default: 3.0) [default=3.0].
.. py:attribute:: vimos_ima_fringe.param.psm_nbsize

    Background smoothing box size (int; default: 64) [default=64].


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

::

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

   vimos_ima_fringe.param.prettynames = False
   vimos_ima_fringe.param.psm_ipix = 5
   vimos_ima_fringe.param.psm_thresh = 3.0
   vimos_ima_fringe.param.psm_nbsize = 64


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

::

   import cpl
   vimos_ima_fringe = cpl.Recipe("vimos_ima_fringe")
   [...]
   res = vimos_ima_fringe( ..., param = {"prettynames":False, "psm_ipix":5})


.. 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 `Jim Lewis <jrl@ast.cam.ac.uk>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is part of the VIMOS Instrument Pipeline
Copyright (C) 2019 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:: Jim Lewis <jrl@ast.cam.ac.uk>