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
Use Coronagraphic ND acquisition square? |
|
SIAF aperture name for detector pixel to sky coords transformations |
|
Return bandpass throughput |
|
Offset position along bar mask (arcsec). |
|
Include coronagraphic substrate material? |
|
Dictionary housing detector info parameters and keywords. |
|
Detector selected for simulated PSF |
|
Detectors on which the simulated PSF could lie |
|
The pixel position in (X, Y) on the detector, relative to the currently-selected SIAF aperture subarray. |
|
Fast readout direction in sci coords |
|
Currently selected filter name (e.g. |
|
List of available filter names for this instrument |
|
Currently selected image plane mask, or None for direct imaging |
|
Observation with coronagraphic mask (incl Lyot stop)? |
|
Is a Lyot mask in the pupil wheel? |
|
|
|
Exposure timings in dictionary |
|
Number of wavelengths/PSFs to fit |
|
A dictionary capable of storing other arbitrary options, for extensibility. |
|
Detector pixel scale, in arcsec/pixel |
|
PSF parameters |
|
Filename or fits.HDUList for JWST pupil mask. |
|
Currently selected Lyot pupil mask, or None for direct imaging |
|
Filename or fits.HDUList for JWST pupil OPD. |
|
Perform quicker coeff calculation over limited bandwidth? |
|
Coefficient save directory |
|
Coefficient file name |
|
SCA ID (481, 482, . |
|
SIAF Aperture object |
|
Give all possible SIAF aperture names |
|
Slow readout direction in sci coords |
|
Wavelength range to fit |
|
Detector well level in units of electrons |