WfssContamStep

class jwst.wfss_contam.WfssContamStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Perform contamination correction of WFSS spectra.

Create a Step instance.

Parameters:

namestr: 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: 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 or pathlib.Path: The path to the config file that this step was initialized with. Use to determine relative path names of other config files.
_validate_kwdsbool: Validate given kws against specs/config.
**kwsdict: Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

`class_alias`
`reference_file_types`
`spec`

Methods Summary

process(input_model)

Run the WFSS contamination correction step.

Attributes Documentation

class_alias = 'wfss_contam'

reference_file_types: ClassVar = ['photom', 'wavelengthrange']

spec

save_simulated_image = boolean(default=False)  # Save full-frame simulated image
save_contam_images = boolean(default=False)  # Save source contam estimates
maximum_cores = option('none', 'quarter', 'half', 'all', default='none')
skip = boolean(default=True)
brightest_n = integer(default=None)
wl_oversample = integer(default=2) # oversampling factor for wavelength grid
max_pixels_per_chunk = integer(default=50000) # max number of pixels to disperse at once

Methods Documentation

process(input_model)[source]

Run the WFSS contamination correction step.

Parameters:

input_modelMultiSlitModel: The input data model containing 2-D cutouts for each identified source.

Returns:

output_modelMultiSlitModel: A copy of the input_model with contamination removed