extract_tso_object
- jwst.extract_2d.grisms.extract_tso_object(input_model, reference_files=None, tsgrism_extract_height=None, extract_orders=None, compute_wavelength=True)[source]
Extract the spectrum for a NIRCam TSO grism observation.
- Parameters:
- input_model
CubeModelorImageModel The input TSO data can be a cube (3D) or an image (2D).
- reference_filesdict
This dictionary must contain the name of the WAVELENGTHRANGE reference file.
- tsgrism_extract_heightint, optional
The extraction height, in total, for the spectrum in the cross-dispersion direction. If this is other than None, it will override the default of 64 pixels. The instrument team wants the source centered near row 34, so the extraction height is not the same on either size of the central row.
- extract_orderslist of int, optional
Overrides the orders specified for extraction in the WAVELENGTHRANGE reference file.
- compute_wavelengthbool, optional
Compute a wavelength array for the datamodel.
- input_model
- Returns:
- output_model
SlitModel Output model containing extracted spectrum.
- output_model
Notes
This method supports NRC_TSGRISM only, where only one bright object is considered in the field, so there’s no catalog of sources and the object is assumed to have been observed at the aperture reference position. The aperture reference location is read during level-1b (uncal) product creation by the “set_telescope_pointing” script from the SIAF entries XSciRef and YSciRef (reference location in the science frame) and saved as “meta.wcsinfo.siaf_xref_sci” and “meta.wcsinfo.siaf_yref_sci” (FITS header keywords XREF_SCI and YREF_SCI).
Because this mode has a single known source location, the utilities used in the WFSS modes are overkill. Instead, similar structures are created during the extract2d process and then directly used.
For more information on the NRC_TSGRISM mode, see: https://jwst-docs.stsci.edu/jwst-near-infrared-camera/nircam-observing-modes/nircam-time-series-observations/nircam-grism-time-series