FlatFieldStep¶
-
class
jwst.flatfield.
FlatFieldStep
(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]¶ Bases:
jwst.stpipe.core.JwstStep
Flat-field a science image using a flatfield reference image.
-
correction_pars
¶ After the step has successfully run, the flat field applied is stored.
- Type
{‘flat’: DataModel}
-
use_correction_pars
¶ Use the flat stored in
correction_pars
- Type
boolean
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 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
process
(input)This is where real work happens.
skip_step
(input_model)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 user_supplied_flat = string(default=None) # User-supplied flat\n inverse = boolean(default=False) # Invert the operation\n '¶
Methods Documentation
-