The hawki_cal_zpoint recipe
===============================================================

.. data:: hawki_cal_zpoint

Synopsis
--------

(OBSOLETE) Zero point computation recipe

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

(OBSOLETE) hawki_cal_zpoint -- Zero point recipe
The input of the recipe files listed in the Set Of Frames (sof-file)
must be tagged as:
raw-file.fits ZPOINT or
stdstars-file.fits STDSTARS_CATS or
flat-file.fits FLAT_IM or
bpm-file.fits BPM
The recipe creates as an output:
hawki_cal_zpoint.fits (ZPOINT_RES): Zero point solution table
hawki_cal_zpoint_check.fits (ZPOINT_IMA): Standard star images corrected (for checking purposes)
hawki_cal_zpoint_stats.fits (ZPOINT_STATS): Statistics of the raw standard star images
Return code:
esorex exits with an error code of 0 if the recipe completes successfully
or 1 otherwise

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

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

   Create an object for the recipe hawki_cal_zpoint.

::

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

Parameters
----------

.. py:attribute:: hawki_cal_zpoint.param.detect_sigma

    the sigma value for object detection (float; default: 7.0) [default=7.0].
.. py:attribute:: hawki_cal_zpoint.param.star_r

    the star radius (float; default: -1.0) [default=-1.0].
.. py:attribute:: hawki_cal_zpoint.param.bg_r1

    the internal background radius (float; default: -1.0) [default=-1.0].
.. py:attribute:: hawki_cal_zpoint.param.bg_r2

    the external background radius (float; default: -1.0) [default=-1.0].
.. py:attribute:: hawki_cal_zpoint.param.ra

    RA in degrees (float; default: 999.0) [default=999.0].
.. py:attribute:: hawki_cal_zpoint.param.dec

    DEC in degrees (float; default: 999.0) [default=999.0].
.. py:attribute:: hawki_cal_zpoint.param.mag

    magnitude (float; default: 99.0) [default=99.0].
.. py:attribute:: hawki_cal_zpoint.param.sx

    x half-size of the search box (int; default: 100) [default=100].
.. py:attribute:: hawki_cal_zpoint.param.sy

    y half-size of the search box (int; default: 100) [default=100].
.. py:attribute:: hawki_cal_zpoint.param.xcoord

    Coordinates in X where the standard star is located. If -1 use WCS  (str; default: '-1., -1., -1., -1.') [default="-1., -1., -1., -1."].
.. py:attribute:: hawki_cal_zpoint.param.ycoord

    Coordinates in Y where the standard star is located. If -1 use WCS  (str; default: '-1., -1., -1., -1.') [default="-1., -1., -1., -1."].


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

::

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

   hawki_cal_zpoint.param.detect_sigma = 7.0
   hawki_cal_zpoint.param.star_r = -1.0
   hawki_cal_zpoint.param.bg_r1 = -1.0
   hawki_cal_zpoint.param.bg_r2 = -1.0
   hawki_cal_zpoint.param.ra = 999.0
   hawki_cal_zpoint.param.dec = 999.0
   hawki_cal_zpoint.param.mag = 99.0
   hawki_cal_zpoint.param.sx = 100
   hawki_cal_zpoint.param.sy = 100
   hawki_cal_zpoint.param.xcoord = "-1., -1., -1., -1."
   hawki_cal_zpoint.param.ycoord = "-1., -1., -1., -1."


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

::

   import cpl
   hawki_cal_zpoint = cpl.Recipe("hawki_cal_zpoint")
   [...]
   res = hawki_cal_zpoint( ..., param = {"detect_sigma":7.0, "star_r":-1.0})


.. 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 Pipeline Group <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:: ESO Pipeline Group <https://support.eso.org>