NAME

visir_util_clip - Kappa-sigma clipping of outliers for each pixel

SYNOPSIS

esorex visir_util_clip [OPTIONS] FILE.sof

DESCRIPTION

The files listed in the Set Of Frames (sof-file) must be tagged pair-wise: VISIR-raw-file.fits RAW VISIR-bpm-file.fits BPM

The product(s) will have a FITS card ´HIERARCH ESO PRO CATG´ with a value of: BPM The outliers are marked as rejected in the matching bad pixel map.

OPTIONS

--keepfrac <float>

The fraction of pixels to keep for the initialmedian (float; default: 0.9). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.keepfrac [default = 0.9].

--kappa <float>

Clip outside + or - kappa * sigma (the standard deviation) (float; default: 5.0). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.kappa [default = 5.0].

--maxite <int>

Max number of kappa-sigma clipping iterations (int; default: 3). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.maxite [default = 3].

--shift-beams <bool>

Account for movements of the object defined in CRPIX[12] (bool; default: True). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.shift-beams [default = True].

--error-source <str>

Defines the way errors are generated: img-stdev: stdev of image timeseries: stdev of each pixel over the time axis of the cube none: no error generation (str; default: ´img-stdev´). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.error-source [default = img-stdev].

--error-out-type <str>

Output clipped error as error, variance, weight or none (str; default: ´error´). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.error-out-type [default = error].

--badimage <float>

If percentage of clipped pixels above this value the whole image is considered bad (float; default: 0.2). The full name of this option for the EsoRex configuration file is visir.visir_util_clip.badimage [default = 0.2].

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

ftp://ftp.eso.org/pub/dfs/pipelines/visir/visir-pipeline-manual-1.4.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 visir pipeline are visir_img_dark(7), visir_img_ff(7), visir_img_reduce(7), visir_img_trans(7), visir_old_img_combine(7), visir_old_img_phot(7), visir_old_spc_obs(7), visir_old_spc_obs_ech(7), visir_old_spc_phot(7), visir_old_spc_phot_ech(7), visir_old_spc_wcal(7), visir_old_spc_wcal_ech(7), visir_old_util_destripe(7), visir_spc_reduce(7), visir_util_apply_calib(7), visir_util_convert_weight(7), visir_util_detect_shift(7), visir_util_img_std_cat(7), visir_util_join(7), visir_util_qc(7), visir_util_repack(7), visir_util_run_swarp(7), visir_util_spc_std_cat(7), visir_util_spc_txt2fits(7), visir_util_undistort(7)

VERSION

visir_util_clip 4.4.2

AUTHOR

Lars Lundin <https://support.eso.org>

BUG REPORTS

Please report any problems to https://support.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 VISIR Instrument Pipeline Copyright (C) 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 St, Fifth Floor, Boston, MA 02111-1307 USA