pynrc.nrc_utils.build_mask_detid¶

pynrc.nrc_utils.build_mask_detid(detid, oversample=1, ref_mask=None, pupil=None, filter=None, nd_squares=True, mask_holder=True)[source]¶

Create mask image for a given detector

Return a full coronagraphic mask image as seen by a given SCA. +V3 is up, and +V2 is to the left.

Parameters

detid (str) – Name of detector, ‘A1’, A2’, … ‘A5’ (or ‘ALONG’), etc.
oversample (float) – How much to oversample output mask relative to detector sampling.
ref_mask (str or None) – Reference mask for placement of coronagraphic mask elements. If None, then defaults are chosen for each detector.
pupil (str or None) – Which Lyot pupil stop is being used? This affects holder placement. If None, then defaults based on ref_mask.