.TH VISIR_UTIL_CLIP "7" "4.4.2" "visir_util_clip" "visir recipes" .SH NAME visir_util_clip \- Kappa\-sigma clipping of outliers for each pixel .SH SYNOPSIS esorex .B visir_util_clip [OPTIONS] FILE.sof .SH 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. .SH OPTIONS .TP \fB\-\-keepfrac\fR \fI\fR 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 \fBvisir.visir_util_clip.keepfrac\fR [default = \fI0.9\fR]. .TP \fB\-\-kappa\fR \fI\fR Clip outside + or \- kappa * sigma (the standard deviation) (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBvisir.visir_util_clip.kappa\fR [default = \fI5.0\fR]. .TP \fB\-\-maxite\fR \fI\fR Max number of kappa\-sigma clipping iterations (int; default: 3). The full name of this option for the EsoRex configuration file is \fBvisir.visir_util_clip.maxite\fR [default = \fI3\fR]. .TP \fB\-\-shift\-beams\fR \fI\fR 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 \fBvisir.visir_util_clip.shift\-beams\fR [default = \fITrue\fR]. .TP \fB\-\-error\-source\fR \fI\fR 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 \fBvisir.visir_util_clip.error\-source\fR [default = \fIimg\-stdev\fR]. .TP \fB\-\-error\-out\-type\fR \fI\fR Output clipped error as error, variance, weight or none (str; default: \'error\'). The full name of this option for the EsoRex configuration file is \fBvisir.visir_util_clip.error\-out\-type\fR [default = \fIerror\fR]. .TP \fB\-\-badimage\fR \fI\fR 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 \fBvisir.visir_util_clip.badimage\fR [default = \fI0.2\fR]. .PP 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. .SH SEE ALSO The full documentation for the visir pipeline can be downloaded as a PDF file using the following URL: .IP .B ftp://ftp.eso.org/pub/dfs/pipelines/visir/visir\-pipeline\-manual\-1.4.pdf .PP An overview over the existing ESO pipelines can be found on the web page \fBhttps://www.eso.org/sci/software/pipelines/\fR. .PP Basic documentation about the EsoRex program can be found at the esorex (1) man page. .PP It is possible to call the pipelines from python using the python\-cpl package. See \fBhttps://packages.python.org/python\-cpl/index.html\fR for further information. .PP The other recipes of the visir pipeline are .IR visir_img_dark (7), .IR visir_img_ff (7), .IR visir_img_reduce (7), .IR visir_img_trans (7), .IR visir_old_img_combine (7), .IR visir_old_img_phot (7), .IR visir_old_spc_obs (7), .IR visir_old_spc_obs_ech (7), .IR visir_old_spc_phot (7), .IR visir_old_spc_phot_ech (7), .IR visir_old_spc_wcal (7), .IR visir_old_spc_wcal_ech (7), .IR visir_old_util_destripe (7), .IR visir_spc_reduce (7), .IR visir_util_apply_calib (7), .IR visir_util_convert_weight (7), .IR visir_util_detect_shift (7), .IR visir_util_img_std_cat (7), .IR visir_util_join (7), .IR visir_util_qc (7), .IR visir_util_repack (7), .IR visir_util_run_swarp (7), .IR visir_util_spc_std_cat (7), .IR visir_util_spc_txt2fits (7), .IR visir_util_undistort (7) .SH VERSION visir_util_clip 4.4.2 .SH AUTHOR Lars Lundin .SH BUG REPORTS Please report any problems to https://support.eso.org. Alternatively, you may send a report to the ESO User Support Department . .SH 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