The sinfo_utl_spectrum_wavelength_shift recipe
===============================================================

.. data:: sinfo_utl_spectrum_wavelength_shift

Synopsis
--------

Spectrum wavelength shift

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

This recipe shifts a spectrum in wavelength using a given 
interpolation method. The input file is a spectrum.

Its associated tag should be SPECTRUM.

The output is a spectrum shifted by a given amount. 
Parameters are 
sinfoni.sinfo_utl_spectrum_arith.method
sinfoni.sinfo_utl_spectrum_wavelength_shift.shift
having aliases 'method' and 'shift' 


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

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

   Create an object for the recipe sinfo_utl_spectrum_wavelength_shift.

::

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

Parameters
----------

.. py:attribute:: sinfo_utl_spectrum_wavelength_shift.param.method

    A spectral shift method: 'S' (Spline),'P' (Polynomial) (str; default:  'S') [default="S"].
.. py:attribute:: sinfo_utl_spectrum_wavelength_shift.param.shift

    wavelength shift in micron (float; default: 0.1) [default=0.1].


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

::

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

   sinfo_utl_spectrum_wavelength_shift.param.method = "S"
   sinfo_utl_spectrum_wavelength_shift.param.shift = 0.1


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

::

   import cpl
   sinfo_utl_spectrum_wavelength_shift = cpl.Recipe("sinfo_utl_spectrum_wavelength_shift")
   [...]
   res = sinfo_utl_spectrum_wavelength_shift( ..., param = {"method":"S", "shift":0.1})


.. 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 `Andrea Modigliani <Andrea.Modigliani@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 SINFONI Instrument Pipeline
Copyright (C) 2002,2003 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., 59 Temple Place, Suite 330, Boston, 
MA  02111-1307  USA

.. codeauthor:: Andrea Modigliani <Andrea.Modigliani@eso.org>
