scopesim.effects.spectral_trace_list module

Effect for mapping spectral cubes to the detector plane

The Effect is called SpectralTraceList, it applies a list of optics.spectral_trace_SpectralTrace objects to a FieldOfView.

class scopesim.effects.spectral_trace_list.SpectralTraceList(**kwargs)

Bases: Effect

List of spectral trace geometries for the detector plane

Should work in concert with an ApertureList (or ApertureMask) object and a DetectorList object

Spectral trace patterns are to be kept in a fits.HDUList with one or more fits.BinTableHDU extensions, each one describing the geometry of a single trace. The first extension should be a BinTableHDU connecting the traces to the correct Aperture and ImagePlane objects.

The fits.HDUList objects can be loaded using one of these two keywords:

• filename: for on disk FITS files, or

• hdulist: for in-memory fits.HDUList objects

The format and contents of the extensions in the HDUList (FITS file) object is listed below

apply_to(obj, **kwargs)

Interface between FieldOfView and SpectralTraceList

This is called twice: 1. During setup of the required FieldOfView objects, the SpectralTraceList is asked for the source space volumes that it requires (spatial limits and wavelength limits). 2. During “observation” the method is passed a single FieldOfView object and applies the mapping to the image plane to it. The FieldOfView object is associated to one SpectralTrace from the list, identified by meta[‘trace_id’].

property footprint

Return the footprint of the entire SpectralTraceList

get_fov_headers(sky_header, **kwargs)

get_waveset(pixel_size=None)

property image_plane_header

make_spectral_traces()

Returns a dictionary of spectral traces read in from a file

plot(wave_min=None, wave_max=None, **kwargs)

class scopesim.effects.spectral_trace_list.SpectralTraceListWheel(**kwargs)

Bases: Effect

A Wheel-Effect object for selecting between multiple gratings/grisms

See SpectralTraceList for the trace file format description.

Parameters:

trace_list_nameslist

The list of unique identifiers in the trace filenames

filename_formatstr

f-string that directs scopesim to the folder containing the trace files. This can be a !-string if the trace names are shared with other *Wheel effect objects (e.g. a FilterWheel). See examples.

current_trace_liststr

default trace file to use

kwargskey-value pairs

Addition keywords that are passed to the SpectralTraceList objects See SpectralTraceList docstring

Examples

A simplified YAML file example taken from the OSIRIS instrument package:

alias: INST
name: OSIRIS_LSS

properties:
  decouple_detector_from_sky_headers: True
  grism_names:
    - R300B
    - R500B
    - R1000B
    - R2500V

effects:
  - name: spectral_trace_wheel
    description: grism wheel contining spectral trace geometries
    class: SpectralTraceListWheel
    kwargs:
      current_trace_list: "!OBS.grating_name"
      filename_format: "traces/LSS_{}_TRACE.fits"
      trace_list_names: "!INST.grism_names"

  - name: grating_efficiency
    description: OSIRIS grating efficiency curves, piggybacking on FilterWheel
    class: FilterWheel
    kwargs:
      minimum_throughput: !!float 0.
      filename_format: "gratings/{}.txt"
      current_filter: "!OBS.grating_name"
      filter_names: "!INST.grism_names"

apply_to(obj, **kwargs)

Use apply_to of current trace list

property current_trace_list

property display_name