Skip to content

Commit

Permalink
Add new entry to example yaml file doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bhilbert4 committed Nov 30, 2021
1 parent 798e6c9 commit c78e352
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/example_yaml.rst
Expand Up @@ -31,6 +31,7 @@ Below is an example yaml input file for *Mirage*. The yaml file used as the prim
nint_: 1 #Number of integrations per exposure
array_name_: NRCB5_FULL #Name of array (FULL, SUB160, SUB64P, etc)
intermediate_aperture_: None # Name of intermediate aperture used in NIRCam Grism time series obs.
PPS_aperture_: NRCB5_FULL # Original aperture value supplied by PPS.
filter_: F250M #Filter of simulated data (F090W, F322W2, etc)
pupil_: CLEAR #Pupil element for simulated data (CLEAR, GRISMC, etc)
Expand Down Expand Up @@ -258,6 +259,17 @@ Intermediate Aperture

This is the name of the intermediate aperture designated by APT to control the telescope pointing during Grism Time Series observations. The intermediate aperture specifies the location of the target prior to inserting the grism into the beam. When the grism is placed in the beam, the target's trace will be offset from this location by a few tens of rows. The intermediate aperture is defined such that the target's trace will land at the reference location of the user-specified aperture. This is only used for Grism Time Series observations, including the shortwave imaging mode data that accompany the dispersed longwave data. For all other observations, this will be set to None, and ignored.


.. _PPS_aperture:

PPS_aperture
++++++++++++

*Readout:PPS_aperture*

This is the name of the aperture as supplied by PPS (i.e. in the APT pointing file). The value of this may include apertures that are not specific to one detector (e.g. NRCBS_FULL).


.. _filter:

Filter
Expand Down

0 comments on commit c78e352

Please sign in to comment.