API

Public Step API

jwst.clean_flicker_noise.clean_flicker_noise_step Module

Correct ramp or rate data for flicker noise.

Classes

CleanFlickerNoiseStep([name, parent, ...])

Perform flicker noise correction.

Complete Developer API

jwst.clean_flicker_noise.autoparam Module

Functions

quick_clean(input_model[, flat_filename])

Run a quick version of the flicker noise cleaning on a rate image.

niriss_image_parameters(input_model, ...)

Determine appropriate parameters for cleaning a NIRISS image.

nircam_image_parameters(input_model, ...)

Determine appropriate parameters for cleaning a NIRCam image.

jwst.clean_flicker_noise.background_level Module

Functions

clip_to_background(image, mask[, ...])

Flag signal and bad pixels in the image mask.

background_level(image, mask[, ...])

Fit a low-resolution background level.

jwst.clean_flicker_noise.clean_flicker_noise Module

Functions

read_flat_file(input_model, flat_filename)

Read flat data from an input file path.

make_rate(input_model[, input_dir, return_cube])

Make a rate model from a ramp model.

post_process_rate(input_model[, input_dir, ...])

Perform additional processing for the input rate model, as needed.

mask_ifu_slices(input_model, mask)

Flag pixels within NIRSpec IFU slices.

mask_slits(input_model, mask)

Flag pixels within science regions for NIRSpec slit modes.

create_mask(input_model[, ...])

Create a mask identifying background pixels.

fft_clean_full_frame(image, mask, detector)

Fit and remove background noise in frequency space for a full-frame image.

fft_clean_subarray(image, mask, detector[, ...])

Fit and remove background noise in frequency space for a subarray image.

median_clean(image, mask, axis_to_correct[, ...])

Fit and remove background noise via median values along one image axis.

make_intermediate_model(input_model, ...)

Make a data model to contain intermediate outputs.

do_correction(input_model[, input_dir, ...])

Apply the 1/f noise correction.

jwst.clean_flicker_noise.nsclean Module

Functions

make_lowpass_filter(f_half_power, w_cutoff, n)

Make a lowpass Fourier filter.

med_abs_deviation(d[, median])

Compute the median absolute deviation.

Classes

NSClean(detector, mask[, fc, kill_width, ...])

JWST NIRSpec background modeling and subtraction -AKA "clean" (NSClean).

NSCleanSubarray(data, mask[, fc, ...])

Background modeling and subtraction for generic JWST near-IR subarrays.

jwst.clean_flicker_noise.tso_median_image Module

Functions

make_median_image(input_model, rateints_model)

Make a scaled median image across integrations to subtract before cleaning.