BackgroundStep¶
-
class
iris_pipeline.
BackgroundStep
(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source] [edit on github]¶ Bases:
jwst.stpipe.Step
BackgroundStep: Subtract background exposures from target exposures.
Create a
Step
instance.- Parameters
- namestr, 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.
- parentStep 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_filestr path, optional
The path to the config file that this step was initialized with. Use to determine relative path names.
- **kwsdict
Additional parameters to set. These will be set as member variables on the new Step instance.
Attributes Summary
Methods Summary
process
(input, bkg_list)Subtract the background signal from target exposures by subtracting designated background images from them.
Attributes Documentation
-
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] [edit on github]¶ 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: JWST data model
the background-subtracted target data model