Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for ETC 3.1

...

Warning
titleAPI Compatibility

The Pandeia Engine API may change at any time. The following information and examples are for Pandeia Engine 3.01.x only, and are not guaranteed to be accurate or functional for previous or future releases. Updates (and information about planned pending API changes) can be found on the Pandeia Engine News page.

...

The full API documentation, with all possible options and combinations for any instrument, can be found in engine_input_api_3.01.rst

Examples


The following calculation defines a JWST NIRCam observation in SW Imaging mode using the full subarray and rapid readout pattern and f070w filter, for a flat-spectrum (in fnu) point source normalized to 0.001 mJy, intended to be observed with a 0.2" aperture. Note that it specifies a background precomputed for the JWST minzodi benchmark position; actual user-configured backgrounds are available in the JWST Webapp (and can be downloaded from there)

...

(click here to download as a JSON file: imaging_f062_medium8hlwas_defocusimaging_smallfull.jeng)

Code Block
languagejs
titleRoman WFI Imaging
collapsetrue
{
    "background": "minzodi",
    "background_level": "benchmark",
    "calculation": {
        "effects": {
            "saturation": null
        },
        "noise": {
            "crs": null,
            "dark": null,
            "excess": null,
            "ffnoise": null,
            "readnoise": null,
            "scatter": null
        }
    },
    "configuration": {
        "detector": {
            "nexpma_table_name": 1,
            "ngroup": 10"hlwas_imaging",
            "nintnexp": 1,
            "readout_patternnresultants": "medium8"5,
            "subarray": "defocus_smallfull"
        },
        "instrument": {
            "aperture": "imaging",
            "disperser": null,
            "filter": "f062",
            "instrument": "wfi",
            "mode": "imaging"
        }
    },
    "scene": [
        {
            "position": {
                "orientation": 0.0,
                "x_offset": 0.0,
                "y_offset": 0.0
            },
            "shape": {
                "geometry": "point"
            },
            "spectrum": {
                "extinction": {
                    "bandpass": "j",
                    "law": "mw_rv_31",
                    "unit": "mag",
                    "value": 0.0
                },
                "extinction_first": true,
                "lines": [],
                "name": "generic source",
                "normalization": {
                    "norm_flux": 0.001,
                    "norm_fluxunit": "mjy",
                    "norm_wave": 2.0,
                    "norm_waveunit": "microns",
                    "type": "at_lambda"
                },
                "redshift": 0.0,
                "sed": {
                    "sed_type": "flat",
                    "unit": "fnu",
                    "z": 0.0
                }
            }
        }
    ],
    "strategy": {
        "aperture_size": 0.2,
        "background_subtraction": true,
        "display_string": "Imaging Aperture Photometry",
        "is_aperture_ee": false,
        "method": "imagingapphot",
        "sky_annulus": [
            0.4,
            0.6
        ],
        "target_source": "1",
        "target_type": "coords",
        "target_xy": [
            0.0,
            0.0
        ],
        "units": "arcsec"
    }
}

...