hawki_dark_combine7

Usage

Overview

hawki_dark_combine -- HAWKI dark combine recipe.

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

The program accepts the following files in the SOF:

Tag Description

DARK A list of raw dark images
REFERENCE_DARK Optional reference dark frame
MASTER_BPM Optional master bad pixel map or
MASTER_CONF Optional master confidence map If no reference dark frame is made available, then no comparison will be done. This means there will be no output difference image or stats table. If neither a bad pixel mask or a master confidence map is specified all stats are done assuming all pixels are good.

Options

--combtype <str>

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

--scaletype <str>

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

--xrej <bool>

True if using extra rejection cycle (bool; default: True). The full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.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 hawki.hawki_dark_combine.thresh [default = 5.0].

--ncells <int>

Number of cells for data channel stats (int; default: 8). The full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.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 hawki.hawki_dark_combine.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.

Version

hawki_dark_combine 2.4.11