The hawki_step_detect_obj recipe
===============================================================

.. data:: hawki_step_detect_obj

Synopsis
--------

(OBSOLETE) Object detection recipe

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

(OBSOLETE) hawki_step_detect_obj -- hawki detect objects recipe.

This recipe detects objects from the combined image creating a mask
and a list of object properties
The input of the recipe files listed in the Set Of Frames (sof-file)
must be tagged as:
combined.fits COMBINED
The recipe creates as an output:
hawki_step_detect_obj_mask.fits (OBJ_MASK): A mask with 1 where the objects are present and 0 elsewhere
hawki_step_detect_obj_stars.fits (OBJ_PARAM): A table with the detected objects characteristics
Return code:
esorex exits with an error code of 0 if the recipe completes successfully
or 1 otherwise

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

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

   Create an object for the recipe hawki_step_detect_obj.

::

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

Parameters
----------

.. py:attribute:: hawki_step_detect_obj.param.median_smooth

    box size for a median smoothing of the image before the detection  (int; default: 3) [default=3].
.. py:attribute:: hawki_step_detect_obj.param.detect_sigma

    detection level (float; default: 7.0) [default=7.0].
.. py:attribute:: hawki_step_detect_obj.param.growing_radius

    radius of convolution kernel to apply to objects (int; default: 5) [default=5].


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

::

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

   hawki_step_detect_obj.param.median_smooth = 3
   hawki_step_detect_obj.param.detect_sigma = 7.0
   hawki_step_detect_obj.param.growing_radius = 5


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

::

   import cpl
   hawki_step_detect_obj = cpl.Recipe("hawki_step_detect_obj")
   [...]
   res = hawki_step_detect_obj( ..., param = {"median_smooth":3, "detect_sigma":7.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 `ESO Pipeline Group <https://support.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 HAWKI Instrument Pipeline
Copyright (C) 2002,2011 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 Street, Fifth Floor, Boston, 
MA 02110-1301 USA

.. codeauthor:: ESO Pipeline Group <https://support.eso.org>