BackgroundStep
- class jwst.background.BackgroundStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]
Bases:
JwstStepSubtract background exposures from target exposures.
Create a
Stepinstance.- 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 or pathlib.Path, optional) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.
**kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.
Attributes Summary
Methods Summary
process(step_input[, input_bkg_list])Subtract designated background images from target exposures.
Attributes Documentation
- bkg_suffix = 'combinedbackground'
- class_alias = 'bkg_subtract'
- reference_file_types: ClassVar = ['bkg', 'wavelengthrange']
- spec
bkg_list = force_list(default=None) # List of background files. Ignored for WFSS or if asn is provided save_combined_background = boolean(default=False) # Save combined background image sigma = float(default=3.0) # Clipping threshold maxiters = integer(default=None) # Number of clipping iterations soss_source_percentile = float(default=35.0) # Threshold flux percentile to mask out source pixels soss_bkg_percentile = float_list(min=2, max=2, default=None) # Background percentiles to use; default is [25.0, 50.0] wfss_mmag_extract = float(default=None) # WFSS minimum abmag to extract wfss_maxiter = integer(default=5) # WFSS iterative outlier rejection max iterations wfss_rms_stop = float(default=0) # WFSS iterative outlier rejection RMS improvement threshold (percent) wfss_outlier_percent = float(default=1) # WFSS outlier percentile to reject per iteration
Methods Documentation