MRSIMatchStep

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

Bases: JwstStep

MRSIMatchStep: Subtraction or equalization of sky background in MIRI MRS science images.

Create a Step instance.

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

`class_alias`
`reference_file_types`
`spec`

Methods Summary

process(images)

This is where real work happens.

Attributes Documentation

class_alias = 'mrs_imatch'

reference_file_types: list = []

spec

# General sky matching parameters:
bkg_degree = integer(min=0, default=1) # Degree of the polynomial for background fitting
subtract = boolean(default=False) # subtract computed sky from 'images' cube data?
skip = boolean(default=True) # Step must be turned on by parameter reference or user

Methods Documentation

process(images)[source]: This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.