oracular (7) fors_detect_objects.7.gz

Provided by: cpl-plugin-fors-doc_5.5.7+dfsg-2build2_all bug

NAME

       fors_detect_objects - Detect objects in slit spectra

SYNOPSIS

       esorex fors_detect_objects [OPTIONS] FILE.sof

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

OPTIONS

       --slit_margin <int>
              Number of pixels to exclude at each slit in object detection and  extraction  (int;
              default:  3).  The  full  name  of this option for the EsoRex configuration file is
              fors.fors_detect_objects.slit_margin [default = 3].

       --ext_radius <int>
              Maximum extraction radius for detected objects (pixel) (int; default: 6). The  full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              fors.fors_detect_objects.ext_radius [default = 6].

       --cont_radius <int>
              Minimum distance at which two objects of equal luminosity do not  contaminate  each
              other  (pixel)  (int;  default:  0).  The  full  name of this option for the EsoRex
              configuration file is fors.fors_detect_objects.cont_radius [default = 0].

       Note that it is possible to create a configuration file containing  these  options,  along
       with  suitable default values. Please refer to the details provided by the 'esorex --help'
       command.

SEE ALSO

       The full documentation for the fors pipeline can be downloaded as a  PDF  file  using  the
       following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf

       An   overview   over   the   existing   ESO  pipelines  can  be  found  on  the  web  page
       https://www.eso.org/sci/software/pipelines/.

       Basic documentation about the EsoRex program can be found at the esorex (1) man page.

       It is possible to call the pipelines  from  python  using  the  python-cpl  package.   See
       https://packages.python.org/python-cpl/index.html for further information.

       The  other  recipes  of  the  fors  pipeline are fors_align_sky(7), fors_align_sky_lss(7),
       fors_bias(7),   fors_calib(7),   fors_config(7),   fors_dark(7),   fors_detect_spectra(7),
       fors_extract(7),    fors_extract_objects(7),   fors_extract_slits(7),   fors_flatfield(7),
       fors_img_science(7),            fors_img_screen_flat(7),             fors_img_sky_flat(7),
       fors_normalise_flat(7),   fors_photometry(7),   fors_pmos_calib(7),  fors_pmos_extract(7),
       fors_pmos_science(7),     fors_remove_bias(7),     fors_resample(7),      fors_science(7),
       fors_spec_mflat(7),   fors_subtract_sky(7),   fors_subtract_sky_lss(7),   fors_sumflux(7),
       fors_trace_flat(7), fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7)

VERSION

       fors_detect_objects 5.5.7

AUTHOR

       Carlo Izzo <usd-help@eso.org>

BUG REPORTS

       Please report any problems to usd-help@eso.org. Alternatively, you may send  a  report  to
       the ESO User Support Department <usd-help@eso.org>.

LICENSE

       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