API reference

This reference is generated automatically from the docstrings in the source. It is organized by module. The most commonly used objects are re-exported at the top level of the esc_etc package, so e.g. esc_etc.Simulation and esc_etc.simulation.Simulation are the same class.

Top-level public API

esc_etc.FILTERS is the dictionary of ESC filter names (wheel slot and designation) accepted by filter=.

Simulation

A telescope, sensor, scene and coronagraph, turned into SNR and time.

Telescope

Collecting area (Lyot-stop), focal geometry, design wavelength and the resolution element resel.

Sensor

Detector noise properties, the optical bandpass, and the photometric aperture (aperture, encircled_energy) every SNR term uses.

Scene

The host star, the planet, and the zodi / exozodi backgrounds, each a SceneElement.

SceneElement

get_scene

Build a Scene from magnitudes.

Coronagraph

Raw dark-hole contrast, post-processing gain, planet separation, the FPM off-axis throughput curve, and the reference-subtraction strategy.

AnalyticCoronagraphNoiseModel

CountRates

plot_count_rates

Bar chart of count-rate contributors (e-/s): source, zodi, exozodi, speckle, and dark-current total (dark_current * num_psf_pixels).

plot_snr_vs_time

SNR vs total integration time (log-log).

plot_offaxis_throughput

Coronagraph off-axis (FPM) throughput vs planet separation (arcsec).

plot_bandpass

Instrument bandpass throughput vs wavelength (nm).

plot_spectra

Scene element spectra over 3000-9000 Angstrom.

plot_aperture

The noise/extraction aperture drawn over a pixel-integrated Airy PSF.

plot_overview

2 x 3 overview of a Simulation: count rates, SNR vs time, bandpass; off-axis throughput, aperture footprint, scene spectra.

lazuli_style

Context manager applying the lazuli style without touching global rcParams, except that interactive mode switched on inside the block (Jupyter's inline backend does this on the first figure) stays on.

use_lazuli_style

Apply the lazuli style to matplotlib's global rcParams (opt-in, mutates state).

get_data_path

Path to the packaged data directory (filter curves, vendored Lazuli configuration).

Modules