FlatFieldStep

class liger_iris_pipeline.flatfield.FlatFieldStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

Bases: JwstStep

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 or pathlib.Path, optional

The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

**kwsdict

Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

reference_file_types

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: ClassVar = ['flat']

Methods Documentation

process(input)

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)

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.