The hawki_step_detect_obj recipe

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

cpl.Recipe("hawki_step_detect_obj")

Create an object for the recipe hawki_step_detect_obj.

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

Parameters

hawki_step_detect_obj.param.median_smooth

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

hawki_step_detect_obj.param.detect_sigma

detection level (float; default: 7.0) [default=7.0].

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})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to ESO Pipeline Group. Alternatively, you may send a report to the ESO User Support Department.