RscdStep

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

Bases: JwstStep

Flag the first N groups of MIRI data to ‘DO_NOT_USE’ in the 2nd and later integrations.

The number of groups, N, for which to set the GROUPDQ flag to ‘DO_NOT_USE’ is read in from the RSCD reference file. This number depends on the readout model and subarray size. The step checks that the total number of groups in an integration is greater than N+3 before flagging the GROUPDQ array. If the number of groups is less than N+3 then no flagging is performed, because doing so would leave too few groups to work with in later steps.

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)

Flag the initial groups to 'DO_NOT_USE' in the 2nd and later integrations.

Attributes Documentation

class_alias = 'rscd'
reference_file_types: ClassVar = ['rscd']
spec

Methods Documentation

process(step_input)[source]

Flag the initial groups to ‘DO_NOT_USE’ in the 2nd and later integrations.

The number of initial groups to flag is read in from the RSCD reference file. This number varies based on readout mode and subarray size.

Parameters:

step_input (RampModel) – Ramp datamodel to be corrected, or the path to the ramp file.

Returns:

result – Ramp datamodel with initial groups in an integration flagged as DO_NOT_USE. Flags are only set of integration 2 and higher.

Return type:

RampModel