PathLossStep

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

Bases: JwstStep

Apply the path loss correction to a science exposure.

Pathloss depends on the centering of the source in the aperture if the source is a point source.

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

Execute the pathloss step.

Attributes Documentation

class_alias = 'pathloss'

reference_file_types: ClassVar = ['pathloss']

spec

inverse = boolean(default=False)    # Invert the operation
source_type = string(default=None)  # Process as specified source type
user_slit_loc = float(default=None)   # User-provided correction to MIRI LRS source location

Methods Documentation

process(model_input)[source]

Execute the pathloss step.

Parameters:

model_inputDataModel: The input datamodel to be corrected.

Returns:

resultDataModel: The result of the pathloss calibration step.