BackgroundStep

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

Bases: jwst.stpipe.Step

BackgroundStep: Subtract background exposures from target exposures.

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 path, optional) – The path to the config file that this step was initialized with. Use to determine relative path names.
  • **kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

reference_file_types
spec

Methods Summary

process(input, bkg_list) Subtract the background signal from target exposures by subtracting designated background images from them.

Attributes Documentation

reference_file_types = ['wfssbkg', 'wavelengthrange']
spec = '\n sigma = float(default=3.0) # Clipping threshold\n maxiters = integer(default=None) # Number of clipping iterations\n '

Methods Documentation

process(input, bkg_list)[source]

Subtract the background signal from target exposures by subtracting designated background images from them.

Parameters:
  • input (JWST data model) – input target data model to which background subtraction is applied
  • bkg_list (filename list) – list of background exposure file names
Returns:

result – the background-subtracted target data model
Return type:

JWST data model