InstrumentParameters

class VSPEC.params.InstrumentParameters(telescope: SingleDishParameters | CoronagraphParameters, bandpass: BandpassParameters, detector: DetectorParameters)

Bases: BaseParameters

Class to store instrument parameters for observations.

Parameters:

• telescope (TelescopeParameters) – The telescope parameters for the instrument.

• bandpass (BandpassParameters) – The bandpass parameters for the instrument.

• detector (DetectorParameters) – The detector parameters for the instrument.

telescope

The telescope parameters for the instrument.

Type:

TelescopeParameters

bandpass

The bandpass parameters for the instrument.

Type:

BandpassParameters

detector

The detector parameters for the instrument.

Type:

DetectorParameters

Methods Summary

from_preset(name)	Load a BaseParameters instance from a preset file.
mirecle()	2m MIRECLE setup [1].
miri_lrs()
niriss_soss()

Methods Documentation

classmethod from_preset(name)

Load a BaseParameters instance from a preset file.

Parameters:

name (str) – The name of the preset to load.

Returns:

The class instance loaded from a preset.

Return type:

BaseParameters

classmethod mirecle()

2m MIRECLE setup [1]. Returns an InstrumentParameters instance initialized with the 2m MIRECLE setup.

Returns:

InstrumentParameters instance for the 2m MIRECLE setup.

Return type:

InstrumentParameters

References

[1] Mandell et al. [2022]

classmethod miri_lrs()

classmethod niriss_soss()