The hawki_linearity_analyse recipe
===============================================================

.. data:: hawki_linearity_analyse

Synopsis
--------

HAWKI linearity recipe

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

hawki_linearity_analyse -- HAWKI detector linearity recipe.


Check the linearity of the HAWKI detectors on a pixel by pixel basis
The program accepts the following files in the SOF:

    Tag                   Description
    DARK_DETCHECK         A list of dark images 
    FLAT_LAMP_DETCHECK    A list of dome flat images
All of the above are required. The should be a dark frame for each DIT/NDITcombination used for the dome flats


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

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

   Create an object for the recipe hawki_linearity_analyse.

::

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

Parameters
----------

.. py:attribute:: hawki_linearity_analyse.param.order

    Polynomial order to fit (int; default: 3) [default=3].
.. py:attribute:: hawki_linearity_analyse.param.fitzero

    Fit zeroth order term? (bool; default: False) [default=False].
.. py:attribute:: hawki_linearity_analyse.param.rchithr

    Maximum allowable value of reduced chisq? (float; default: 5.0) [default=5.0].
.. py:attribute:: hawki_linearity_analyse.param.satlim

    Saturation limit? (float; default: 65535.0) [default=65535.0].
.. py:attribute:: hawki_linearity_analyse.param.reflev

    Reference flux level for NL check (float; default: 10000.0) [default=10000.0].


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

::

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

   hawki_linearity_analyse.param.order = 3
   hawki_linearity_analyse.param.fitzero = False
   hawki_linearity_analyse.param.rchithr = 5.0
   hawki_linearity_analyse.param.satlim = 65535.0
   hawki_linearity_analyse.param.reflev = 10000.0


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

::

   import cpl
   hawki_linearity_analyse = cpl.Recipe("hawki_linearity_analyse")
   [...]
   res = hawki_linearity_analyse( ..., param = {"order":3, "fitzero":False})


.. 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 `Jim Lewis <jrl@ast.cam.ac.uk>`_. 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) 2015 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., 59 Temple Place, Suite 330, Boston, 
MA  02111-1307  USA

.. codeauthor:: Jim Lewis <jrl@ast.cam.ac.uk>