wf32d

Use this function to facilitate batch runs.

This routine performs the remaining series of tasks in the UVIS pipeline. The wf32d primary functions include:

  • DARKCORR: dark current subtraction

  • FLATCORR: flat-fielding and conversion to electrons

  • SHADCORR: apply shutter shading correction (currently skipped)

  • PHOTCORR: photometric keyword calculations

  • FLUXCORR: photometric normalization of the UVIS1 and UVIS2 chips

Only those steps with a switch value of PERFORM in the input files will be executed, after which the switch will be set to COMPLETE in the corresponding output files. See Section 3.4.3 of the WFC3 Data Handbook for more information.

Running wf32d from a Python Terminal

from wfc3tools import wf32d
wf32d(filename)

Displaying output from wf32d in a Jupyter Notebook

When calling wf32d from a Jupyter notebook, informational text output from the underlying wf32d.e program will be passed through print as the calibration runs by default, and show up in the user’s cell. This behavior can be customized by passing your own function as the log_func keyword argument to wf32d. As output is read from the underlying program, the wf32d Python wrapper will call log_func with the contents of each line. print is an obvious choice for a log function, but this also provides a way to connect wf32d to the Python logging system by passing the logging.debug function or similar.

If log_func=None is passed, informational text output from the underlying program will be ignored, but the program’s exit code will still be checked for successful completion.

Input Parameters for the Python Interface

Parameters

inputstr or list

Name of input files, such as

  • a single filename (iaa012wdq_raw.fits)

  • a Python list of filenames

  • a partial filename with wildcards (\*raw.fits)

  • filename of an ASN table (\*asn.fits)

  • an at-file (@input)

outputstr, default=None

Name of the output FITS file.

dqicorrstr, optional, default=”PERFORM”

Update the dq array from bad pixel table. Allowed values are “PERFORM” and “OMIT”.

darkcorrstr, optional, default=”PERFORM”

Subtract the dark image. Allowed values are “PERFORM” and “OMIT”.

flatcorrstr, optional, default=”PERFORM”

Multiply by the flatfield image. Allowed values are “PERFORM” and “OMIT”.

shadcorrstr, optional, default=”PERFORM”

Correct for shutter shading (CCD). Allowed values are “PERFORM” and “OMIT”.

photcorrstr, optional, default=”PERFORM”

Update photometry keywords in the header. Allowed values are “PERFORM” and “OMIT”.

verbosebool, optional, default=False

If True, print verbose time stamps.

quietbool, optional, default=True

If True, print messages only to trailer file.

debugbool, optional, default=False

If True, print debugging statements.

log_funcfunc(), default=print()

If not specified, the print function is used for logging to facilitate use in the Jupyter notebook.

Returns

None

Usage

from wfc3tools import wf32d
wf32d(filename)

Command Line Options for the wf32d C Executable

wf32d.e input output [-options]

Input may be a single filename, and the options include:

  • -v: verbose

  • -t: print time stamps

  • -d: debug

  • -dark: perform dark subtraction

  • -dqi: update the DQ array

  • -flat: perform flat correction

  • -shad: perform shading correction

  • -phot: perform phot correction