The gimasterbias recipe
===============================================================

.. data:: gimasterbias

Synopsis
--------

Creates a master bias image from a set of raw biases.

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

For detailed information please refer to the GIRAFFE pipeline user manual.

It is available at http://www.eso.org/pipelines.


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

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

   Create an object for the recipe gimasterbias.

::

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

Parameters
----------

.. py:attribute:: gimasterbias.param.stack_method

    Stacking method: average, median, minmax or ksigma (str; default:  'average') [default="average"].
.. py:attribute:: gimasterbias.param.stack_ksigmalow

    Lower threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].
.. py:attribute:: gimasterbias.param.stack_ksigmahigh

    Upper threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].
.. py:attribute:: gimasterbias.param.stack_minreject

    Minimum rejection level for method minmax (int; default: 1) [default=1].
.. py:attribute:: gimasterbias.param.stack_maxreject

    Maximum rejection level for method minmax (int; default: 1) [default=1].
.. py:attribute:: gimasterbias.param.mbias_oscremove

    Remove pre- and over-scan regions from the created master bias image.  (bool; default: False) [default=False].
.. py:attribute:: gimasterbias.param.mbias_bpxclean

    Correct master bias image for bad pixels (bool; default: False) [default=False].
.. py:attribute:: gimasterbias.param.bpm_create

    Create bad pixel map using a simple thresholding algorithm.  (temporary!) (bool; default: True) [default=True].
.. py:attribute:: gimasterbias.param.bpm_factor

    Readout noise multiplier defining the valid range of pixel values for  searching bad pixels. (float; default: 5.0) [default=5.0].
.. py:attribute:: gimasterbias.param.bpm_frac

    Maximum fraction of pixels which may be flagged as 'bad. If more  pixels are found to be 'bad a warning is issued. (float; default:  0.15) [default=0.15].


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

::

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

   gimasterbias.param.stack_method = "average"
   gimasterbias.param.stack_ksigmalow = 5.0
   gimasterbias.param.stack_ksigmahigh = 5.0
   gimasterbias.param.stack_minreject = 1
   gimasterbias.param.stack_maxreject = 1
   gimasterbias.param.mbias_oscremove = False
   gimasterbias.param.mbias_bpxclean = False
   gimasterbias.param.bpm_create = True
   gimasterbias.param.bpm_factor = 5.0
   gimasterbias.param.bpm_frac = 0.15


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

::

   import cpl
   gimasterbias = cpl.Recipe("gimasterbias")
   [...]
   res = gimasterbias( ..., param = {"stack_method":"average", "stack_ksigmalow":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 `Giraffe Pipeline <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 GIRAFFE Instrument Pipeline
 Copyright (C) 2002-2014 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  02110-1301  USA

.. codeauthor:: Giraffe Pipeline <https://support.eso.org/>