Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update to ETC 3.0

...

Warning
titleAPI Compatibility

The Pandeia Engine API may change at any time. The following information and examples are for Pandeia Engine 23.0.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 command above produces the NIRCam SW Imaging calculation below, and then runs it through the engine. "results" will be a dictionary, defined in the Output API documentation

...

titleAPI Default

...

Load a calculation from the JWST Webapp

...

The full API documentation, with all possible options and combinations for any instrument, can be found in this link. engine_input_api_3.0.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)

...

Code Block
languagejs
titleJWST NIRCam SW 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": {
            "nexp": 1,
            "ngroup": 10,
            "nint": 1,
            "readout_pattern": "rapid",
            "subarray": "full"
        },
        "instrument": {
            "aperture": "sw",
            "disperser": null,
            "filter": "f070w",
            "instrument": "nircam",
            "mode": "sw_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
                },
                "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.1,
        "background_subtraction": true,
        "display_string": "Imaging Aperture Photometry",
        "is_aperture_ee": false,
        "method": "imagingapphot",
        "sky_annulus": [
            0.22,
            0.4
        ],
        "target_source": "1",
        "target_type": "coords",
        "target_xy": [
            0.0,
            0.0
        ],
        "units": "arcsec"
    }
} 


The following dictionary defines a Roman WFI Imaging observation with the F062 filter, defocus_small subarray (for a 3.66s read time), medium8 readout pattern, and 6 groups; for a 0.001 mJy flat-spectrum point source (in fnu) intended to be observed with a 0.2" aperture.

...