wf3ccd

wfc3tools.wf3ccd.wf3ccd(input, output=None, dqicorr='PERFORM', atodcorr='PERFORM', blevcorr='PERFORM', biascorr='PERFORM', flashcorr='PERFORM', verbose=False, quiet=True, log_func=<built-in function print>)[source]

Run the wf3ccd.e executable as from the shell.

wf3ccd first subtracts the bias and trims the overscan regions from the image. If an associated set of UVIS CR-SPLIT or REPEAT-OBS images is being processed, all of the overscan-trimmed images are sent through wf3rej to be combined and receive cosmic-ray rejection.

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

Name of the output FITS file. Default is None.

dqicorrstr, optional

Update the DQ array from bad pixel table, as well as flag the A-to-D saturation. If the comparatively new FITS keyword (mid-2023) SATUFILE is missing or not populated in the input file, the full-well saturation will also be flagged using a single value as the threshold. Allowed values are “PERFORM” and “OMIT”. Default is “PERFORM”.

atodcorrstr, optional

Analog to digital correction. Allowed values are “PERFORM” and “OMIT”. Default is “PERFORM”.

blevcorrstr, optional

Subtract bias from overscan regions. Allowed values are “PERFORM” and “OMIT”. Default is “PERFORM”.

biascorrstr, optional

Subtract bias image. Allowed values are “PERFORM” and “OMIT”. Default is “PERFORM”.

flashcorrstr, optional

Subtract post-flash image. Allowed values are “PERFORM” and “OMIT”. Default is “PERFORM”.

verbosebool, optional

If True, print verbose time stamps. Default is False.

quietbool, optional

If True, print messages only to trailer file. Default is True.

log_funcfunc

By default, the print function is used for logging to facilitate use in the Jupyter notebook.

Examples

>>> from wfc3tools import wf3ccd
>>> filename = '/path/to/some/wfc3/image.fits'
>>> wf3ccd(filename)