ResidualFringeStep

class jwst.residual_fringe.residual_fringe_step.ResidualFringeStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Apply residual fringe correction to a MIRI MRS image.

Requires frequency parameters provided in the FRINGEFREQ reference file.

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)

Perform the residual fringe correction.

Attributes Documentation

class_alias = 'residual_fringe'

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

spec

skip = boolean(default=True)
save_intermediate_results  = boolean(default = False)
search_output_file = boolean(default = False)
ignore_region_min = list(default = None)
ignore_region_max = list(default = None)
suffix = string(default = 'residual_fringe')

Methods Documentation

process(input_data)[source]

Perform the residual fringe correction.

Parameters:

input_datastr or IFUImageModel: Input data to correct. Must be a MIRI MRS IFU image.

Returns:

IFUImageModel: The corrected datamodel.