SaturationStep

class jwst.saturation.SaturationStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

Bases: JwstStep

Set saturation flags.

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

Set the saturation flags.

Attributes Documentation

class_alias = 'saturation'

reference_file_types: ClassVar = ['saturation', 'superbias']

spec

n_pix_grow_sat = integer(default=1) # number of layers adjacent pixels to flag
use_readpatt = boolean(default=True) # Use grouped read pattern information to assist with flagging

Methods Documentation

process(step_input)

Set the saturation flags.

Parameters:

step_inputDataModel or str

Input datamodel or string name of the fits file.

Returns:

resultDataModel

Output datamodel with saturation flags set for saturated pixels.