GainScaleStep

class jwst.gain_scale.GainScaleStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

Bases: JwstStep

Rescale all integrations in an exposure by a gain factor.

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)

Perform gain scale step.

Attributes Documentation

class_alias = 'gain_scale'

reference_file_types: ClassVar = ['gain']

spec

Methods Documentation

process(step_input)

Perform gain scale step.

Rescales countrate data to account for use of a non-standard gain value. All integrations are multiplied by the factor GAINFACT.

Parameters:

step_inputdatamodel

Input datamodel on which to perform gain scale step.

Returns:

resultdatamodel

Output datamodel on which the gain scale step has been performed.