jammy (7) hawki_step_detect_obj.7.gz

Provided by: cpl-plugin-hawki-doc_2.4.9+dfsg-1build1_all bug

NAME

       hawki_step_detect_obj - (OBSOLETE) Object detection recipe

SYNOPSIS

       esorex hawki_step_detect_obj [OPTIONS] FILE.sof

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

OPTIONS

       --median_smooth <int>
              box size for a median smoothing of the image before the detection (int; default: 3). The full name
              of  this  option  for  the  EsoRex configuration file is hawki.hawki_step_detect_obj.median_smooth
              [default = 3].

       --detect_sigma <float>
              detection level (float; default: 7.0). The full name of this option for the  EsoRex  configuration
              file is hawki.hawki_step_detect_obj.detect_sigma [default = 7.0].

       --growing_radius <int>
              radius  of  convolution kernel to apply to objects (int; default: 5). The full name of this option
              for the EsoRex configuration file is hawki.hawki_step_detect_obj.growing_radius [default = 5].

       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 hawki pipeline can be downloaded as a PDF file using the following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-2.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   hawki   pipeline   are   hawki_cal_dark(7),   hawki_cal_distortion(7),
       hawki_cal_flat(7),       hawki_cal_zpoint(7),       hawki_dark_combine(7),       hawki_detector_noise(7),
       hawki_linearity_analyse(7),  hawki_sci_jitter(7), hawki_science_postprocess(7), hawki_science_process(7),
       hawki_standard_process(7),  hawki_step_apply_dist(7),  hawki_step_basic_calib(7),  hawki_step_combine(7),
       hawki_step_compute_bkg(7), hawki_step_photom_2mass(7), hawki_step_refine_offsets(7), hawki_step_stats(7),
       hawki_step_stitch(7), hawki_step_subtract_bkg(7),  hawki_tec_filtchk(7),  hawki_twilight_flat_combine(7),
       hawki_util_gendist(7), hawki_util_stdstars(7)

VERSION

       hawki_step_detect_obj 2.4.9

AUTHOR

       ESO Pipeline Group <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 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