SaturationStep

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

Bases: JwstStep

Sets saturation flags.

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(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_input (DataModel or str) – Input datamodel or string name of the fits file.

Returns:

result – Output datamodel with saturation flags set for saturated pixels.

Return type:

DataModel