The uves_cal_mbias recipe
===============================================================

.. data:: uves_cal_mbias

Synopsis
--------

Creates the master bias frame

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

This recipe creates a master bias frame by computing the median of all input
bias frames. All input frames must have same tag and size and must be either
BIAS_BLUE or BIAS_RED.

On blue input the recipe computes one master bias frame; on red input a 
master bias frame for each chip is produced. The average, standard deviation
and median of the master bias image(s) are written to the FITS header(s)

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

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

   Create an object for the recipe uves_cal_mbias.

::

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

Parameters
----------

.. py:attribute:: uves_cal_mbias.param.debug

    Whether or not to save intermediate results to local directory (bool;  default: False) [default=False].
.. py:attribute:: uves_cal_mbias.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_mbias.param.process_chip

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

    Clean detector traps. If TRUE detector traps are interpolated.The bad  pixels are replaced by the average of thenearest good pixels in the  same column, or simply marked as bad. The positions of bad pixels are  hard-coded (as function of UVES chip). (bool; default: False) [default=False].
.. py:attribute:: uves_cal_mbias.param.stack_method

    Method used to build master frame  (str; default: 'median') [default="median"].
.. py:attribute:: uves_cal_mbias.param.klow

    Kappa used to clip low level values, when method is set to 'mean'  (float; default: 5.0) [default=5.0].
.. py:attribute:: uves_cal_mbias.param.khigh

    Kappa used to clip high level values, when method is set to 'mean'  (float; default: 5.0) [default=5.0].
.. py:attribute:: uves_cal_mbias.param.niter

    Number of kappa sigma iterations, when method is set to 'mean'  (long;  default: 5) [default=5].


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

::

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

   uves_cal_mbias.param.debug = False
   uves_cal_mbias.param.plotter = "no"
   uves_cal_mbias.param.process_chip = "both"
   uves_cal_mbias.param.clean_traps = False
   uves_cal_mbias.param.stack_method = "median"
   uves_cal_mbias.param.klow = 5.0
   uves_cal_mbias.param.khigh = 5.0
   uves_cal_mbias.param.niter = 5


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_mbias = cpl.Recipe("uves_cal_mbias")
   [...]
   res = uves_cal_mbias( ..., param = {"debug":False, "plotter":"no"})


.. 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 `Jonas M. Larsen <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:: Jonas M. Larsen <cpl@eso.org>
