The muse_scipost_combine_pixtables recipe
===============================================================

.. data:: muse_scipost_combine_pixtables

Synopsis
--------

Combine MUSE pixel tables, either from different IFUs, or from different exposures, or both.

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

Sort pixel tables by exposure and combine them with applied weights into one big pixel table. This is a task separated from muse_scipost.


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

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

   Create an object for the recipe muse_scipost_combine_pixtables.

::

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

Parameters
----------

.. py:attribute:: muse_scipost_combine_pixtables.param.lambdamin

    Cut off the data below this wavelength after loading the pixel  table(s). (float; default: 4000.0) [default=4000.0].
.. py:attribute:: muse_scipost_combine_pixtables.param.lambdamax

    Cut off the data above this wavelength after loading the pixel  table(s). (float; default: 10000.0) [default=10000.0].
.. py:attribute:: muse_scipost_combine_pixtables.param.weight

    Type of weighting scheme to use when combining multiple exposures.  "exptime" just uses the exposure time to weight the exposures, "fwhm"  uses the DIMM information in the header as well, "none" preserves an  existing weight column in the input pixel tables without changes.  (str; default: 'exptime') [default="exptime"].


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

::

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

   muse_scipost_combine_pixtables.param.lambdamin = 4000.0
   muse_scipost_combine_pixtables.param.lambdamax = 10000.0
   muse_scipost_combine_pixtables.param.weight = "exptime"


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

::

   import cpl
   muse_scipost_combine_pixtables = cpl.Recipe("muse_scipost_combine_pixtables")
   [...]
   res = muse_scipost_combine_pixtables( ..., param = {"lambdamin":4000.0, "lambdamax":10000.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 `Ole Streicher <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:: Ole Streicher <https://support.eso.org>
