The uves_utl_remove_crh_single recipe
===============================================================

.. data:: uves_utl_remove_crh_single

Synopsis
--------

Remove CRHs from an image

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

This recipe performs image computation.

The input files is one image
their associated tags should be IMA.

The output is the image cleaned from CRHs
Information on relevant parameters can be found with
esorex --params uves_utl_remove_crh_single
esorex --help uves_utl_remove_crh_single


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

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

   Create an object for the recipe uves_utl_remove_crh_single.

::

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

Parameters
----------

.. py:attribute:: uves_utl_remove_crh_single.param.crh_frac_max

    Maximum fraction of allowed CRHs (float; default: 0.7) [default=0.7].
.. py:attribute:: uves_utl_remove_crh_single.param.f_lim

    Max fraction of bad pixels allowed (float; default: 0.7) [default=0.7].
.. py:attribute:: uves_utl_remove_crh_single.param.gain

    Detector's gain (float; default: 2.42) [default=2.42].
.. py:attribute:: uves_utl_remove_crh_single.param.max_iter

    Max fraction of bad pixels allowed (int; default: 5) [default=5].
.. py:attribute:: uves_utl_remove_crh_single.param.ron

    Detector's ron (float; default: 1.0) [default=1.0].
.. py:attribute:: uves_utl_remove_crh_single.param.sigma_lim

    Maximum sigma in kappa-sigma clip (float; default: 25.0) [default=25.0].


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

::

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

   uves_utl_remove_crh_single.param.crh_frac_max = 0.7
   uves_utl_remove_crh_single.param.f_lim = 0.7
   uves_utl_remove_crh_single.param.gain = 2.42
   uves_utl_remove_crh_single.param.max_iter = 5
   uves_utl_remove_crh_single.param.ron = 1.0
   uves_utl_remove_crh_single.param.sigma_lim = 25.0


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

::

   import cpl
   uves_utl_remove_crh_single = cpl.Recipe("uves_utl_remove_crh_single")
   [...]
   res = uves_utl_remove_crh_single( ..., param = {"crh_frac_max":0.7, "f_lim":0.7})


.. 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 `Andrea Modigliani <Andrea.Modigliani@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 ESO UVES Instrument Pipeline
Copyright (C) 2004,2005,2006 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, 51 Franklin St, Fifth Floor, Boston, 
MA  02111-1307  USA

.. codeauthor:: Andrea Modigliani <Andrea.Modigliani@eso.org>