tsgrism

jwst.assign_wcs.nircam.tsgrism(input_model, reference_files)[source]

Create WCS pipeline for a NIRCAM Time Series Grism observation.

Parameters:
input_modelCubeModel

The input data model.

reference_filesdict

Mapping between reftype (keys) and reference file name (vals). Requires ‘distortion’, ‘filteroffset’, and ‘specwcs’ reference files.

Returns:
pipelinelist

The WCS pipeline, suitable for input into gwcs.wcs.WCS.

Notes

The TSGRISM mode should function effectively like the grism mode except that subarrays will be allowed. Since the transform models depend on the original full frame coordinates of the observation, the regular grism transforms will need to be shifted to the full frame coordinates around the trace transform.

TSGRISM is only slated to work with GRISMR or DHS pupil elements and Module A.

For this mode, the source is typically at crpix1 x crpix2, which are stored in keywords XREF_SCI, YREF_SCI, plus an offset from the TA to the grism pupil, plus any additional special requirement offsets requested by the user in APT. Offsets are stored in the X_OFFSET, Y_OFFSET keywords and are incorporated into the shifts for the grism detector to direct image transform.