The fors_detect_objects recipe¶
-
fors_detect_objects
¶
Synopsis¶
Detect objects in slit spectra
Description¶
This recipe is used to detect scientific objects spectra on a resampled image produced with recipe fors_resample. Please refer to the FORS Pipeline User’s Manual for more details on object detection.
In the table below the MXU acronym can be alternatively read as MOS and LSS, and SCI as STD.
Input files¶
DO category: Type: Explanation: Required:
MAPPED_SCI_MXU Calib Resampled slit spectra Y
SLIT_LOCATION_MXU Calib Slit location on image Y
Output files¶
DO category: Data type: Explanation:
OBJECT_TABLE_SCI_MXU FITS table Object positions in slit spectra
Constructor¶
-
cpl.
Recipe
("fors_detect_objects") Create an object for the recipe fors_detect_objects.
import cpl
fors_detect_objects = cpl.Recipe("fors_detect_objects")
Parameters¶
-
fors_detect_objects.param.
slit_margin
¶ Number of pixels to exclude at each slit in object detection and extraction (int; default: 3) [default=3].
-
fors_detect_objects.param.
ext_radius
¶ Maximum extraction radius for detected objects (pixel) (int; default: 6) [default=6].
-
fors_detect_objects.param.
cont_radius
¶ Minimum distance at which two objects of equal luminosity do not contaminate each other (pixel) (int; default: 0) [default=0].
The following code snippet shows the default settings for the available parameters.
import cpl
fors_detect_objects = cpl.Recipe("fors_detect_objects")
fors_detect_objects.param.slit_margin = 3
fors_detect_objects.param.ext_radius = 6
fors_detect_objects.param.cont_radius = 0
You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:
import cpl
fors_detect_objects = cpl.Recipe("fors_detect_objects")
[...]
res = fors_detect_objects( ..., param = {"slit_margin":3, "ext_radius":6})
See also
cpl.Recipe for more information about the recipe object.
Bug reports¶
Please report any problems to Carlo Izzo. Alternatively, you may send a report to the ESO User Support Department.
Copyright¶
This file is currently part of the FORS Instrument Pipeline Copyright (C) 2002-2010 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 02110-1301 USA
Code author: Carlo Izzo <usd-help@eso.org>