Calculating throughputs

All files relevant for calculating throughputs for the 4 JWST science instruments are found in the "jwst" folder of "pandeia_data". The subdirectories in this folder are "background", "detector", "miri", "nircam", "niriss", "nirspec", "source", and "telescope". Relevant subdirectories in each of the instrument folders are "filter", "optical", and "qe".

Users interested in throughputs for the various instrument modes should use the get_total_eff() function included in the Pandeia Engine. This function considers all files for relevant instrument elements and properties (listed in the sections below) and outputs the throughput across a desired wavelength range. Below is a code snippet showing the use of the get_total_eff() function.

from pandeia.engine.instrument_factory import InstrumentFactory

# set up your wavelengths
wave = [wavelengths_you_want]

# create a configured instrument
instrument_factory = InstrumentFactory(config=conf)

# where conf is a configuration dictionary for a calculation:
#     see below for examples

# get the throughput of the instrument over the desired wavelength range
eff = instrument_factory.get_total_eff(wave)

pupil = instrument_factory.psf_library.get_pupil_throughput(wave[0],conf['instrument']['instrument'],conf['instrument']['aperture'])
eff = eff * pupil

Example configuration dictionaries

For a more comprehensive list of instrument mode, disperser, and filter keys, see Pandeia Quickstart.

# MIRI Imaging

conf= {
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "fastr1",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "imager",
        "filter": "f1800w",
        "instrument": "miri",
        "mode": "imaging"
	},
}

# MIRI LRS Slit

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "fastr1",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "lrsslit",
		"disperser": "p750l",
        "instrument": "miri",
        "mode": "lrsslit"
	},
}

# NIRCam Imaging

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "deep2",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "sw",
        "disperser": "null",
        "filter": "f150w2",
        "instrument": "nircam",
        "mode": "sw_imaging"
    },
}

# NIRCam Coronagraphic Imaging

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "bright2",
        "subarray": "sub640"
    },
    "instrument": {
    	"aperture": "mask210r",
        "detector": "sw",
        "disperser": "null",
        "filter": "f210m",
        "instrument": "nircam",
        "mode": "coronagraphy"
    },
}

# NIRISS Imaging

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "nis",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "imager",
        "disperser": "null",
        "filter": "f200w",
        "instrument": "niriss",
        "mode": "imaging"
    },
}

# NIRISS SOSS

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "nisrapid",
        "subarray": "substrip96"
    },
    "instrument": {
    	"aperture": "soss",
        "disperser": "gr700xd",
        "filter": "clear",
        "instrument": "niriss",
        "mode": "soss"
    },
}

# NIRSpec IFU spectroscopy

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 10,
        "nint": 1,
        "readout_pattern": "nrs",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "ifu",
        "disperser": "g140m",
        "filter": "f100lp",
        "instrument": "nirspec",
        "mode": "ifu"
    },
}

# NIRSpec IFU Verification Imaging

conf={
	"detector": {
        "nexp": 1,
        "ngroup": 3,
        "nint": 1,
        "readout_pattern": "nrs",
        "subarray": "full"
    },
    "instrument": {
    	"aperture": "ifu__ver",
        "disperser": None,
        "filter": "f110w",
        "instrument": "nirspec",
        "mode": "ifu_ver"
    },
}

Detector

• The quantum efficiency (QE) files in this directory are not used by the ETC or the Pandeia engine. The relevant QE files for the science instruments are in the "/miri/qe", "/nircam/qe", "/niriss/qe", and "/nirspec/qe" subdirectories.

MIRI

• Words in bold are GUI menus/
  panels or data software packages; 
  bold italics are buttons in GUI
  tools or package parameters.

  As shown in the schematic in the MIRI Optics and Focal Plane article, the light path to the 4 different MRS channels is complex. Two separate wheels contain 3 dichroics for each of the 3 wavelength ranges (Short (A), Medium (B), and Long (C)). The blaze files in "/miri/blaze" have the transmission and reflection effects of the various dichroics incorporated into the files, in addition to the actual blaze functions of the dispersers themselves.
  
  

• The "/miri/filters" subdirectory files for the F1065C, F1140C, and F1550C coronagraphic filters also include the transmission effects of the germanium coatings on the 4-quadrant phase masks (4QPMs) for coronagraphic imaging. 
  
  
• The QE file for the MIRI imaging detector, "jwst_miri_imager_qe", is used for calculating throughputs for MIRI imaging, MIRI imaging time series, MIRI low resolution spectroscopy (LRS) slit, MIRI low resolution spectroscopy (LRS) slitless, and MIRI coronagraphic imaging.
  
  
• The MIRI MRS is composed of 2 separate detectors. The "jwst_miri_mrs-sw_qe" file is the relevant QE file for Channel 1 and Channel 2 of the MRS ("sw" stands for short wavelength). Similarly, "jwst_miri_mrs-lw_qe" is the relevant QE file for Channel 3 and Channel 4 of the MRS ("lw" stands for long wavelength).

NIRCam

• The "jwst_nircam_sw-lyot_trans_modmean" and "jwst_nircam_lw-lyot_trans_modmean" files in the "/nircam/optical" subdirectory are the average transmissions of module A and module B for coronagraphic imaging with the Lyot spots.
  
  

• The "jwst_nircam_wlp4" and "jwst_nircam_wlp8" optical transmission files correspond to the weak lenses, used in the NIRCam SW time-series mode.
  
  

• The "jwst_nircam_sw_dbs" and "jwst_nircam_lw_dbs" files are the dichroic beam splitter (DBS) for each channel which directs incoming illumination to the shortwave (SW) or longwave (LW) channel.
  
  
• The "jwst_nircam_moda_com_substrate_trans" is for the coronagraphic optical substrate for Module A which is used for coronagraphic imaging mode. 
  
  
• The "jwst_nircam_sw_qe" and "jwst_nircam_lw_qe" files apply to any observations made from 0.6 to 2.3 μm (detectors NRCA1-NRCA4, and NRCB1-NRCB4) and 2.4 to 5.0 μm (detector NRCA5 and NRCB5), respectively.

NIRISS

• The "jwst_niriss_nrm_trans" file under the "filter" subdirectory is used for the aperture masking interferometry (AMI) mode. "nrm" refers to the non-redundant mask that enables the AMI mode.
  
  

• Two options are available in the "/niriss/optical" subdirectory:
  • "jwst_niriss_internaloptics_throughput": Used when neither the CLEAR nor CLEARP slots are selected in the filter and pupil wheels, respectively.
  • "jwst_niriss_internaloptics-clear_throughput": Used when the CLEAR slot is selected in the filter wheel and a filter or grating is selected in the pupil wheel.
    
    

NIRSpec

• Under "/nirspec/optical", the "jwst_nirspec_mos_internaloptics_throughput" file is applicable to the fixed slits and the bright object time-series modes. "jwst_nirspec_ifu_internaloptics_throughput" is only applicable to the IFU mode.
  
  

• The files in "/nirspec/blaze" and "/nirspec/filter" contain pre-launch measurements of the transmission of those optical elements. The "/nirspec/cf" directory contains correction files to be applied to filter+disperser combinations, as they cannot be measured separately on-orbit.

Telescope

• The "telescope" subdirectory contains the throughput of the optical telescope element (OTE), "jwst_telescope_ote_thruput". This file is relevant for calculating throughputs for all observing modes since all light first passes through the OTE before entering the optical paths of the science instruments.