liger_iris_sim.expose.throughput

Functions

compute_throughput([instrument_name, ...])

Compute the total throughput for the given mode and wavelength.

get_filter_throughput(filter_name[, wave])

Get the filter throughput at a given wavelength or array of wavelengths.
compute_throughput(instrument_name: str | None = None, instrument_mode: str | None = None, wave: float | None = None, ifs_mode: str | None = None, instrument_only: bool = False, tel: float = 0.8, ao: float = 0.65, filt: float | str = None, inst: float | None = None) → float[source]

Compute the total throughput for the given mode and wavelength.

Parameters:

  • instrument_name (str | None) – The instrument name (‘Liger’ or ‘IRIS’).

  • instrument_mode (str | None) – The mode (‘img’, ‘ifs’).

  • wave (float | None) – The wavelength in microns.

  • ifs_mode (str | None) – The IFS mode (‘slicer’, ‘lenslet’) if mode is ‘ifs’. Must be provided if mode is ‘ifs’.

  • instrument_only (bool) – If True, return only the instrument throughput. Default is False.

  • tel (float) – The telescope throughput. Default is 0.8.

  • ao (float) – The AO throughput. Default is 0.65.

  • filt (float | str) – The filter throughput. Default is the maximum filter throughput.

get_filter_throughput(filter_name: str, wave: float | None = None) → tuple[float | ndarray, float | ndarray][source]

Get the filter throughput at a given wavelength or array of wavelengths.

Parameters:

  • filter_name (str) – The name of the filter.

  • wave (float | np.ndarray, optional) – The wavelength(s) in microns at which to evaluate the filter throughput. If None, the wavelength at which the filter transmission is maximum will be used. Default is None.

Returns:

  • wave (float | np.ndarray) – The wavelength in microns at which the filter throughput is evaluated.

  • tput_filt (float | np.ndarray) – The filter throughput at the specified wavelength(s).