API

Public Step API

jwst.flatfield.flat_field_step Module

Correct rate data for flat field effects.

Classes

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

Flat-field a science image using a flatfield reference image.

Complete Developer API

jwst.flatfield.flat_field Module

Utility functions for applying flat field corrections.

Functions

`do_correction`(input_model[, flat, fflat, ...])	Flat-field a JWST data model using a flat-field model.
`do_flat_field`(output_model, flat_model[, ...])	Apply image-based flat-fielding, updating the output model.
`apply_flat_field`(science, flat[, inverse])	Flat field the data and update error and variance arrays.
`do_nirspec_flat_field`(output_model, ...[, ...])	Apply flat-fielding for NIRSpec spectroscopic data, updating in-place.
`nirspec_fs_msa`(output_model, f_flat_model, ...)	Apply flat-fielding for NIRSpec fixed slit and MSA data, in-place.
`nirspec_brightobj`(output_model, ...[, ...])	Apply flat-fielding for NIRSpec BRIGHTOBJ data, in-place.
`nirspec_ifu`(output_model, f_flat_model, ...)	Apply flat-fielding for NIRSpec IFU data, in-place.
`create_flat_field`(wl, f_flat_model, ...[, ...])	Extract and combine flat field components for NIRSpec.
`fore_optics_flat`(wl, f_flat_model, ...)	Extract the flat for the fore optics part.
`spectrograph_flat`(wl, s_flat_model, xstart, ...)	Extract the flat for the spectrograph part.
`detector_flat`(wl, d_flat_model, xstart, ...)	Extract the flat for the detector part.
`combine_dq`(f_flat_dq, s_flat_dq, d_flat_dq, ...)	Combine non-None DQ arrays via bitwise or.
`read_image_wl`(flat_model[, quadrant])	Read wavelengths for the image planes.
`read_flat_table`(flat_model, exposure_type[, ...])	Read the table (the "fast" variation).
`combine_fast_slow`(wl, flat_2d, flat_dq, ...)	Multiply the image by the tabular values.
`clean_wl`(wl, dispaxis)	Replace zeros and/or NaNs in the wavelength array.
`interpolate_flat`(image_flat, image_dq, ...)	Interpolate within the 3-D flat field image to get a 2-D flat.
`flat_for_nirspec_ifu`(output_model, ...)	Create the interpolated flat for NIRSpec IFU.
`flat_for_nirspec_brightobj`(output_model, ...)	Create the interpolated flat for NIRSpec IFU.
`flat_for_nirspec_slit`(slit, f_flat_model, ...)	Create the interpolated flat for NIRSpec slit data.