ACSCTEFORWARDMODEL

The acscteforwardmodel module contains a function acscteforwardmodel that calls the ACSCTE forward model executable. Use this function to facilitate batch runs of the forward model, or for the TEAL interface.

Only WFC full-frame and some 2K subarrays are currently supported. See ACS Data Handbook for more details.

For guidance on running the CTE forward model, see the Jupyter notebook ACS CTE Forward Model Example.

Note

Calibration flags are controlled by primary header.

Examples

In Python without TEAL (recommended):

>>> from acstools import acscteforwardmodel
>>> acscteforwardmodel.acscteforwardmodel('*blc_tmp.fits')

In Python with TEAL:

>>> from stsci.tools import teal
>>> from acstools import acscteforwardmodel
>>> teal.teal('acscteforwardmodel')

For help usage use exe_args=['--help']

acstools.acscteforwardmodel.acscteforwardmodel(input, exec_path='', time_stamps=False, verbose=False, quiet=False, single_core=False, exe_args=None)

Run the acscteforwardmodel.e executable as from the shell.

Expect input to be *_blc_tmp.fits or *_flc.fits. Output is automatically named *_ctefmod.fits.

Parameters:
  • input (str or list of str) –

    Input filenames in one of these formats:

    • a single filename (‘j1234567q_blc_tmp.fits’)
    • a Python list of filenames
    • a partial filename with wildcards (‘*blc_tmp.fits’)
    • filename of an ASN table (‘j12345670_asn.fits’)
    • an at-file (@input)
  • exec_path (str, optional) – The complete path to ACSCTE forward model executable. If not given, run ACSCTE given by ‘acscteforwardmodel.e’.
  • time_stamps (bool, optional) – Set to True to turn on the printing of time stamps.
  • verbose (bool, optional) – Set to True for verbose output.
  • quiet (bool, optional) – Set to True for quiet output.
  • single_core (bool, optional) – CTE correction in the ACSCTE forward model will by default try to use all available CPUs on your computer. Set this to True to force the use of just one CPU.
  • exe_args (list, optional) – Arbitrary arguments passed to underlying executable call. Note: Implementation uses subprocess.call and whitespace is not permitted. E.g. use exe_args=[‘–nThreads’, ‘1’]