FirstFrameStep

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

Bases: JwstStep

Set data quality flags for the first group in MIRI ramps.

Deprecated since version 2.0.0: The FirstFrameStep has been deprecated and will be removed in a future release. Flagging the first group has been added to the RSCD step.

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`
`spec`

Methods Summary

process(step_input)

For MIRI data with more than 3 groups, set first group dq to DO_NOT_USE.

Attributes Documentation

class_alias = 'firstframe'

spec

bright_use_group1 = boolean(default=True) # do not flag group1 if group3 is saturated
skip = boolean(default=True) # Do not run this step.

Methods Documentation

process(step_input)[source]

For MIRI data with more than 3 groups, set first group dq to DO_NOT_USE.

Parameters:

step_inputstr or RampModel: Input filename or datamodel to be corrected.

Returns:

output_modelRampModel: First frame corrected datamodel.