The sinfo_utl_cube_create recipe
===============================================================

.. data:: sinfo_utl_cube_create

Synopsis
--------

Generate a cube

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

This recipe perform cubes creation.

The input files are:
A raw frame on tagged as RAW_ON
[optional] A raw frame off RAW_OFF
A wavelength map, tagged as WAVE_MAP
A wavelength map, tagged as WAVE_MAP
A distortion table, tagged as DISTORTION
A slitlets position table, tagged as SLIT_POS


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

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

   Create an object for the recipe sinfo_utl_cube_create.

::

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

Parameters
----------

.. py:attribute:: sinfo_utl_cube_create.param.objnod_jit_ind

    jitter mode indicator: TRUE: Auto-Jitter, FALSE: user defined jitter.  The size_x size_y kernel_type parameters are only used if jitterInd is  set to yes, that means in auto-jittering mode. (bool; default: True) [default=True].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_kernel_typ

    Kernel Type:the name of the interpolation kernel to shift the single  cubes  to the correct places inside the big combined cube (str;  default: 'tanh') [default="tanh"].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_no_coeffs

    number of coefficients for the polynomial interpolation  (long;  default: 3) [default=3].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_ns_ind

    Nord South Index Switch: indicates if the slitlet distances are  determined by a north-south-test (TRUE) or slitlet edge fits (FALSE)  (bool; default: True) [default=True].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_flux_cor

    Flux correction:  (bool; default: False) [default=False].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_fine_tune_mtd

    Fine Tuning Method: indicator for the shifting method to use (P:  polynomial interpolation,  S: cubic spline interpolation) (str;  default: 'P') [default="P"].
.. py:attribute:: sinfo_utl_cube_create.param.objnod_order

    Fine Tuning polynomial order: order of the polynomial if the  polynomial interpolation shifting method is used. (long; default: 2) [default=2].


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

::

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

   sinfo_utl_cube_create.param.objnod_jit_ind = True
   sinfo_utl_cube_create.param.objnod_kernel_typ = "tanh"
   sinfo_utl_cube_create.param.objnod_no_coeffs = 3
   sinfo_utl_cube_create.param.objnod_ns_ind = True
   sinfo_utl_cube_create.param.objnod_flux_cor = False
   sinfo_utl_cube_create.param.objnod_fine_tune_mtd = "P"
   sinfo_utl_cube_create.param.objnod_order = 2


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_create = cpl.Recipe("sinfo_utl_cube_create")
   [...]
   res = sinfo_utl_cube_create( ..., param = {"objnod_jit_ind":True, "objnod_kernel_typ":"tanh"})


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