simulate_crs

romanisim.cr.simulate_crs(image, time, flux=None, area=None, conversion_factor=None, pixel_size=None, pixel_depth=None, rng=None, seed=47)

Adds CRs to an existing image.

Parameters:
image2-d array of floats

The detector image with values in units of electrons.

timefloat

The exposure time, units of s.

fluxfloat

Cosmic ray flux, units of cm^-2 s^-1. Default value of 8 is equal to the value assumed by the JWST ETC.

areafloat

The area of the WFI detector, units of cm^2.

conversion_factorfloat

The convert from eV to electrons, assumed to be the bandgap energy, in units of eV / electrons.

pixel_sizefloat

The size of an individual pixel in the detector, units of micron.

pixel_depthfloat

The depth of an individual pixel in the detector, units of micron.

rngnp.random.Generator

Random number generator to use

seedint

seed to use for random number generator

Returns:
image2-d array of floats

The detector image, in units of electrons, updated to include all of the generated cosmic ray hits.