The naco_img_strehl recipe
===============================================================

.. data:: naco_img_strehl

Synopsis
--------

Strehl computation recipe

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

naco_img_strehl -- NACO Strehl Ratio recipe.

This recipe estimates the strehl ratio and its error bound.

The Set Of Frames (sof-file) must specify at least one pair of files and they must be tagged either
NACO-raw-file.fits CAL_PSF or
NACO-raw-file.fits TECH_PSF

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

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

   Create an object for the recipe naco_img_strehl.

::

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

Parameters
----------

.. py:attribute:: naco_img_strehl.param.star_r

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

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

    The external radius of the background [arcsecond] (float; default:  3.0) [default=3.0].


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

::

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

   naco_img_strehl.param.star_r = 2.0
   naco_img_strehl.param.bg_r1 = 2.0
   naco_img_strehl.param.bg_r2 = 3.0


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_strehl = cpl.Recipe("naco_img_strehl")
   [...]
   res = naco_img_strehl( ..., 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>