The hawki_util_gendist recipe
===============================================================

.. data:: hawki_util_gendist

Synopsis
--------

(OBSOLETE) Distortion map creation

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

(OBSOLETE) hawki_util_gendist -- HAWK-I distortion calibration file creation.

The 4 files (chip 1 2 3 4) listed in the Set Of Frames (sof-file) 
must be tagged:
raw-file_chip1.txt DIST_MAP
raw-file_chip2.txt DIST_MAP
raw-file_chip3.txt DIST_MAP
raw-file_chip4.txt DIST_MAP

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

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

   Create an object for the recipe hawki_util_gendist.

::

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

Parameters
----------

.. py:attribute:: hawki_util_gendist.param.dim_x

    Dimension of distortion image in X (int; default: 2048) [default=2048].
.. py:attribute:: hawki_util_gendist.param.dim_y

    Dimension of distortion image in Y (int; default: 2048) [default=2048].


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

::

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

   hawki_util_gendist.param.dim_x = 2048
   hawki_util_gendist.param.dim_y = 2048


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

::

   import cpl
   hawki_util_gendist = cpl.Recipe("hawki_util_gendist")
   [...]
   res = hawki_util_gendist( ..., param = {"dim_x":2048, "dim_y":2048})


.. 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 `Yves Jung <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 HAWKI Instrument Pipeline
Copyright (C) 2002,2011 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., 51 Franklin Street, Fifth Floor, Boston, 
MA 02110-1301 USA

.. codeauthor:: Yves Jung <https://support.eso.org>