Extract2dStep

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

Bases: JwstStep

This Step performs a 2D extraction of spectra.

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 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.

  • **kws (dict) – 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(input_model, *args, **kwargs)

This is where real work happens.

Attributes Documentation

class_alias = 'extract_2d'
reference_file_types: ClassVar = ['wavelengthrange']
spec
slit_name = string(default=None)
extract_orders = int_list(default=None)  # list of orders to extract
grism_objects = list(default=None)  # list of grism objects to use
tsgrism_extract_height =  integer(default=None)  # extraction height in pixels, TSGRISM mode
wfss_extract_half_height =  integer(default=5)  # extraction half height in pixels, WFSS mode
wfss_mmag_extract = float(default=None)  # minimum abmag to extract, WFSS mode
wfss_nbright = integer(default=1000)  # number of brightest objects to extract, WFSS mode

Methods Documentation

process(input_model, *args, **kwargs)[source]

This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.