The muse_qi_mask recipe
===============================================================

.. data:: muse_qi_mask

Synopsis
--------

Create image masks for use with the quick image reconstruction.

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

Trace and wavelength calibration tables (24 of them each, one per IFU) are used to build wavelength maps. If the input data is binned, the wavelength maps are binned in the same way (averaging of pixels). The wavelength maps are then thresholded to create masks of the desired wavelength range. Finally, the mask is "untrimmed", i.e. empty regions for the pre- and overscans are added (in a simple way, assuming quadrants of equal size, and padding of 32 pixels on all quadrant edges). Note: this recipe is not part of the main MUSE pipeline but to be used in the integration phase to create image masks until the system is fully qualified. It therefore does only minimal error checking.


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

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

   Create an object for the recipe muse_qi_mask.

::

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

Parameters
----------

.. py:attribute:: muse_qi_mask.param.nifu

    IFU to handle. If set to 0, all IFUs are processed serially, which is  the recommendation for this recipe, since only then all extensions end  up in the same output file. (int; default: 0) [default=0].


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

::

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

   muse_qi_mask.param.nifu = 0


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

::

   import cpl
   muse_qi_mask = cpl.Recipe("muse_qi_mask")
   [...]
   res = muse_qi_mask( ..., param = {"nifu":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 `Peter Weilbacher <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 MUSE Instrument Pipeline
Copyright (C) 2005, 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., 51 Franklin St, Fifth Floor, Boston, 
MA  02111-1307  USA

.. codeauthor:: Peter Weilbacher <https://support.eso.org>