FlatFieldStep

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

Bases: JwstStep

Flat-field a science image using a flatfield reference image.

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

Methods Summary

`process`(input_data)	Perform the flat field step.
`skip_step`(input_model)	Set the calibration step status to SKIPPED.

Attributes Documentation

class_alias = 'flat_field'

flat_suffix = 'interpolatedflat'

reference_file_types: ClassVar = ['flat', 'fflat', 'sflat', 'dflat']

spec

save_interpolated_flat = boolean(default=False) # Save interpolated NRS flat
user_supplied_flat = string(default=None)  # User-supplied flat
inverse = boolean(default=False)  # Invert the operation

Methods Documentation

process(input_data)[source]

Perform the flat field step.

For repeating or undoing the correction, this step makes use of two special attributes:

correction_parsdict
After the step has successfully run, the flat field applied is stored, as {‘flat’: DataModel}.

use_correction_parsbool
Use the flat stored in correction_pars.

Parameters:

input_datastr or DataModel: Input data to correct. Datamodel type varies, depending on the exposure type.

Returns:

DataModel: Output data of the same type as input, with flat corrections applied.

skip_step(input_model)[source]

Set the calibration step status to SKIPPED.

This method makes a copy of the input model, sets the calibration switch for the flat_field step to SKIPPED in the copy, closes input_model, and returns the copy.

Parameters:

input_modelDataModel: Input data model.

Returns:

DataModel: A copy of the input model with the step status set to “SKIPPED”.