pynrc.nrc_hci

NIRCam coronagraphy (and direct imaging)

Subclass of the NIRCam instrument class with updates for PSF generation of off-axis PSFs. If a coronagraph is not present, then this is effectively the same as the NIRCam class.

Parameters

• wind_mode (str) – ‘FULL’, ‘STRIPE’, or ‘WINDOW’

• xpix (int) – Size of the detector readout along the x-axis. The detector is assumed to be in window mode unless the user explicitly sets wind_mode=’FULL’.

• ypix (int) – Size of the detector readout along the y-axis. The detector is assumed to be in window mode unless the user explicitly sets wind_mode=’FULL’.

• large_grid (bool) – Use a large number (high-density) of grid points to create coefficients. If True, then produces a higher fidelity PSF variations across the FoV, but will take much longer to genrate on the first pass and requires more disk space and memory while running.

• bar_offset (float) – Custom offset position along bar mask (-10 to +10 arcsec).

• use_ap_info (bool) – For subarray observations, the mask reference points are not actually in the center of the array. Set this to true to shift the sources to actual aperture reference location. Default is to place in center of array.

• autogen_coeffs (bool) – Automatically generate base PSF coefficients. Equivalent to performing self.gen_psf_coeff(). gen_wfedrift_coeff, and gen_wfemask_coeff. Default: True.

• sgd_type (str or None) – Small grid dither pattern. Valid types are ‘9circle’, ‘5box’, ‘5diamond’, ‘3bar’, or ‘5bar’. If ‘auto’, then defaults are ‘5diamond’ for round masks, ‘5bar’ for bar masks, and ‘5diamond’ for direct imaging. If None, then no FSM pointings, but there will be a single slew.

• fsm_std (float) – One-sigma accuracy per axis of fine steering mirror positions. This provides randomness to each position relative to the nominal central position. Ignored for central position. Values should be in units of mas.

• slew_std (float) – One-sigma accuracy per axis of the initial slew. This is applied to all positions and gives a baseline offset relative to the desired mask center. *Values should be in units of mas*

Module Attributes

LONG_WAVELENGTH_MAX
LONG_WAVELENGTH_MIN
ND_acq	Use Coronagraphic ND acquisition square?
SHORT_WAVELENGTH_MAX
SHORT_WAVELENGTH_MIN
aperturename	SIAF aperture name for detector pixel to sky coords transformations
bandpass	Return bandpass throughput
bar_offset	Offset position along bar mask (arcsec).
channel
coron_substrate	Include coronagraphic substrate material?
det_info	Dictionary housing detector info parameters and keywords.
detector	Detector selected for simulated PSF
detector_list	Detectors on which the simulated PSF could lie
detector_position	The pixel position in (X, Y) on the detector, relative to the currently-selected SIAF aperture subarray.
fastaxis	Fast readout direction in sci coords
filter	Currently selected filter name (e.g.
filter_list	List of available filter names for this instrument
fov_pix
image_mask	Currently selected image plane mask, or None for direct imaging
is_coron	Observation with coronagraphic mask (incl Lyot stop)?
is_dark
is_grism
is_lyot	Is a Lyot mask in the pupil wheel?
module
multiaccum	multiaccum object
multiaccum_times	Exposure timings in dictionary
name
ndeg
npsf	Number of wavelengths/PSFs to fit
options	A dictionary capable of storing other arbitrary options, for extensibility.
oversample
pixelscale	Detector pixel scale, in arcsec/pixel
psf_info	PSF parameters
pupil	Filename or fits.HDUList for JWST pupil mask.
pupil_mask	Currently selected Lyot pupil mask, or None for direct imaging
pupilopd	Filename or fits.HDUList for JWST pupil OPD.
quick	Perform quicker coeff calculation over limited bandwidth?
save_dir	Coefficient save directory
save_name	Coefficient file name
scaid	SCA ID (481, 482, .
siaf_ap	SIAF Aperture object
siaf_ap_names	Give all possible SIAF aperture names
slowaxis	Slow readout direction in sci coords
telescope
wave_fit	Wavelength range to fit
well_level	Detector well level in units of electrons