Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add missing file summaries and HDU descriptions #47

Merged
merged 1 commit into from
May 9, 2018
Merged

add missing file summaries and HDU descriptions #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 9 additions & 10 deletions doc/DESIMODEL/data/focalplane/fiberpos-all.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
fiberpos-all
============

:Summary: A mapping of positioner number to fiber number. An ECSV_
version of this file might also be present.
:Summary: A mapping of positioner number to fiber number, including
positions from DESI-0530.
An ECSV_ version of this file might also be present.
:Naming Convention: ``fiberpos-all.fits``
:Regex: ``fiberpos-all\.fits``
:File Type: FITS, 472 KB
Expand All @@ -13,12 +14,12 @@ fiberpos-all
Contents
========

====== ======== ======== ===================
====== ======== ======== ==============================
Number EXTNAME Type Contents
====== ======== ======== ===================
HDU0_ PRIMARY IMAGE *Brief Description*
HDU1_ FIBERPOS BINTABLE *Brief Description*
====== ======== ======== ===================
====== ======== ======== ==============================
HDU0_ PRIMARY IMAGE Empty
HDU1_ FIBERPOS BINTABLE Fiber positions on focal plane
====== ======== ======== ==============================


FITS Header Units
Expand All @@ -29,8 +30,6 @@ HDU0

EXTNAME = PRIMARY

*Summarize the contents of this HDU.*

This HDU has no non-standard required keywords.

Empty HDU.
Expand All @@ -40,7 +39,7 @@ HDU1

EXTNAME = FIBERPOS

*Summarize the contents of this HDU.*
Fiber positions on focal plane

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 2 additions & 3 deletions doc/DESIMODEL/data/footprint/desi-tiles-randomized.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ HDU0

EXTNAME = PRIMARY

*Summarize the contents of this HDU.*

This HDU has no non-standard required keywords.

Empty HDU.
Expand All @@ -41,7 +39,8 @@ HDU1

EXTNAME = TILES

*Summarize the contents of this HDU.*
Tile centers with randomized offsets to wash out large scale patterns from
regular overlaps.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 1 addition & 3 deletions doc/DESIMODEL/data/footprint/desi-tiles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ HDU0

EXTNAME = PRIMARY

*Summarize the contents of this HDU.*

This HDU has no non-standard required keywords.

Empty HDU.
Expand All @@ -41,7 +39,7 @@ HDU1

EXTNAME = TILES

*Summarize the contents of this HDU.*
Pre-defined DESI tile locations on the sky (i.e. telescope pointings)

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
12 changes: 6 additions & 6 deletions doc/DESIMODEL/data/inputs/throughput/ZenithExtinction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ ZenithExtinction
Contents
========

====== ========== ======== ===================
====== ========== ======== ======================
Number EXTNAME Type Contents
====== ========== ======== ===================
HDU0_ PRIMARY IMAGE *Brief Description*
HDU1_ EXTINCTION BINTABLE *Brief Description*
====== ========== ======== ===================
====== ========== ======== ======================
HDU0_ PRIMARY IMAGE Empty
HDU1_ EXTINCTION BINTABLE Atmospheric Extinction
====== ========== ======== ======================


FITS Header Units
Expand All @@ -37,7 +37,7 @@ HDU1

EXTNAME = EXTINCTION

*Summarize the contents of this HDU.*
Atmospheric extinction in magnitudes per airmass.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
70 changes: 34 additions & 36 deletions doc/DESIMODEL/data/specpsf/psf-quicksim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ psf
Contents
========

====== ========== ======== ===================
====== ========== ======== =======================
Number EXTNAME Type Contents
====== ========== ======== ===================
HDU0_ PRIMARY IMAGE *Brief Description*
HDU1_ QUICKSIM-B BINTABLE *Brief Description*
HDU2_ QUICKSIM-R BINTABLE *Brief Description*
HDU3_ QUICKSIM-Z BINTABLE *Brief Description*
====== ========== ======== ===================
====== ========== ======== =======================
HDU0_ PRIMARY IMAGE Empty
HDU1_ QUICKSIM-B BINTABLE b-camera PSF parameters
HDU2_ QUICKSIM-R BINTABLE r-camera PSF parameters
HDU3_ QUICKSIM-Z BINTABLE z-camera PSF parameters
====== ========== ======== =======================


FITS Header Units
Expand All @@ -28,8 +28,6 @@ HDU0

EXTNAME = PRIMARY

*Summarize the contents of this HDU.*

This HDU has no non-standard required keywords.

Empty HDU.
Expand All @@ -39,7 +37,7 @@ HDU1

EXTNAME = QUICKSIM-B

*Summarize the contents of this HDU.*
b-camera PSF parameters.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -60,22 +58,22 @@ WAVEUNIT Angstrom str Wavelengths in Angstroms
Required Data Table Columns
~~~~~~~~~~~~~~~~~~~~~~~~~~~

================= ======= ============ ===================
================= ======= ============ ===========================================
Name Type Units Description
================= ======= ============ ===================
wavelength float64 Angstrom label for field 1
fwhm_wave float64 Angstrom label for field 2
fwhm_spatial float64 pixel label for field 3
neff_spatial float64 pixel label for field 4
angstroms_per_row float64 Angstrom/row label for field 5
================= ======= ============ ===================
================= ======= ============ ===========================================
wavelength float64 Angstrom wavelength
fwhm_wave float64 Angstrom FWHM in wavelength (y) direction
fwhm_spatial float64 pixel FWHM in cross-dispersion (x) direction
neff_spatial float64 pixel Number of effective pixels covered
angstroms_per_row float64 Angstrom/row Angstroms per CCD pixels at this wavelength
================= ======= ============ ===========================================

