AtmosphereModel

class nyx.core.protocols.AtmosphereModel

Bases: Module

Extinction and scattering, shared across every instrument in a scene.

Trainable quantities are the Parameter fields a subclass declares.

Methods Summary

evaluate(sky)	Extinction and scattering for the current trainable parameters.
extinct(altitudes, spectra, height_km)	Extinct point-source spectra; the default returns them unchanged.
scatter_sources(sky, source_coords, ...)	Scatter discrete point sources into the FOV; the default is none.

Methods Documentation

evaluate(sky)

Extinction and scattering for the current trainable parameters.

Parameters:

sky (SkyGeometry)

Return type:

AtmosphereResult

extinct(altitudes, spectra, height_km)

Extinct point-source spectra; the default returns them unchanged.

Parameters:

• altitudes (jax.Array, shape (n_sources, 1)) – Radians.

• spectra (jax.Array, shape (n_sources, n_wvl))

• height_km (jax.Array) – Observer height above sea level.

Return type:

jax.Array, shape (n_sources, n_wvl)

scatter_sources(sky, source_coords, source_spectra, bp)

Scatter discrete point sources into the FOV; the default is none.

Parameters:

• sky (SkyGeometry)

• source_coords (jax.Array, shape (n_sources, 2)) – AltAz in radians.

• source_spectra (jax.Array, shape (n_sources, n_wvl))

• bp (jax.Array, shape (n_wvl,)) – Instrument bandpass.

Return type:

jax.Array, shape (n_lon, n_lat), or a scalar zero

__init__()

static __new__(cls, *args, **kwargs)