SubtractImagesStep¶
-
class
jwst.background.
SubtractImagesStep
(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]¶ Bases:
jwst.stpipe.Step
SubtractImagesStep: Subtract two exposures from one another to accomplish background subtraction.
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
spec
Methods Summary
process
(input1, input2)Subtract the background signal from a JWST data model by subtracting a background image from it. Attributes Documentation
-
spec
= '\n '¶
Methods Documentation
-
process
(input1, input2)[source]¶ Subtract the background signal from a JWST data model by subtracting a background image from it.
Parameters: - input1 (JWST data model) – input science data model to be background-subtracted
- input2 (JWST data model) – background data model
Returns: result – background-subtracted science data model
Return type: JWST data model