DarkCurrentStep

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

Bases: JwstStep

Subtract dark current from the input science data.

Create a Step instance.

Parameters:
namestr

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

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

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

_validate_kwdsbool

Validate given kws against specs/config.

**kwsdict

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

Attributes Summary

class_alias

reference_file_types

spec

Methods Summary

process(step_input)

Perform the dark current subtraction step.

set_average_dark_current(input_model, dark_model)

Assign average dark current.

Attributes Documentation

class_alias = 'dark_current'
reference_file_types: ClassVar = ['dark']
spec
dark_output = output_file(default = None) # Dark model or averaged dark subtracted
average_dark_current = float(default=None) # The average dark current for this detector in units of e-/sec.

Methods Documentation

process(step_input)[source]

Perform the dark current subtraction step.

Returns:
out_rampRampModel

The science model with dark current subtracted form the data array.

set_average_dark_current(input_model, dark_model)[source]

Assign average dark current.

Take the three possible locations specifying the average dark current and assign them to the input model, in priority order:

  1. Any value provided to the step parameter, either from the user or a parameter reference file

  2. The 2-D array stored in dark_model.average_dark_current

  3. The scalar value stored in dark_model.meta.exposure.average_dark_current

Parameters:
input_modelRampModel

The input datamodel containing the 4-D ramp array.

dark_modelDarkModel or DarkMIRIModel

The dark reference file datamodel.