HDU2
----

EXTNAME = QUICKSIM-R

*Summarize the contents of this HDU.*
r-camera PSF parameters.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -96,22 +94,22 @@ WAVEUNIT Angstrom str Wavelengths in Angstroms
Required Data Table Columns
~~~~~~~~~~~~~~~~~~~~~~~~~~~

================= ======= ============ ===================
================= ======= ============ ===========================================
Name Type Units Description
================= ======= ============ ===================
wavelength float64 Angstrom label for field 1
fwhm_wave float64 Angstrom label for field 2
fwhm_spatial float64 pixel label for field 3
neff_spatial float64 pixel label for field 4
angstroms_per_row float64 Angstrom/row label for field 5
================= ======= ============ ===================
================= ======= ============ ===========================================
wavelength float64 Angstrom wavelength
fwhm_wave float64 Angstrom FWHM in wavelength (y) direction
fwhm_spatial float64 pixel FWHM in cross-dispersion (x) direction
neff_spatial float64 pixel Number of effective pixels covered
angstroms_per_row float64 Angstrom/row Angstroms per CCD pixels at this wavelength
================= ======= ============ ===========================================

HDU3
----

EXTNAME = QUICKSIM-Z

*Summarize the contents of this HDU.*
z-camera PSF parameters.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -132,15 +130,15 @@ WAVEUNIT Angstrom str Wavelengths in Angstroms
Required Data Table Columns
~~~~~~~~~~~~~~~~~~~~~~~~~~~

================= ======= ============ ===================
================= ======= ============ ===========================================
Name Type Units Description
================= ======= ============ ===================
wavelength float64 Angstrom label for field 1
fwhm_wave float64 Angstrom label for field 2
fwhm_spatial float64 pixel label for field 3
neff_spatial float64 pixel label for field 4
angstroms_per_row float64 Angstrom/row label for field 5
================= ======= ============ ===================
================= ======= ============ ===========================================
wavelength float64 Angstrom wavelength
fwhm_wave float64 Angstrom FWHM in wavelength (y) direction
fwhm_spatial float64 pixel FWHM in cross-dispersion (x) direction
neff_spatial float64 pixel Number of effective pixels covered
angstroms_per_row float64 Angstrom/row Angstroms per CCD pixels at this wavelength
================= ======= ============ ===========================================


Notes and Examples
Expand Down
57 changes: 37 additions & 20 deletions doc/DESIMODEL/data/specpsf/psf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,21 @@ psf
Contents
========

====== ======== ===== ===================
====== ======== ===== ===============================================
Number EXTNAME Type Contents
====== ======== ===== ===================
HDU0_ XCOEFF IMAGE *Brief Description*
HDU1_ YCOEFF IMAGE *Brief Description*
HDU2_ SPOTS IMAGE *Brief Description*
HDU3_ SPOTX IMAGE *Brief Description*
HDU4_ SPOTY IMAGE *Brief Description*
HDU5_ FIBERPOS IMAGE *Brief Description*
HDU6_ SPOTPOS IMAGE *Brief Description*
HDU7_ SPOTWAVE IMAGE *Brief Description*
====== ======== ===== ===================

====== ======== ===== ===============================================
HDU0_ XCOEFF IMAGE Legendre coeff for CCD x vs. wavelength
HDU1_ YCOEFF IMAGE Legendre coeff for CCD y vs. wavelength
HDU2_ SPOTS IMAGE Zemax PSF spots
HDU3_ SPOTX IMAGE CCD x locations of spots
HDU4_ SPOTY IMAGE CCD y locations of spots
HDU5_ FIBERPOS IMAGE Location of each fiber along slit
HDU6_ SPOTPOS IMAGE Locations along slit where spots were generated
HDU7_ SPOTWAVE IMAGE Wavelength of generated spots
====== ======== ===== ===============================================

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

FITS Header Units
=================
Expand All @@ -32,7 +34,7 @@ HDU0

EXTNAME = XCOEFF

*Summarize the contents of this HDU.*
Legendre coeff for CCD x vs. wavelength.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -96,7 +98,7 @@ HDU1

EXTNAME = YCOEFF

*Summarize the contents of this HDU.*
Legendre coeff for CCD y vs. wavelength.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -120,7 +122,10 @@ HDU2

EXTNAME = SPOTS

*Summarize the contents of this HDU.*
Zemax simulated spots.

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -142,7 +147,10 @@ HDU3

EXTNAME = SPOTX

*Summarize the contents of this HDU.*
X locations of spots.

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -162,7 +170,10 @@ HDU4

EXTNAME = SPOTY

*Summarize the contents of this HDU.*
Y locations of spots.

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -182,7 +193,7 @@ HDU5

EXTNAME = FIBERPOS

*Summarize the contents of this HDU.*
Location along the slit of each fiber.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -201,7 +212,10 @@ HDU6

EXTNAME = SPOTPOS

*Summarize the contents of this HDU.*
Location along the slit of each spot.

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -220,7 +234,10 @@ HDU7

EXTNAME = SPOTWAVE

*Summarize the contents of this HDU.*
Wavelengths at which each spot was measured.

SPOTS[i,j] is 2D image[y,x] of Zemax spot on the CCD at SPOTX[j], SPOTY[i]
and along the slit at SPOTPOS[i] which is wavelength SPOTWAVE[i].

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down