1 package nom.tam.fits.header;
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 /**
35 * <p>
36 * This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is
37 * recommended that these keywords only be used as defined here. These are the Keywords that describe the instrument
38 * that took the data.
39 * </p>
40 * <p>
41 * See <a href=
42 * "http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html">http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html</a>
43 * </p>
44 *
45 * @author Richard van Nieuwenhoven
46 */
47 public enum InstrumentDescription implements IFitsHeader {
48 /**
49 * The value field shall contain a character string which gives the name of the instrumental aperture though which
50 * the observation was made. This keyword is typically used in instruments which have a selection of apertures which
51 * restrict the field of view of the detector.
52 */
53 APERTURE(SOURCE.UNKNOWN, HDU.ANY, VALUE.STRING, "name of field of view aperture"),
54 /**
55 * The value field shall contain a character string which identifies the configuration or mode of the pre-processing
56 * software that operated on the raw instrumental data to generate the data that is recorded in the FITS file.
57 * Example: some X-ray satellite data may be recorded in 'BRIGHT', 'FAINT', or 'FAST' data mode.
58 */
59 DATAMODE(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "pre-processor data mode"),
60 /**
61 * The value field shall contain a character string giving the name of the detector within the instrument that was
62 * used to make the observation. Example: 'CCD1'
63 */
64 DETNAM(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of the detector used to make the observation"),
65 /**
66 * The value field shall contain a character string which gives the name of the filter that was used during the
67 * observation to select or modify the radiation that was transmitted to the detector. More than 1 filter may be
68 * listed by using the FILTERn indexed keyword. The value 'none' or 'NONE' indicates that no filter was used.
69 */
70 FILTER(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of filter used during the observation"),
71 /**
72 * The value field of this indexed keyword shall contain a character string which gives the name of one of multiple
73 * filters that were used during the observation to select or modify the radiation that was transmitted to the
74 * detector. The value 'none' or 'NONE' indicates that no filter was used.
75 */
76 FILTERn(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of filters used during the observation"),
77 /**
78 * The value field shall contain a character string which gives the name of the defraction grating that was used
79 * during the observation. More than 1 grating may be listed by using the GRATINGn indexed keyword. The value 'none'
80 * or 'NONE' indicates that no grating was used.
81 */
82 GRATING(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of the grating used during the observation."),
83 /**
84 * The value field of this indexed keyword shall contain a character string which gives the name of one of multiple
85 * defraction gratings that were used during the observation. The value 'none' or 'NONE' indicates that no grating
86 * was used.
87 */
88 GRATINGn(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of gratings used during the observation."),
89 /**
90 * The value field shall contain a character string which gives the observing mode of the observation. This is used
91 * in cases where the instrument or detector can be configured to operate in different modes which significantly
92 * affect the resulting data. Examples: 'SLEW', 'RASTER', or 'POINTING'
93 */
94 OBS_MODE(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "instrumental mode of the observation"),
95 /**
96 * The value field shall contain an integer giving the data value at which the detector becomes saturated. This
97 * keyword value may differ from the maximum value implied by the BITPIX in that more bits may be allocated in the
98 * FITS pixel values than the detector can accommodate.
99 */
100 SATURATE(SOURCE.STScI, HDU.ANY, VALUE.INTEGER, "data value at which saturation occurs");
101
102 private final FitsKey key;
103
104 InstrumentDescription(IFitsHeader.SOURCE status, HDU hdu, VALUE valueType, String comment) {
105 key = new FitsKey(name(), status, hdu, valueType, comment);
106 }
107
108 @Override
109 public final FitsKey impl() {
110 return key;
111 }
112 }