API

Public Step API

jwst.assign_wcs.assign_wcs_step Module

Classes

AssignWcsStep([name, parent, config_file, ...])

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

Complete Developer API

jwst.assign_wcs.assign_wcs Module

Functions

load_wcs(input_model[, reference_files, ...])

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

jwst.assign_wcs.fgs Module

FGS WCS pipeline - depends on EXP_TYPE.

Functions

create_pipeline(input_model, reference_files)

Create a gWCS.pipeline using models from reference files.

imaging(input_model, reference_files)

Create the WCS pipeline for FGS imaging data.

jwst.assign_wcs.miri Module

Functions

create_pipeline(input_model, reference_files)

Create the WCS pipeline for MIRI modes.

imaging(input_model, reference_files)

Create the WCS pipeline for MIRI imaging data.

lrs(input_model, reference_files)

Create the WCS pipeline for LRS-FIXEDSLIT and LRS-SLITLESS data.

ifu(input_model, reference_files)

Create the WCS pipeline for MIRI IFU data.

retrieve_filter_offset(filter_offset_model, ...)

Retrieve the filter offset for a given filter from the FilteroffsetModel.

store_dithered_position(input_model)

Store the location of the dithered pointing location in the dither metadata.

wfss(input_model, reference_files)

Create the WCS pipeline for a MIRI WFSS observation.

jwst.assign_wcs.nircam Module

Functions

create_pipeline(input_model, reference_files)

Create the WCS pipeline based on EXP_TYPE.

imaging(input_model, reference_files)

Create the WCS pipeline for NIRCAM imaging data.

tsgrism(input_model, reference_files)

Create WCS pipeline for a NIRCAM Time Series Grism observation.

wfss(input_model, reference_files)

Create the WCS pipeline for a NIRCAM grism observation.

jwst.assign_wcs.niriss Module

Functions

create_pipeline(input_model, reference_files)

Create the WCS pipeline based on EXP_TYPE.

imaging(input_model, reference_files)

Create the WCS pipeline for NIRISS imaging data.

niriss_soss(input_model, reference_files)

Create the WCS pipeline for NIRISS SOSS data.

niriss_soss_set_input(model, order_number)

Extract a WCS for a specific spectral order.

wfss(input_model, reference_files)

Create the WCS pipeline for a NIRISS grism observation.

jwst.assign_wcs.nirspec Module

Tools to create the WCS pipeline NIRSPEC modes.

Calls create_pipeline() which redirects based on EXP_TYPE.

Functions

create_pipeline(input_model, ...)

Create a pipeline list based on EXP_TYPE.

imaging(input_model, reference_files)

Create the WCS pipeline for NIRSpec imaging data.

ifu(input_model, reference_files[, slit_y_range])

Create the WCS pipeline for NIRSpec IFU data.

slits_wcs(input_model, reference_files, ...)

Create the WCS pipeline for MOS and fixed slits.

get_open_slits(input_model[, ...])

Return the open slits/shutters in a MOS or Fixed Slits exposure.

generate_compound_bbox(input_model[, slits, ...])

Generate a compound bounding box for multislit data.

nrs_fs_slit_id(slit_name)

Get the slit ID corresponding to a fixed slit name.

nrs_fs_slit_name(slit_id)

Get the slit name corresponding to a fixed slit ID.

nrs_wcs_set_input(input_model, slit_name)

Make a WCS object for a specific slit or slice.

nrs_ifu_wcs(input_model)

Return a list of WCSs for all NIRSPEC IFU slits.

get_spectral_order_wrange(input_model, ...)

Read the spectral order and wavelength range from the reference file.

spectral_order_wrange_from_model(input_model)

Return the spectral order and wavelength range used in the WCS.

jwst.assign_wcs.pointing Module

Functions

compute_roll_ref(v2_ref, v3_ref, roll_ref, ...)

Compute the position of V3 (measured N to E) at the center of an aperture.

frame_from_model(wcsinfo)

Initialize a coordinate frame based on values in model.meta.wcsinfo.

fitswcs_transform_from_model(wcsinfo[, ...])

Create a WCS object using from datamodel.meta.wcsinfo.

dva_corr_model(va_scale, v2_ref, v3_ref)

Create transformation that accounts for differential velocity aberration (scale).

jwst.assign_wcs.util Module

Utility functions for assign_wcs.

Functions

velocity_correction(velosys)

Compute wavelength correction to Barycentric reference frame.

calc_rotation_matrix(roll_ref, v3i_yang[, ...])

Calculate the rotation matrix.

wrap_ra(ravalues)

Test for 0/360 wrapping in RA values.

update_fits_wcsinfo(datamodel[, ...])

Update datamodel.meta.wcsinfo based on a FITS WCS + SIP approximation of a GWCS object.

Classes

MSAFileError(message)

Exception to raise when MSA shutter configuration file is missing or invalid.

NoDataOnDetectorError([message])

WCS solution indicates no data on detector.