Description

Class:

jwst.nsclean.NSCleanStep

Alias:

nsclean

Note

This step, which is intended to be called in the calwebb_spec2 pipeline on NIRSpec rate data, is now deprecated. In future builds, it will be replaced by the clean_flicker_noise step, called in the calwebb_detector1 pipeline on ramp data.

Overview

This step currently runs a version of the clean_flicker_noise algorithm, with slightly different parameters and default values, intended to be backwards-compatible with the previous implementation of the step developed specifically for NIRSpec data. The only significant difference is that in this step, the cleaning is performed directly on the rate data, rather than group images.

See the clean_flicker_noise documentation for more information, or the nsclean step arguments for the default values used for this step.

If this step is run as part of the calwebb_spec2 pipeline when processing an association that includes background or imprint images, these images will be processed using the same nsclean parameters as the science image. If a user supplied mask is provided, it will be used for all images in an association. Otherwise, separate masks will be calculated for each image using the same input parameters.