StraylightStep

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

Bases: JwstStep

Correct for straylight caused by cross-artifact effect or residual cosmic rays.

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_data)

Correct MIRI MRS data for the cross-artifact effect or residual cosmic rays.

Attributes Documentation

class_alias = 'straylight'

reference_file_types: ClassVar = ['mrsxartcorr', 'regions']

spec

clean_showers = boolean(default=False)  # Clean up straylight from residual cosmic ray showers
shower_plane = integer(default=3)  # Throughput plane for identifying inter-slice regions
shower_x_stddev = float(default=18) # X standard deviation for shower model
shower_y_stddev = float(default=5) # Y standard deviation for shower model
shower_low_reject = float(default=0.1) # Low percentile of pixels to reject
shower_high_reject = float(default=99.9) # High percentile of pixels to reject
save_shower_model = boolean(default=False) # Save the shower model

Methods Documentation

process(input_data)[source]

Correct MIRI MRS data for the cross-artifact effect or residual cosmic rays.

Parameters:

input_dataIFUImageModel: Input data to be corrected.

Returns:

resultsIFUImageModel: Straylight corrected data.