The kmo_fits_check recipe
===============================================================

.. data:: kmo_fits_check

Synopsis
--------

Check contents of a KMOS fits-file

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

Recipe to print information on FITS files, contained data/noise values or
header keywords of all extensions of a fits file, preferably a KMOS fits-file
(RAW, F1I, F2I, F3I, F2D etc.). This recipe is intended for debugging purposes
only.

By default a short summary is printed.

The following data types of keywords are recognized: bool, char, double, float,
int, long, string
As input one fits-file is accepted, no output frame is generated.


Input files
^^^^^^^^^^^^
::

   DO                    KMOS                                                  
   category              Type   Explanation                    Required #Frames
   --------              -----  -----------                    -------- -------
   <none or any>         <any>  Any FITS file                      Y       1   

Output files
^^^^^^^^^^^^
::

   DO                    KMOS
   category              Type   Explanation
   --------              -----  -----------
   <none>                <none> No output frames generated, only text output   


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

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

   Create an object for the recipe kmo_fits_check.

::

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

Parameters
----------

.. py:attribute:: kmo_fits_check.param.data

    The extension whose data to print. (0 is the empty primary extension,  -1 prints just all data extensions, by default all headers and data of  all extensions are printed. (long; default: -2) [default=-2].
.. py:attribute:: kmo_fits_check.param.header

    The extension whose header to print(0 is the empty primary extension,  -1 prints just all headers, by default all headers and data of all  extensions are printed. (long; default: -2) [default=-2].


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

::

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

   kmo_fits_check.param.data = -2
   kmo_fits_check.param.header = -2


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

::

   import cpl
   kmo_fits_check = cpl.Recipe("kmo_fits_check")
   [...]
   res = kmo_fits_check( ..., param = {"data":-2, "header":-2})


.. 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 `Alex Agudo Berbel <kmos-spark@mpe.mpg.de>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is part of the KMOS 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, 51 Franklin Street, Suite 500, Boston, MA  02110-1335  USA

.. codeauthor:: Alex Agudo Berbel <kmos-spark@mpe.mpg.de>
