pynrc.simul.ngNRC.gen_dark_ramp

pynrc.simul.ngNRC.gen_dark_ramp(dark, out_shape, tf=10.73677, gain=1, ref_info=None, avg_ramp=None, include_poisson=True, rand_seed=None, **kwargs)[source]

Assumes a constant dark current rate, either in image form or single value. If gain is supplied, then input is assumed to be in DN/sec, otherwise e-/sec. Output will be e-.

Parameters

  • dark (ndarray or float) – Dark slope image or constant value. Assumed to be DN/sec. If gain=1, then also e-/sec. If this value is intended to be e-/sec, then simply set gain=1.

  • out_shape (tuple, list, ndarray) – Desired shape of output ramp (nframes, ny, nx). If dark is an array, then dark.shape == out_shape[1:] == (ny,nx).

  • tf (float) – Frame time in seconds

  • gain (float) – Gain of detector in e-/sec. If specified to be other than 1, then we assume dark to be in units of DN/sec.

  • avg_ramp (ndarray) – Time-dependent flux of average dark ramp.