pynrc.simul.ngNRC.simulate_detector_ramp

pynrc.simul.ngNRC.simulate_detector_ramp(det, cal_obj, im_slope=None, cframe='sci', out_ADU=False, include_poisson=True, include_dark=True, include_bias=True, include_ktc=True, include_rn=True, apply_ipc=True, apply_ppc=True, include_cpink=True, include_upink=True, include_acn=True, include_refoffsets=True, include_refinst=True, include_colnoise=True, col_noise=None, amp_crosstalk=True, add_crs=True, cr_model='SUNMAX', cr_scale=1, apply_flats=None, apply_nonlinearity=True, random_nonlin=False, latents=None, rand_seed=None, return_zero_frame=None, return_full_ramp=False, prog_bar=True, super_bias=None, super_dark=None, **kwargs)[source]

Return a single simulated ramp

Parameters:

  • det (Detector Class) – Desired detector class output

  • cal_obj (nircam_cal class) – NIRCam calibration class that holds the necessary calibration info to simulate a ramp.

  • im_slope (ndarray) – Input slope image of observed scene. Can either be full frame or match det subarray. Returns det subarray shape.

  • cframe (str) – Coordinate frame of input slope image, ‘sci’ or ‘det’. Output will be in same coordinates.

Keyword Arguments:

  • return_zero_frame (bool or None) – For DMS data, particularly readout patterns with averaged frames, this returns the very first raw read in the ramp.

  • return_full_ramp (bool) – By default, we average groups and drop frames as specified in the det input. If this keyword is set to True, then return all raw frames within the ramp. The last set of nd2 drop frames are omitted.

  • out_ADU (bool) – If true, divide by gain and convert to 16-bit UINT.

  • super_bias (ndarray or None) – Option to include a custom super bias image. If set to None, then grabs from cal_obj. Can either be same shape as im_slope or full frame version. Values assumed to be in units of DN. Assumed to be in ‘det’ coordinates.

  • super_dark (ndarray or None) – Option to include a custom super dark image. If set to None, then grabs from cal_obj. Can either be same shape as im_slope or full frame version. Values assumed to be in units of DN. Assumed to be in ‘det’ coordinates.

  • include_dark (bool) – Add dark current?

  • include_bias (bool) – Add detector bias?

  • include_poisson (bool) – Include photon noise?

  • include_ktc (bool) – Add kTC noise?

  • include_rn (bool) – Add readout noise per frame?

  • include_cpink (bool) – Add correlated 1/f noise to all amplifiers?

  • include_upink (bool) – Add uncorrelated 1/f noise to each amplifier?

  • include_acn (bool) – Add alternating column noise?

  • apply_ipc (bool) – Include interpixel capacitance?

  • apply_ppc (bool) – Apply post-pixel coupling to linear analog signal?

  • include_refoffsets (bool) – Include reference offsts between amplifiers and odd/even columns?

  • include_refinst (bool) – Include reference/active pixel instabilities?

  • include_colnoise (bool) – Add in column noise per integration?

  • col_noise (ndarray or None) – Option to explicitly specifiy column noise distribution in order to shift by one for subsequent integrations

  • amp_crosstalk (bool) – Crosstalk between amplifiers?

  • add_crs (bool) – Add cosmic ray events? See Robberto et al 2010 (JWST-STScI-001928).

  • cr_model (str) – Cosmic ray model to use: ‘SUNMAX’, ‘SUNMIN’, or ‘FLARES’.

  • cr_scale (float) – Scale factor for probabilities.

  • apply_nonlinearity (bool) – Apply non-linearity? If False, then warning if out_ADU=True

  • random_nonlin (bool) – Add randomness to the linearity coefficients?

  • apply_flats (bool) – Apply sub-pixel QE variations (crosshatching and illumination)?

  • latents (None or ndarray) – (TODO) Apply persistence from previous integration.

  • prog_bar (bool) – Show a progress bar for this ramp generation?