The muse_scipost_correct_rv recipe
===============================================================

.. data:: muse_scipost_correct_rv

Synopsis
--------

Apply RV correction for MUSE pixel tables.

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

Correct the wavelengths in the pixel table by given radial-velocity correction. This is a task separated from muse_scipost.


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

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

   Create an object for the recipe muse_scipost_correct_rv.

::

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

Parameters
----------

.. py:attribute:: muse_scipost_correct_rv.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_correct_rv.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_correct_rv.param.rvcorr

    Correct the radial velocity of the telescope with reference to either  the barycenter of the Solar System (bary), the center of the Sun  (helio), or to the center of the Earth (geo). (str; default: 'bary') [default="bary"].


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

::

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

   muse_scipost_correct_rv.param.lambdamin = 4000.0
   muse_scipost_correct_rv.param.lambdamax = 10000.0
   muse_scipost_correct_rv.param.rvcorr = "bary"


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_correct_rv = cpl.Recipe("muse_scipost_correct_rv")
   [...]
   res = muse_scipost_correct_rv( ..., 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 `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>