The vmifucombinecube recipe
===============================================================

.. data:: vmifucombinecube

Synopsis
--------

Rearrange into cube format images of extracted spectraproduced by vmifucalib, vmifuscience, and vmifustandard.

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

This recipe is used to rearrange into a single cube the images of
extracted spectra from different VIMOS quadrants. Such images are
created by the recipes vmifucalib, vmifuscience, and vmifustandard,
and the classification tag of the product depends on the classification
tag of the inputs:

         Input                         Output

   IFU_ARC_SPECTRUM_EXTRACTED    IFU_ARC_SPECTRUM_CUBE
   IFU_FLAT_SPECTRUM_EXTRACTED   IFU_FLAT_SPECTRUM_CUBE
   IFU_SCIENCE_REDUCED           IFU_SCIENCE_CUBE
   IFU_SCIENCE_FLUX_REDUCED      IFU_SCIENCE_FLUX_CUBE
   IFU_STANDARD_REDUCED          IFU_STANDARD_CUBE

The input images must belong to different quadrants, so that they
cannot be more than 4. The allocated cubes are the smallest possible,
depending on the number of quadrants involved and on whether the IFU
shutter was on or off. The smallest cubes (20x20xN) are produced when
just one quadrant is input and the shutter was on. The largest cubes
(80x80xN) are produced when 3 or more quadrants are given in input
(and when either quadrants 1 and 3, or 2 and 4, are input), and the
shutter was off. Pixels belonging to missing quadrants are padded
with zeroes if necessary.



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

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

   Create an object for the recipe vmifucombinecube.

::

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



.. 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 `ESO VIMOS Pipeline Team and VIMOS Consortium <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 VIMOS Instrument Pipeline
Copyright (C) 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., 59 Temple Place, Suite 330, Boston, 
MA  02111-1307  USA

.. codeauthor:: ESO VIMOS Pipeline Team and VIMOS Consortium <https://support.eso.org>
