SubtractImagesStep

class liger_iris_pipeline.background.SubtractImagesStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

Bases: JwstStep

SubtractImagesStep: Subtract two exposures from one another to accomplish background subtraction.

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

spec

Methods Summary

process(input1, input2)

Subtract the background signal from a data model by subtracting a background image from it.

Attributes Documentation

spec = '\n    '

Methods Documentation

process(input1, input2)

Subtract the background signal from a data model by subtracting a background image from it.

Parameters:

input1: data model

input science data model to be background-subtracted

input2: data model

background data model

Returns:

result: data model

background-subtracted science data model