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

Bases: jwst.stpipe.Step

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

Create a Step instance.

  • 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 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




Methods Summary


This is where real work happens.


Set the calibration switch to SKIPPED.

Attributes Documentation

flat_suffix = 'interpolatedflat'
reference_file_types = ['flat', 'fflat', 'sflat', 'dflat']
spec = '\n save_interpolated_flat = boolean(default=False) # Save interpolated NRS flat\n '

Methods Documentation


This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.


Set the calibration switch to SKIPPED.

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