The naco_img_zpoint recipe
===============================================================

.. data:: naco_img_zpoint

Synopsis
--------

Zero point computation recipe

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

naco_img_zpoint -- Zero point recipe
The files listed in the Set Of Frames (sof-file) must be tagged:
NACO-raw-file.fits CAL_STD_CHOP or
NACO-raw-file.fits CAL_STD_JITTER.

NACO-Imaging-Standard-Star-Catalog.fits IMG_STD_CATALOG
Optionally, a flat field frame may be inluded:
NACO-flat-file.fits MASTER_IMG_FLAT

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

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

   Create an object for the recipe naco_img_zpoint.

::

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

Parameters
----------

.. py:attribute:: naco_img_zpoint.param.star_r

    The star radius [arcsecond] (float; default: 2.0) [default=2.0].
.. py:attribute:: naco_img_zpoint.param.bg_r1

    The internal radius of the background [arcsecond] (float; default:  2.0) [default=2.0].
.. py:attribute:: naco_img_zpoint.param.bg_r2

    The external radius of the background [arcsecond] (float; default:  3.0) [default=3.0].
.. py:attribute:: naco_img_zpoint.param.ra

    Right Ascension [Degrees] (float; default: 999.0) [default=999.0].
.. py:attribute:: naco_img_zpoint.param.dec

    DEClination  [Degrees] (float; default: 999.0) [default=999.0].
.. py:attribute:: naco_img_zpoint.param.pscale

    Pixel scale (float; default: -1.0) [default=-1.0].
.. py:attribute:: naco_img_zpoint.param.mag

    Magnitude (float; default: 99.0) [default=99.0].
.. py:attribute:: naco_img_zpoint.param.sx

    Size of the search window in X-direction [pixel] (int; default: 10) [default=10].
.. py:attribute:: naco_img_zpoint.param.sy

    Size of the search window in Y-direction [pixel] (int; default: 10) [default=10].
.. py:attribute:: naco_img_zpoint.param.check_im

    Create the check image (bool; default: False) [default=False].


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

::

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

   naco_img_zpoint.param.star_r = 2.0
   naco_img_zpoint.param.bg_r1 = 2.0
   naco_img_zpoint.param.bg_r2 = 3.0
   naco_img_zpoint.param.ra = 999.0
   naco_img_zpoint.param.dec = 999.0
   naco_img_zpoint.param.pscale = -1.0
   naco_img_zpoint.param.mag = 99.0
   naco_img_zpoint.param.sx = 10
   naco_img_zpoint.param.sy = 10
   naco_img_zpoint.param.check_im = False


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

::

   import cpl
   naco_img_zpoint = cpl.Recipe("naco_img_zpoint")
   [...]
   res = naco_img_zpoint( ..., param = {"star_r":2.0, "bg_r1":2.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 `Lars Lundin <usd-help@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 NACO Instrument Pipeline
Copyright (C) 2002, 2003, 2005, 2008 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 St, Fifth Floor, Boston, 
MA  02111-1307  USA

.. codeauthor:: Lars Lundin <usd-help@eso.org>