simulate

romanisim.l3.simulate(shape, wcs, efftimes, filter_name, catalog, nexposures=1, metadata={}, effreadnoise=None, sky=None, psf=None, bandpass=None, seed=None, rng=None, psftype='galsim', **kwargs)

Simulate a sequence of observations on a field in different bandpasses.

Parameters:

shapetuple

Array shape of mosaic to simulate.

wcsgwcs.wcs.WCS

WCS corresponding to image. Will only work well with square pixels.

efftimesnp.ndarray or float

Time Roman spent observing each part of the sky. If an array, shape must match shape parameter.

filter_namestr

Filter to use to select appropriate flux from objlist. This is only used when achromatic PSFs and sources are being rendered.

cataloglist[CatalogObject] or Table

List of catalog objects to add to l3_mos

nexposuresint

Number of exposures on the field. Used to compute effreadnoise estimate if not explicitly set, otherwise not used.

metadatadict

Metadata structure for Roman asdf file.

effreadnoisefloat

Effective read noise for mosaic (MJy / sr)

skyfloat or array_like

Image or constant with sky and other backgrounds (MJy / sr). If None, then sky will be generated from galsim’s getSkyLevel for Roman for the date provided in metadata[‘coadd_info’][‘time_mean’].

psfgalsim.Profile or None

PSF for image

bandpassgalsim.Bandpass

Bandpass in which mosaic is being rendered. This is used only in cases where chromatic profiles & PSFs are being used.

rnggalsim.BaseDeviate

random number generator to use

psftypeOne of [‘epsf’, ‘galsim’, ‘stpsf’]

How to determine the PSF.

seedint

seed to use for random number generator

Returns:

mosaic_noderoman_datamodels WfiMosaic node

simulated mosaic

extrasdict

Dictionary of additionally valuable quantities. Includes at least simcatobj, the image positions and fluxes of simulated objects. It may also include information on persistence and cosmic ray hits.