NAME

vimos_ima_twilight_flat - Twilight flat combination for imaging

SYNOPSIS

esorex vimos_ima_twilight_flat [OPTIONS] FILE.sof

DESCRIPTION

vimos_ima_twilight_flat -- VIMOS twilight flat combine recipe.

Combine a list of twilight flat frames into a mean frame. Optionally compare the output frame to a reference twilight flat frame

The program accepts the following files in the SOF:

Tag Description

FLAT_TWILIGHT A list of raw twilight flat images
MASTER_BIAS A master bias frame
MASTER_DARK A master dark frame
REFERENCE_TWILIGHT_FLAT Optional reference twilight flat frame If no reference twilight flat is made available, then no comparison will be done. This means there will be no output ratio image and no stats

OPTIONS

--lthr <float>

Low rejection threshold for underexpsed images (float; default: 4000.0). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.lthr [default = 4000.0].

--hthr <float>

High rejection threshold for overexposed images (float; default: 60000.0). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.hthr [default = 60000.0].

--combtype <str>

Combination algorithm (str; default: ´median´). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.combtype [default = median].

--scaletype <str>

Scaling algorithm (str; default: ´multiplicative´). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.scaletype [default = multiplicative].

--xrej <bool>

True if using extra rejection cycle (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.xrej [default = True].

--thresh <float>

Rejection threshold in sigma above background (float; default: 5.0). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.thresh [default = 5.0].

--ncells <int>

Number of cells for diff image stats (int; default: 8). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.ncells [default = 8].

--prettynames <bool>

Use pretty output file names? (bool; default: False). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.prettynames [default = False].

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

ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.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 vimos pipeline are vimos_ima_bias(7), vimos_ima_dark(7), vimos_ima_det_noise(7), vimos_ima_fringe(7), vimos_ima_science(7), vimos_ima_standard(7), vmbias(7), vmdark(7), vmdet(7), vmifucalib(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7)

VERSION

vimos_ima_twilight_flat 4.1.1

AUTHOR

Jim Lewis <jrl@ast.cam.ac.uk>

BUG REPORTS

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

LICENSE

This file is part of the VIMOS Instrument Pipeline Copyright (C) 2019 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA