FlatFieldStep¶
-
class
iris_pipeline.
FlatFieldStep
(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source] [edit on github]¶ Bases:
jwst.stpipe.Step
Flat-field a science image using a flatfield reference image.
Create a
Step
instance.- Parameters
- namestr, 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.
- parentStep 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_filestr path, optional
The path to the config file that this step was initialized with. Use to determine relative path names.
- **kwsdict
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
-
reference_file_types
= ['flat']¶
-
spec
= '\n # Suffix for optional output file for interpolated flat fields.\n # Note that this is only used for NIRSpec spectrographic data.\n flat_suffix = string(default=None)\n '¶
Methods Documentation
-
process
(input)[source] [edit on github]¶ This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.
-
skip_step
(input_model)[source] [edit on github]¶ 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.