View Javadoc
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   * <p>
39   * This keyword dictionary gathered form STScI.
40   * </p>
41   * <p>
42   * See <a href=
43   * "http://tucana.noao.edu/ADASS/adass_proc/adass_95/zaraten/zaraten.html">http://tucana.noao.edu/ADASS/adass_proc/adass_95/zaraten/zaraten.html</a>
44   * </p>
45   *
46   * @author Richard van Nieuwenhoven.
47   */
48  public enum STScIExt implements IFitsHeader {
49      /**
50       * approach vectors
51       */
52      APPVEC("approach vectors"),
53      /**
54       * Telemetry rate
55       */
56      BIT_RATE("Telemetry rate"),
57      /**
58       * date of initial data represented (dd/mm/yy)
59       */
60      DATE_BEG("DATE-BEG", "date of initial data represented."),
61      /**
62       * Date of original file creation (dd/mm/yy)
63       */
64      DATE_MAP("DATE-MAP", "Date of original file creation"),
65      /**
66       * File standard deviation of DEC (degrees)
67       */
68      DEC_PNTE(""),
69      /**
70       * Detector X field of view (mm)
71       */
72      FOV_X_MM("Detector X field of view (mm)"),
73      /**
74       * Detector X field of view (mm)
75       */
76      FOV_Y_MM("Detector Y field of view (mm)"),
77      /**
78       * BITS/PIXEL OF IPPS RASTER. In truth this is an illegal FITS keyword, as the character '/' is not allowed in
79       * standard FITS keywords. If possible, avoid using it since it may result in FITS that is not readable by some
80       * software.
81       */
82      IPPS_B_P("IPPS-B/P", "BITS/PIXEL OF IPPS RASTER."),
83      /**
84       * IPPS identification.
85       */
86      IPPS_ID("IPPS-ID", ""),
87      /**
88       * MAXIMUM VALUE IN RASTER
89       */
90      IPPS_MAX("IPPS-MAX", "MAXIMUM VALUE IN RASTER"),
91      /**
92       * MINIMUM VALUE IN RASTER
93       */
94      IPPS_MIN("IPPS-MIN", "MINIMUM VALUE IN RASTER"),
95      /**
96       * RASTER LFN/RASTER ORDINAL
97       */
98      IPPS_RF("IPPS-RF", "RASTER LFN/RASTER ORDINAL"),
99      /**
100      * ?
101      */
102     JOBNAME(""),
103     /**
104      * Fractional portion of ephemeris MJD
105      */
106     MJDREFF("Fractional portion of ephemeris MJD"),
107     /**
108      * Integer portion of ephemeris MJD
109      */
110     MJDREFI("Integer portion of ephemeris MJD"),
111     /**
112      * Modal Configuration ID
113      */
114     MODAL_ID("Modal Configuration ID"),
115     /**
116      * optical attribute number is id.
117      */
118     OPTICn(""),
119     /**
120      * beginning orbit number
121      */
122     ORBITBEG("beginning orbit number"),
123     /**
124      * ending orbit number
125      */
126     ORBITEND("ending orbit number"),
127     /**
128      * File standard deviation of ROLL (degrees)
129      */
130     PA_PNTE("File standard deviation of ROLL"),
131     /**
132      * Quad tree pixel resolution
133      */
134     PIXRESOL("Quad tree pixel resolution"),
135     /**
136      * Processing script version
137      */
138     PROCVER("Processing script version"),
139     /**
140      * ?
141      */
142     PRODUCT(""),
143     /**
144      * File standard deviation of RA (degrees)
145      */
146     RA_PNTE("File standard deviation of RA "),
147     /**
148      * Sequential number from ODB
149      */
150     SEQNUM("Sequential number from ODB"),
151     /**
152      * Number of times sequence processed
153      */
154     SEQPNUM("Number of times sequence processed"),
155     /**
156      * solar elongations included
157      */
158     SOLELONG("solar elongations included"),
159     /**
160      * ?
161      */
162     TCDLTn(""),
163     /**
164      * ?
165      */
166     TCRPXn(""),
167     /**
168      * ?
169      */
170     TCRVLn(""),
171     /**
172      * ?
173      */
174     TCTYPn(""),
175     /**
176      * Default time system. All times which do not have a "timesys" element associated with them in this dictionary
177      * default to this keyword. time system (same as IRAS)
178      */
179     TIMESYS("Default time system"),
180     /**
181      * offset to be applied to TIME column
182      */
183     TIMEZERO("offset to be applied to TIME column"),
184     /**
185      * observation start time in TIMESYS system .
186      */
187     TSTART("observation start time"),
188     /**
189      * observation stop time in TIMESYS system .
190      */
191     TSTOP("observation stop time"),
192     /**
193      * Version of Data Reduction Software
194      */
195     VERSION("Version of Data Reduction Software "),
196     /**
197      * nominal wavelength of Band n
198      */
199     WAVEn("nominal wavelength of Band"),
200     /**
201      * signal from zodiacal dust remains in map
202      */
203     ZLREMOV("signal from zodiacal dust remains in map"),
204     /**
205      * Modified Julian date at the start of the exposure. The fractional part of the date is given to better than a
206      * second of time.
207      * <p>
208      * units = 'd'
209      * </p>
210      * <p>
211      * default value = none
212      * </p>
213      * <p>
214      * index = none
215      * </p>
216      */
217     MJD_OBS("MJD-OBS", "MJD of exposure start");
218 
219     private final FitsKey key;
220 
221     STScIExt(String comment) {
222         this(null, comment);
223     }
224 
225     STScIExt(String key, String comment) {
226         this.key = new FitsKey(key == null ? name() : key, IFitsHeader.SOURCE.CXC, HDU.ANY, VALUE.STRING, comment);
227     }
228 
229     @Override
230     public final FitsKey impl() {
231         return key;
232     }
233 
234 }