webbpsf_ext.bandpasses.nircam_filter

webbpsf_ext.bandpasses.nircam_filter(filter, pupil=None, mask=None, module=None, ND_acq=False, ice_scale=None, nvr_scale=None, ote_scale=None, nc_scale=None, grism_order=1, coron_substrate=False, include_blocking=True, **kwargs)[source]

Read filter bandpass.

Read in filter throughput curve from file generated by STScI. Includes: OTE, NRC mirrors, dichroic, filter curve, and detector QE.

TODO: Account for pupil size reduction for DHS and grism observations.

Parameters

  • filter (str) – Name of a filter.

  • pupil (str, None) – NIRCam pupil elements such as grisms or lyot stops.

  • mask (str, None) – Specify the coronagraphic occulter (spots or bar).

  • module (str) – Module ‘A’ or ‘B’.

  • ND_acq (bool) – ND acquisition square in coronagraphic mask.

  • ice_scale (float) – Add in additional OTE H2O absorption. This is a scale factor relative to 0.0131 um thickness. Also includes about 0.0150 um of photolyzed Carbon.

  • nvr_scale (float) – Modify NIRCam non-volatile residue. This is a scale factor relative to 0.280 um thickness already built into filter throughput curves. If set to None, then assumes a scale factor of 1.0. Setting nvr_scale=0 will remove these contributions.

  • ote_scale (float) – Scale factor of OTE contaminants relative to End of Life model. This is the same as setting ice_scale. Will override ice_scale value.

  • nc_scale (float) – Scale factor for NIRCam contaminants relative to End of Life model. This model assumes 0.189 um of NVR and 0.050 um of water ice on the NIRCam optical elements. Setting this keyword will remove all NVR contributions built into the NIRCam filter curves. Overrides nvr_scale value.

  • grism_order (int) – Option to use 2nd order grism throughputs instead. Useful if someone wanted to overlay the 2nd order contributions onto a wide field observation.

  • coron_substrate (bool) – Explicit option to include coronagraphic substrate transmission even if mask=None. Gives the option of using LYOT or grism pupils with or without coron substrate.

  • include_blocking (bool) – Include wide-band blocking filter for those filters in pupil wheel. These include: ‘F162M’, ‘F164N’, ‘F323N’, ‘F405N’, ‘F466N’, ‘F470N’

Returns

pysynphot.obsbandpass – A Pysynphot bandpass object.