The naco_spc_lampflat recipe
===============================================================

.. data:: naco_spc_lampflat

Synopsis
--------

Spectrocopic flat recipe using a lamp

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

naco_spc_lampflat -- NACO spectrocopy flat-field creation from lamp images.

The files listed in the Set Of Frames (sof-file) must be tagged:
NACO-raw-file.fits CAL_FLAT_SPEC

The input frames are split into groups with identical values of 'ESO DET DIT', 'ESO INS OPTI1 ID', 'ESO INS CWLEN' and 'ESO SEQ SPECMODE'.


Furthermore, the input set of frames must have values of the FITS key ESO INS LAMP2 SET that of zero for off-frames and non-zero for on-frames.


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

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

   Create an object for the recipe naco_spc_lampflat.

::

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

Parameters
----------

.. py:attribute:: naco_spc_lampflat.param.r

    Rejected left right bottom and top border [pixel] (str; default: '200  200 200 200') [default="200 200 200 200"].
.. py:attribute:: naco_spc_lampflat.param.hot_t

    Hot pixel map threshold (float; default: 10.0) [default=10.0].
.. py:attribute:: naco_spc_lampflat.param.cold_t

    Cold pixel map threshold (float; default: 6.0) [default=6.0].


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

::

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

   naco_spc_lampflat.param.r = "200 200 200 200"
   naco_spc_lampflat.param.hot_t = 10.0
   naco_spc_lampflat.param.cold_t = 6.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_spc_lampflat = cpl.Recipe("naco_spc_lampflat")
   [...]
   res = naco_spc_lampflat( ..., param = {"r":"200 200 200 200", "hot_t":10.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>