The sinfo_utl_cube_arith recipe
===============================================================

.. data:: sinfo_utl_cube_arith

Synopsis
--------

Cube arithmetics

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

This recipe perform cube arithmetics.

If parameter value is specified the input frame is a cube 
in a sof file with tag CUBE
Else the input files are a cube and an images or a spectrum
their associated tags should be respectively CUBE, IMA or SPECTRUM.

The output is a cube with tag PRO_CUBE resulting from the operation 
CUBE op IMA or 
CUBE op SPECTRUM or
CUBE op value where op indicates
the operation to be performed
Information on relevant parameters can be found with
esorex --params sinfo_utl_cube_arith
esorex --help sinfo_utl_cube_arith


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

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

   Create an object for the recipe sinfo_utl_cube_arith.

::

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

Parameters
----------

.. py:attribute:: sinfo_utl_cube_arith.param.op

    A possible operation: `/','*','+' or `-' (str; default: '/') [default="/"].
.. py:attribute:: sinfo_utl_cube_arith.param.value

    A constant to add (float; default: 99999.0) [default=99999.0].


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

::

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

   sinfo_utl_cube_arith.param.op = "/"
   sinfo_utl_cube_arith.param.value = 99999.0


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_cube_arith = cpl.Recipe("sinfo_utl_cube_arith")
   [...]
   res = sinfo_utl_cube_arith( ..., param = {"op":"/", "value":99999.0})


.. 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>
