BarShadowStep

class jwst.barshadow.BarShadowStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Correct NIRSpec MOS data for barshadow effects.

Bar shadow correction depends on the position of a pixel along the slit and the wavelength. It is only applied to uniform sources and only for NRS MSA data.

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(input_data)

Perform the barshadow correction step.

Attributes Documentation

class_alias = 'barshadow'
reference_file_types: ClassVar = ['barshadow']
spec
inverse = boolean(default=False)    # Invert the operation
source_type = string(default=None)  # Process as specified source type.

Methods Documentation

process(input_data)[source]

Perform the barshadow correction step.

Parameters:

input_data (DataModel) – Input JWST datamodel object.

Returns:

result – JWST datamodel object with corrected science data and barshadow extension(s) added.

Return type:

DataModel