The uves_cal_mflat_combine recipe
===============================================================

.. data:: uves_cal_mflat_combine

Synopsis
--------

Combines the master flat field and the master dflat frames

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

This recipe combined a MASTER_FLAT_xxxx with a MASTER_DFLAT_xxxx
Input are:

a master flat (MASTER_FLAT_xxxx)
a master dflat (MASTER_DFLAT_xxxx)
an order table (ORDER_TABLE_xxxx)
provided for each chip (xxxx = BLUE, REDL, REDU). 
Output is a MASTER_FLAT_xxxx

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

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

   Create an object for the recipe uves_cal_mflat_combine.

::

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

Parameters
----------

.. py:attribute:: uves_cal_mflat_combine.param.debug

    Whether or not to save intermediate results to local directory (bool;  default: False) [default=False].
.. py:attribute:: uves_cal_mflat_combine.param.order_threshold

    Order where master flats are joined  (int; default: 7) [default=7].
.. py:attribute:: uves_cal_mflat_combine.param.plotter

    Any plots produced by the recipe are redirected to the command  specified by this parameter. The plotting command must contain the  substring 'gnuplot' and must be able to parse gnuplot syntax on its  standard input. Valid examples of such a command may include 'gnuplot  -persist' and 'cat > mygnuplot$$.gp'. A finer control of the plotting  options can be obtained by writing an executable script, e.g.  my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot  options (e.g. set terminal pslatex color). To turn off plotting, set  this parameter to 'no' (str; default: 'no') [default="no"].
.. py:attribute:: uves_cal_mflat_combine.param.process_chip

    For RED arm data process the redl, redu, or both chip(s) (str;  default: 'both') [default="both"].


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

::

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

   uves_cal_mflat_combine.param.debug = False
   uves_cal_mflat_combine.param.order_threshold = 7
   uves_cal_mflat_combine.param.plotter = "no"
   uves_cal_mflat_combine.param.process_chip = "both"


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

::

   import cpl
   uves_cal_mflat_combine = cpl.Recipe("uves_cal_mflat_combine")
   [...]
   res = uves_cal_mflat_combine( ..., param = {"debug":False, "order_threshold":7})


.. 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 `Andrea Modigliani <cpl@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 FLAMES/UVES Pipeline
Copyright (C) 2004, 2005, 2006, 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:: Andrea Modigliani <cpl@eso.org>