Source code for coronagraphoto.loaders

"""ExoVista data loader -- builds a ``skyscapes.Scene`` with a default zodi."""

from collections.abc import Sequence

import jax.numpy as jnp
from skyscapes import Scene, from_exovista
from skyscapes.background import AYOZodi




def load_scene_from_exovista(
    fits_file: str,
    planet_indices: Sequence[int] | None = None,
    only_earths: bool = False,
    zodi_surface_brightness_mag: float = 22.0,
) -> Scene:
    """Load a full :class:`skyscapes.Scene` from an ExoVista FITS file.

    Delegates system loading to :func:`skyscapes.from_exovista` and adds
    a default :class:`~skyscapes.background.AYOZodi` background using
    the host star's wavelength grid.

    The earlier ``required_planets`` parameter was removed: variadic
    planet tuples make the "pad to fixed shape" semantics unnecessary,
    and the underlying ``skyscapes.from_exovista`` no longer accepts it.

    Args:
        fits_file: Path to the ExoVista FITS file.
        planet_indices: Planet indices to load (0-based). ``None`` = all.
        only_earths: If True and ``planet_indices`` is None, auto-filter
            Earths.
        zodi_surface_brightness_mag: V-band surface brightness for the
            default zodi background. Default 22.0 (AYO standard).

    Returns:
        ``skyscapes.Scene`` with the loaded system and a default zodi
        background.
    """
    system = from_exovista(
        fits_file,
        planet_indices=planet_indices,
        only_earths=only_earths,
    )

    wavelengths_nm = jnp.asarray(system.star._wavelengths_nm)
    zodi = AYOZodi(
        wavelengths_nm=wavelengths_nm,
        surface_brightness_mag=zodi_surface_brightness_mag,
    )

    return Scene(system=system, zodi=zodi)