Skip to content

Commit 1aaf593

Browse files
weaverba137weaverba137
committed
add stub for gfa summary file
1 parent 6684057 commit 1aaf593

File tree

3 files changed

+349
-0
lines changed

3 files changed

+349
-0
lines changed

‎doc/DESI_ROOT/survey/GFA/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
===
2+
GFA
3+
===
4+
5+
GFA analysis summary files produced by `gfa_reduce`_
6+
7+
.. _`gfa_reduce`: https://github.com/desihub/gfa_reduce
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
12+
offline_matched_coadd_ccds_SURVEY.rst

‎doc/DESI_ROOT/survey/GFA/offline_matched_coadd_ccds_SURVEY.rst

+336
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,336 @@
1+
===============================
2+
offline_matched_coadd_ccds_main
3+
===============================
4+
5+
:Summary: *This section should be filled in with a high-level description of
6+
this file. In general, you should remove or replace the emphasized text
7+
(\*this text is emphasized\*) in this document.*
8+
:Naming Convention: ``offline_matched_coadd_ccds_main-thru_20241117.fits``, where ... *Give a human readable
9+
description of the filename, e.g. ``blat-{EXPID}`` where ``{EXPID}``
10+
is the 8-digit exposure ID.*
11+
:Regex: ``offline_matched_coadd_ccds_main-thru_20241117.fits`` *Give a regular expression for this filename.
12+
For example, a six-digit number would correspond to ``[0-9]{6}``.*
13+
:File Type: FITS, 250 MB *This section gives the type of the file
14+
and its approximate size.*
15+
16+
Contents
17+
========
18+
19+
====== ======= ======== ===================
20+
Number EXTNAME Type Contents
21+
====== ======= ======== ===================
22+
HDU0_ IMAGE *Brief Description*
23+
HDU1_ BINTABLE *Brief Description*
24+
HDU2_ BINTABLE *Brief Description*
25+
HDU3_ BINTABLE *Brief Description*
26+
====== ======= ======== ===================
27+
28+
29+
FITS Header Units
30+
=================
31+
32+
HDU0
33+
----
34+
35+
*Summarize the contents of this HDU.*
36+
37+
This HDU has no non-standard required keywords.
38+
39+
Empty HDU.
40+
41+
HDU1
42+
----
43+
44+
*Summarize the contents of this HDU.*
45+
46+
Required Header Keywords
47+
~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
.. collapse:: Required Header Keywords Table
50+
51+
.. rst-class:: keywords
52+
53+
====== ============= ==== =====================
54+
KEY Example Value Type Comment
55+
====== ============= ==== =====================
56+
NAXIS1 1749 int length of dimension 1
57+
NAXIS2 140700 int length of dimension 2
58+
====== ============= ==== =====================
59+
60+
Required Data Table Columns
61+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
62+
63+
.. rst-class:: columns
64+
65+
============================ =========== ===== ================================================================================
66+
Name Type Units Description
67+
============================ =========== ===== ================================================================================
68+
MEDIAN float64
69+
MEAN float64
70+
N_NON_FINITE int64
71+
MAX float64
72+
MIN float64
73+
SIG_ROBUST float64
74+
SIG float64
75+
MEDIAN_Q1 float64
76+
MEAN_Q1 float64
77+
N_NON_FINITE_Q1 int64
78+
MAX_Q1 float64
79+
MIN_Q1 float64
80+
SIG_ROBUST_Q1 float64
81+
SIG_Q1 float64
82+
MEDIAN_Q2 float64
83+
MEAN_Q2 float64
84+
N_NON_FINITE_Q2 int64
85+
MAX_Q2 float64
86+
MIN_Q2 float64
87+
SIG_ROBUST_Q2 float64
88+
SIG_Q2 float64
89+
MEDIAN_Q3 float64
90+
MEAN_Q3 float64
91+
N_NON_FINITE_Q3 int64
92+
MAX_Q3 float64
93+
MIN_Q3 float64
94+
SIG_ROBUST_Q3 float64
95+
SIG_Q3 float64
96+
MEDIAN_Q4 float64
97+
MEAN_Q4 float64
98+
N_NON_FINITE_Q4 int64
99+
MAX_Q4 float64
100+
MIN_Q4 float64
101+
SIG_ROBUST_Q4 float64
102+
SIG_Q4 float64
103+
CAMERA char[6] Camera identifier. Passband and SPECGRPH ([brz][0-9]).
104+
EXTNAME char[6]
105+
CONTRAST float64
106+
SKY_MAG_AB float64
107+
SKY_MAG_AB_SUBREGION float64
108+
SKY_MAG_AB_PER_AMP float32[4]
109+
PETAL_LOC binary Petal location [0-9]
110+
EXPID int64 DESI Exposure ID number
111+
MJD float64 d Modified Julian Date when shutter was opened for this exposure
112+
LST_DEG float64
113+
MOON_ILLUMINATION float64
114+
PROGRAM char[88] DESI program type - BRIGHT, DARK, BACKUP, OTHER
115+
SKYRA float64
116+
SKYDEC float64
117+
ZENITH_DIST_DEG float64
118+
DOMSHUTL char[8]
119+
DOMSHUTU char[8]
120+
PMCOVER char[8]
121+
MOONRA float64
122+
MOONDEC float64
123+
MOON_ZD_DEG float64
124+
T_C_FOR_DARK float64
125+
T_C_FOR_DARK_IS_GUESS int64
126+
TIME_S_FOR_DARK float64
127+
NIGHT int64 Night of observation (YYYYMMDD) starting at local noon before observations start
128+
FOCUS char[39]
129+
EXPTIME float64 s Length of time shutter was open
130+
CUBE_INDEX int64
131+
COADD_INDEX_START int64
132+
COADD_INDEX_END int64
133+
COADD_MJDOBS_MIN float64
134+
COADD_MJDOBS_MAX float64
135+
RACEN float64
136+
DECCEN float64
137+
FNAME_RAW char[76]
138+
GITREV char[7]
139+
FIBER_FRACFLUX float64
140+
FIBER_FRACFLUX_ELG float64
141+
FIBER_FRACFLUX_BGS float64
142+
N_SOURCES_FOR_PSF int64
143+
APER_CORR_FAC float64
144+
XCENTROID_PSF float64
145+
YCENTROID_PSF float64
146+
PSF_FWHM_PIX float64
147+
PSF_FWHM_ASEC float64
148+
PSF_CENTROID_CBOX float64
149+
PSF_CENTROID_FAILED int64
150+
RADPROF_FWHM_ASEC float64
151+
PSF_CENTROIDING_FLAG int64
152+
PSF_ASYMMETRY_RATIO float32
153+
PSF_ASYMMETRY_NUMERATOR float32
154+
PSF_ASYMMETRY_DENOMINATOR float32
155+
PSF_TOTAL_FLUX float32
156+
PROFILE_RADIUS_PIX float32[26]
157+
PSF_RADIAL_PROFILE float32[26]
158+
MOUNTHA_HEADER float64
159+
MOUNTDEC_HEADER float64
160+
HA_DEG float64
161+
HA_DEG_PER_GFA float64
162+
MOON_SEP_DEG float64
163+
ZD_DEG_PER_GFA float64
164+
HEADER_AIRMASS float64
165+
AIRMASS float64 Average airmass during this exposure
166+
AIRMASS_PER_GFA float64
167+
ZP_ADU_PER_S float64
168+
N_STARS_FOR_ZP int64
169+
TRANSPARENCY float64
170+
KTERM float32
171+
FRACFLUX_NOMINAL_POINTSOURCE float32
172+
FRACFLUX_NOMINAL_ELG float32
173+
FRACFLUX_NOMINAL_BGS float32
174+
DET_SN_THRESH float64
175+
NPIX_BAD_TOTAL int64
176+
NPIX_BAD_PER_AMP int64[4]
177+
OVERSCAN_MEDIANS_ADU float32[4]
178+
PRESCAN_MEDIANS_ADU float32[4]
179+
FWHM_MAJOR_PIX float64
180+
FWHM_MINOR_PIX float64
181+
FWHM_PIX float64
182+
FWHM_ASEC float64
183+
N_SOURCES int64
184+
N_SOURCES_FOR_SHAPE int64
185+
NAXIS int64[2]
186+
CD float64[4]
187+
CDELT float64[2]
188+
CRPIX float64[2]
189+
CRVAL float64[2]
190+
CTYPE char[16]
191+
LONGPOLE float64
192+
LATPOLE float64
193+
PV2 float64[2]
194+
FNAME_MASTER_DARK char[112]
195+
DO_FIT_DARK_SCALING binary
196+
MASTER_DARK_EXPTIME float64
197+
MASTER_DARK_GCCDTEMP float64
198+
DARK_TEMP_SCALING_FACTOR float64
199+
TOTAL_DARK_SCALING_FACTOR float64
200+
DARK_RESCALE_FACTORS_PER_AMP float64[4]
201+
DARK_RESCALE_FACTOR_BESTFIT float64
202+
DARK_RESCALE_FACTOR_ADOPTED float64
203+
APPLY_DARK_RESCALE_FACTOR binary
204+
DARK_RESCALE_NCALLS int64[4]
205+
DARK_RESCALE_CONVERGED binary[4]
206+
REQ_MJD_MIN float64
207+
REQ_MJD_MAX float64
208+
N_PMGSTARS_ALL int64
209+
N_PMGSTARS_RETAINED int64
210+
FIBERFAC float64
211+
FIBERFAC_ELG float64
212+
FIBERFAC_BGS float64
213+
SPECTRO_EXPID int64
214+
============================ =========== ===== ================================================================================
215+
216+
HDU2
217+
----
218+
219+
*Summarize the contents of this HDU.*
220+
221+
Required Header Keywords
222+
~~~~~~~~~~~~~~~~~~~~~~~~
223+
224+
.. collapse:: Required Header Keywords Table
225+
226+
.. rst-class:: keywords
227+
228+
====== ============= ==== =====================
229+
KEY Example Value Type Comment
230+
====== ============= ==== =====================
231+
NAXIS1 364 int length of dimension 1
232+
NAXIS2 23290 int length of dimension 2
233+
====== ============= ==== =====================
234+
235+
Required Data Table Columns
236+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
237+
238+
.. rst-class:: columns
239+
240+
============================ ======== ===== ================================================================================
241+
Name Type Units Description
242+
============================ ======== ===== ================================================================================
243+
EXPID int64 DESI Exposure ID number
244+
CUBE_INDEX int64
245+
NIGHT int64 Night of observation (YYYYMMDD) starting at local noon before observations start
246+
EXPTIME float64 s Length of time shutter was open
247+
FNAME_RAW char[76]
248+
SKYRA float64
249+
SKYDEC float64
250+
PROGRAM char[88] DESI program type - BRIGHT, DARK, BACKUP, OTHER
251+
MOON_ILLUMINATION float64
252+
MOON_ZD_DEG float64
253+
MOON_SEP_DEG float64
254+
KTERM float32
255+
FRACFLUX_NOMINAL_POINTSOURCE float32
256+
FRACFLUX_NOMINAL_ELG float32
257+
FRACFLUX_NOMINAL_BGS float32
258+
MJD float64 d Modified Julian Date when shutter was opened for this exposure
259+
FWHM_ASEC float64
260+
TRANSPARENCY float64
261+
SKY_MAG_AB float64
262+
FIBER_FRACFLUX float64
263+
FIBER_FRACFLUX_ELG float64
264+
FIBER_FRACFLUX_BGS float64
265+
AIRMASS float64 Average airmass during this exposure
266+
RADPROF_FWHM_ASEC float64
267+
FIBERFAC float64
268+
FIBERFAC_ELG float64
269+
FIBERFAC_BGS float64
270+
MINCONTRAST float64
271+
MAXCONTRAST float64
272+
============================ ======== ===== ================================================================================
273+
274+
HDU3
275+
----
276+
277+
*Summarize the contents of this HDU.*
278+
279+
Required Header Keywords
280+
~~~~~~~~~~~~~~~~~~~~~~~~
281+
282+
.. collapse:: Required Header Keywords Table
283+
284+
.. rst-class:: keywords
285+
286+
====== ============= ==== =====================
287+
KEY Example Value Type Comment
288+
====== ============= ==== =====================
289+
NAXIS1 364 int length of dimension 1
290+
NAXIS2 23142 int length of dimension 2
291+
====== ============= ==== =====================
292+
293+
Required Data Table Columns
294+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
295+
296+
.. rst-class:: columns
297+
298+
============================ ======== ===== ================================================================================
299+
Name Type Units Description
300+
============================ ======== ===== ================================================================================
301+
EXPID int64 DESI Exposure ID number
302+
CUBE_INDEX int64
303+
NIGHT int64 Night of observation (YYYYMMDD) starting at local noon before observations start
304+
EXPTIME float64 s Length of time shutter was open
305+
FNAME_RAW char[76]
306+
SKYRA float64
307+
SKYDEC float64
308+
PROGRAM char[88] DESI program type - BRIGHT, DARK, BACKUP, OTHER
309+
MOON_ILLUMINATION float64
310+
MOON_ZD_DEG float64
311+
MOON_SEP_DEG float64
312+
KTERM float32
313+
FRACFLUX_NOMINAL_POINTSOURCE float32
314+
FRACFLUX_NOMINAL_ELG float32
315+
FRACFLUX_NOMINAL_BGS float32
316+
MJD float64 d Modified Julian Date when shutter was opened for this exposure
317+
FWHM_ASEC float64
318+
TRANSPARENCY float64
319+
SKY_MAG_AB float64
320+
FIBER_FRACFLUX float64
321+
FIBER_FRACFLUX_ELG float64
322+
FIBER_FRACFLUX_BGS float64
323+
AIRMASS float64 Average airmass during this exposure
324+
RADPROF_FWHM_ASEC float64
325+
FIBERFAC float64
326+
FIBERFAC_ELG float64
327+
FIBERFAC_BGS float64
328+
MINCONTRAST float64
329+
MAXCONTRAST float64
330+
============================ ======== ===== ================================================================================
331+
332+
333+
Notes and Examples
334+
==================
335+
336+
*Add notes and examples here. You can also create links to example files.*

‎doc/DESI_ROOT/survey/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Subdirectories:
1010
:maxdepth: 1
1111

1212
fiberassign/index
13+
GFA/index

0 commit comments

Comments
 (0)