AssignWcsStep

class jwst.assign_wcs.AssignWcsStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Create a gWCS object and store it in Model.meta.wcs.

Create a Step instance.

Parameters:

  • name (str, optional) – The name of the Step instance. Used in logging messages and in cache filenames. If not provided, one will be generated based on the class name.

  • parent (Step instance, optional) – The parent step of this step. Used to determine a fully-qualified name for this step, and to determine the mode in which to run this step.

  • config_file (str or pathlib.Path, optional) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

  • **kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

class_alias

reference_file_types

spec

Methods Summary

process(input_data)

Run the assign_wcs step.

Attributes Documentation

class_alias = 'assign_wcs'
reference_file_types: ClassVar = ['distortion', 'filteroffset', 'specwcs', 'regions', 'wavelengthrange', 'camera', 'collimator', 'disperser', 'fore', 'fpa', 'msa', 'ote', 'ifupost', 'ifufore', 'ifuslicer']
spec
sip_approx = boolean(default=True)  # enables SIP approximation for imaging modes.
sip_max_pix_error = float(default=0.01)  # max err for SIP fit, forward.
sip_degree = integer(max=6, default=None)  # degree for forward SIP fit, None to use best fit.
sip_max_inv_pix_error = float(default=0.01)  # max err for SIP fit, inverse.
sip_inv_degree = integer(max=6, default=None)  # degree for inverse SIP fit, None to use best fit.
sip_npoints = integer(default=12)  #  number of points for SIP
slit_y_low = float(default=-.55)  # The lower edge of a slit (NIRSpec only).
slit_y_high = float(default=.55)  # The upper edge of a slit (NIRSpec only).
nrs_ifu_slice_wcs = boolean(default=False)  # For NIRSpec IFU, create a full slice-based WCS instead of a top-level coordinate-based WCS. Used for diagnostic purposes only.

Methods Documentation

process(input_data)[source]

Run the assign_wcs step.

Reference file types for this step:

  • camera: Camera model (NIRSPEC)

  • collimator: Collimator Model (NIRSPEC)

  • disperser: Disperser model (NIRSPEC)

  • distortion: Spatial distortion model (FGS, MIRI, NIRCAM, NIRISS)

  • filteroffset: Filter offsets (MIRI Imager)

  • fore: Transform through the FORE optics (NIRSPEC)

  • fpa: Transform in the FPA plane (NIRSPEC)

  • ifufore: Transforms from the MSA plane to the plane of the IFU slicer (NIRSPEC)

  • ifupost: Transforms from the slicer plane to the MSA plane (NIRSPEC)

  • ifuslicer: Metrology of the IFU slicer (NIRSPEC)

  • msa: Metrology of the MSA plane (NIRSPEC)

  • ote: Transform through the Optical Telescope Element (NIRSPEC)

  • specwcs: Wavelength calibration models (MIRI, NIRCAM, NIRISS)

  • regions: Stores location of the regions on the detector (MIRI)

  • wavelengthrange: Typical wavelength ranges (MIRI, NIRCAM, NIRISS, NIRSPEC)

Parameters:

input_data (JwstDataModel or str) – Either a jwst data model or a string that is the path to one.

Returns:

result – The data model with the WCS information added.

Return type:

JwstDataModel