API Documentation¶
To make the generation of imaging (including moving target) simulated integrations easier, combine the 3 relevant stages of the simulator (seed image generator, dark prep, obervation generator) into a single script.
HISTORY: 13 November 2017 - created, Bryan Hilbert 13 July 2018 - updated for name change to Mirage, Bryan Hilbert
To make the generation of WFSS simulated integrations easier, combine the 4 stages of the simulator (seed image generator, disperser, dark prep, obervation generator) into a single script.
Inputs: paramfiles - List of yaml filenames. These files should be
inputs to the simulator. For details on the information contained in the yaml files, see the readme file associated with the mirage github repo: https://github.com/spacetelescope/mirage.git
- crossing_filter - Name of the crossing filter to be used in
conjunction with the grism. All longwave channel filter names are valid entries
- module - Name of the NIRCam module to use for the simulation.
Can be ‘A’ or ‘B’
- direction - Dispersion direction. Can be along rows (‘R’) or
along columns (‘C’)
- override_dark - If you wish to use a dark current file that
has already gone through the dark_prep step of the pipeline and wish to use that for the simulation, set override_dark equal to the dark’s filename. The dark_prep step will then be skipped.
HISTORY: 15 November 2017 - created, Bryan Hilbert 13 July 2018 - updated for name change to Mirage, Bryan Hilbert