This routine contains the initial processing steps for all the WFC3 UVIS channel data. These steps are:
DQICORR - initialize the data quality array with values from BPIXTAB, flag for A-to-D saturation, and potentially flag for full-well saturation using scalar value as the threshold (fall-back algorithm)
ATODCORR - perform the a-to-d conversion correction
BLEVCORR - subtract the bias level from the overscan region
BIASCORR - subtract the bias image
Flag for full-well saturation using a two-dimensional image (new algorithm)
Detect and record SINK pixels in the DQ mask (performed if DQICORR is set to PERFORM)
FLSHCORR - subtract the post-flash image
The wf3ccd processes everything in counts. If a calibration reference file is in units of electrons when used during the wf3ccd processing, the calibration data are divided by the gain before use. The conversion to electrons happens in the wf32d component.
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. The resulting combined image then receives final calibration with wf32d, which includes dark subtraction and flat-fielding. If there are multiple sets of CR-SPLIT or REPEAT-OBS images in an association, each set goes through the cycle of wf3ccd, wf3rej and wf32d processing.
If BLEVCORR is performed, the output contains the overcan-trimmed region.
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.2 of the WFC3 Data Handbook for more information.
Running wf3ccd from a Python Terminal
from wfc3tools import wf3ccd wf3ccd(filename)
Displaying output from wf3ccd in a Jupyter Notebook
When calling wf3ccd from a Jupyter notebook, informational text output from the underlying wf3ccd.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 wf3ccd. As output is read from the underlying program, the wf3ccd 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 wf3ccd 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
- inputstr or list
Name of input files, such as
a single filename (
a Python list of filenames
a partial filename with wildcards (
filename of an ASN table (
an at-file (
- outputstr, default=None
Name of the output FITS file.
- dqicorrstr, optional, default=”PERFORM”
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”.
- atodcorrstr, optional, default=”PERFORM”
Analog to digital correction. Allowed values are “PERFORM” and “OMIT”.
- blevcorrstr, optional, default=”PERFORM”
Subtract bias from overscan regions. Allowed values are “PERFORM” and “OMIT”.
- biascorrstr, optional, default=”PERFORM”
Subtract bias image. Allowed values are “PERFORM” and “OMIT”.
NOTE: Strictly speaking, the application of the full-well saturation image is not a calibration step (i.e., there is no SATCORR), but the application of a 2D image to flag pixels versus using a single scalar value to flag saturated pixels as previously done in DQICORR will be done in doFullWellSat() after BLEVCORR and BIASCORR. This correction should only be done if both BLEVCORR and BIASCORR have been performed. This flagging is only applicable for the UVIS.
- flashcorrstr, optional, default=”PERFORM”
Subtract post-flash image. 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.
- log_funcfunc(), default=print()
If not specified, the print function is used for logging to facilitate use in the Jupyter notebook.
from wfc3tools import wf3ccd wf3ccd(filename)
Command Line Options for the wf3ccd executable
wf32ccd.e input output [-options]
Input may be a single filename, and the options include:
-t: print time stamps
-dqi: udpate the DQ array
-atod: perform a-to-d gain correction
-blev: subtract bias from overscan
-bias: perform bias correction
-flash: remove post-flash image