1 package nom.tam.fits.header.extra;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import nom.tam.fits.header.FitsKey;
35 import nom.tam.fits.header.IFitsHeader;
36
37 /**
38 * This is the file content.txt that presents a comprehensive compilation of all classes of data products in the Chandra
39 * Data Archive for the "flight" dataset. This file is the definitive authority on the values of various FITS header
40 * keywords.
41 * <p>
42 * All files are identified by the CONTENT value of their principal HDUs.
43 * </p>
44 *
45 * <pre>
46 * http://cxc.harvard.edu/contrib/arots/fits/content.txt
47 * </pre>
48 *
49 * @author Richard van Nieuwenhoven
50 */
51 public enum CXCExt implements IFitsHeader {
52 /**
53 * ASC-DS processing system revision (release)
54 */
55 ASCDSVER("ASC-DS processing system revision (release)"),
56 /**
57 * Correction applied to Basic Time rate (s)
58 */
59 BTIMCORR("Correction applied to Basic Time rate (s)"),
60 /**
61 * Basic Time clock drift (s / VCDUcount^2)
62 */
63 BTIMDRFT("Basic Time clock drift (s / VCDUcount^2)"),
64 /**
65 * Basic Time offset (s)
66 */
67 BTIMNULL("Basic Time offset (s)"),
68 /**
69 * Basic Time clock rate (s / VCDUcount)
70 */
71 BTIMRATE("Basic Time clock rate (s / VCDUcount)"),
72
73 /**
74 * Data product identification '########'
75 */
76 CONTENT("Data product identification"),
77 /**
78 * ???
79 */
80 CONVERS("??"),
81 /**
82 * Data class '########'
83 */
84 DATACLAS("Data class"),
85 /**
86 * Dead time correction
87 */
88 DTCOR("Dead time correction"),
89 /**
90 * Assumed focal length, mm; Level 1 and up
91 */
92 FOC_LEN("Assumed focal length, mm; Level 1 and up"),
93 /**
94 * ICD reference
95 */
96 HDUSPEC("ICD reference"),
97 /**
98 * The OGIP long string convention may be used.
99 */
100 LONGSTRN("The OGIP long string convention may be used."),
101 /**
102 * Mission is AXAF
103 */
104 MISSION("Mission is AXAF"),
105
106 /**
107 * Processing version of data
108 */
109 REVISION("Processing version of data"),
110 /**
111 * Nominal roll angle, deg
112 */
113 ROLL_NOM("Nominal roll angle, deg"),
114 /**
115 * Sequence number
116 */
117 SEQ_NUM("Sequence number"),
118 /**
119 * SIM focus pos (mm)
120 */
121 SIM_X("SIM focus pos (mm)"),
122 /**
123 * SIM orthogonal axis pos (mm)
124 */
125 SIM_Y("SIM orthogonal axis pos (mm)"),
126 /**
127 * SIM translation stage pos (mm)
128 */
129 SIM_Z("SIM translation stage pos (mm)"),
130 /**
131 * Major frame count at start
132 */
133 STARTMJF("Major frame count at start"),
134 /**
135 * Minor frame count at start
136 */
137 STARTMNF("Minor frame count at start"),
138 /**
139 * On-Board MET close to STARTMJF and STARTMNF
140 */
141 STARTOBT("On-Board MET close to STARTMJF and STARTMNF"),
142 /**
143 * Major frame count at stop
144 */
145 STOPMJF("Major frame count at stop"),
146 /**
147 * Minor frame count at stop
148 */
149 STOPMNF("Minor frame count at stop"),
150 /**
151 * Absolute precision of clock correction
152 */
153 TIERABSO("Absolute precision of clock correction"),
154 /**
155 * Short-term clock stability
156 */
157 TIERRELA("Short-term clock stability"),
158
159 /**
160 * Time stamp reference as bin fraction
161 */
162 TIMEPIXR("Time stamp reference as bin fraction"),
163
164 /**
165 * Telemetry revision number (IP&CL)
166 */
167 TLMVER("Telemetry revision number (IP&CL)"),
168 /**
169 * As in the "TIME" column: raw space craft clock;
170 */
171 TSTART("As in the \"TIME\" column: raw space craft clock;"),
172 /**
173 * add TIMEZERO and MJDREF for absolute TT
174 */
175 TSTOP("add TIMEZERO and MJDREF for absolute TT");
176
177 private final FitsKey key;
178
179 CXCExt(String comment) {
180 key = new FitsKey(name(), IFitsHeader.SOURCE.CXC, HDU.ANY, VALUE.STRING, comment);
181 }
182
183 @Override
184 public final FitsKey impl() {
185 return key;
186 }
187
188 }