Extract2dStep

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

Bases: JwstStep

Extract 2D spectral cutouts.

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(input_data)

Extract 2D cutouts from a spectral image.

Attributes Documentation

class_alias = 'extract_2d'

reference_file_types: ClassVar = ['wavelengthrange']

spec

slit_names = force_list(default=None)   # slits to be extracted
source_ids = force_list(default=None)     # source ids to be extracted
source_ra = force_list(default=None)  # source RAs to be extracted, WFSS only
source_dec = force_list(default=None)  # source DECs to be extracted, WFSS only
source_max_sep = float(default=2.0)  # maximum separation in arcseconds around source_ra, source_dec, WFSS only
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_data)[source]

Extract 2D cutouts from a spectral image.

Parameters:

input_datastr, ImageModel, or CubeModel: Input datamodel or file name.

Returns:

resultMultiSlitModel, or SlitModel: Output datamodel containing spectral cutouts in separate extensions.