pypeit.spectrographs.jwst_nirspec module

Module for JWST NIRSpec specific methods.

class pypeit.spectrographs.jwst_nirspec.JWSTNIRSpecSpectrograph[source]

Bases: Spectrograph

Child to handle JWST NIRSpec specific code

property allowed_mosaics

Return the list of allowed detector mosaics.

JWST/NIRSpec only allows for mosaicing the NRS1 and NRS2 detectors.

Returns:: List of tuples, where each tuple provides the 1-indexed detector numbers that can be combined into a mosaic and processed by PypeIt.
Return type:: list

camera = 'NIRSPEC': Name of the spectrograph camera or arm. This is used by specdb, so use that naming convention

check_frame_type(ftype, fitstbl, exprng=None)[source]

Check for frames of the provided type.

Parameters:

ftype (str) – Type of frame to check. Must be a valid frame type; see frame-type Definitions.
fitstbl (astropy.table.Table) – The table with the metadata for one or more frames to check.
exprng (list, optional) – Range in the allowed exposure time for a frame of type ftype. See pypeit.core.framematch.check_frame_exptime().

Returns:

Boolean array with the flags selecting the exposures in fitstbl that are ftype type frames.

Return type:

numpy.ndarray

compound_meta(headarr, meta_key)[source]

Methods to generate metadata requiring interpretation of the header data, instead of simply reading the value of a header card.

Parameters:

headarr (list) – List of astropy.io.fits.Header objects.
meta_key (str) – Metadata keyword to construct.

Returns:

Metadata value read from the header(s).

Return type:

object

configuration_keys()[source]

Return the metadata keys that define a unique instrument configuration.

This list is used by PypeItMetaData to identify the unique configurations among the list of frames read for a given reduction.

Returns:: List of keywords of data pulled from file headers and used to constuct the PypeItMetaData object.
Return type:: list

classmethod default_pypeit_par()[source]

Return the default parameters to use for this instrument.

Returns:: Parameters required by all of PypeIt methods.
Return type:: PypeItPar

get_detector_par(det, hdu=None)[source]

Return metadata for the selected detector.

Parameters:

det (int) – 1-indexed detector number.
hdu (astropy.io.fits.HDUList, optional) – The open fits file with the raw image of interest. If not provided, frame-dependent parameters are set to a default.

Returns:

Object with the detector metadata.

Return type:

DetectorContainer

get_rawimage(raw_file, det)[source]

Read raw images and generate a few other bits and pieces that are key for image processing.

Based on readmhdufits.pro

Parameters:

raw_file (str) – File to read
det (int) – 1-indexed detector to read

Returns:

detector_par (pypeit.images.detector_container.DetectorContainer) – Detector metadata parameters.
raw_img (numpy.ndarray) – Raw image for this detector.
hdu (astropy.io.fits.HDUList) – Opened fits file
exptime (float) – Exposure time read from the file header
rawdatasec_img (numpy.ndarray) – Data (Science) section of the detector as provided by setting the (1-indexed) number of the amplifier used to read each detector pixel. Pixels unassociated with any amplifier are set to 0.
oscansec_img (numpy.ndarray) – Overscan section of the detector as provided by setting the (1-indexed) number of the amplifier used to read each detector pixel. Pixels unassociated with any amplifier are set to 0.

header_name = 'jwst_nirspec': Name of the spectrograph camera or arm from the Header. Usually the INSTRUME card.

init_meta()[source]

Define how metadata are derived from the spectrograph files.

That is, this associates the PypeIt-specific metadata keywords with the instrument-specific header cards using meta.

name = 'jwst_nirspec': The name of the spectrograph. See Spectrographs for the currently supported spectrographs.

ndet = 2: Number of detectors for this instrument.

pypeit_file_keys()[source]

Define the list of keys to be output into a standard PypeIt file.

Returns:: The list of keywords in the relevant PypeItMetaData instance to print to the PypeIt Reduction File.
Return type:: list

supported = True: Flag that PypeIt code base has been sufficiently tested with data from this spectrograph that it is officially supported by the development team.

telescope = Parameter Value Default Type Callable -------------------------------------------------- name JWST KECK str False longitude 0.0 None int, float False latitude 0.0 None int, float False elevation 0.0 None int, float False fratio None None int, float False diameter 6.5 None int, float False eff_aperture None None int, float False : Instance of TelescopePar providing telescope-specific metadata.

url = 'https://jwst-docs.stsci.edu/jwst-near-infrared-spectrograph': Reference url