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 data or the
38 * FITS file itself
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 DataDescription implements IFitsHeader {
48 /**
49 * The value field shall contain a character string that uniquely defines the configuration state, or version, of
50 * the the software processing system that generated the data contained in the HDU. This keyword differs from the
51 * CREATOR keyword in that it give the name and version of the overall processing system and not just the name and
52 * version of a single program.
53 */
54 CONFIGUR(SOURCE.UNKNOWN, HDU.ANY, VALUE.STRING, "software configuration used to process the data"),
55 /**
56 * The value field shall contain a character string giving the name, and optionally, the version of the program that
57 * originally created the current FITS HDU. This keyword is synonymous with the PROGRAM keyword. Example: 'TASKNAME
58 * V1.2.3'
59 */
60 CREATOR(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "name of the software task that created the file"),
61
62 /**
63 * The value field shall contain a character string giving the the host file name used to record the original data.
64 */
65 FILENAME(SOURCE.NOAO, HDU.ANY, VALUE.STRING, "name of the file "),
66
67 /**
68 * The value field shall contain a character string giving the file type suffix of the host file name. The full file
69 * name typically consists of the root name (see ROOTNAME) followed by a file type suffix, separated by the period
70 * ('.') character.
71 */
72 FILETYPE(SOURCE.UNKNOWN, HDU.ANY, VALUE.STRING, "type of file"),
73
74 /**
75 * The value fields of this hierarchical set of indexed keywords shall contain character strings that classify the
76 * type of data contained in the HDU. The HDUCLAS1 keyword gives the highest, most general data classification, and
77 * the HDUCLAS2 and higher keywords provide progressively more detailed subclassifications of the data.
78 */
79 HDUCLASn(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "hierarchical classification of the data"),
80
81 /**
82 * The value field shall contain a character string that identifies the domain to which the associated HDUCLASn
83 * keywords apply. This keyword typically identifies the institution or project that has defined the allowed set of
84 * values for the associated hierarchical HDUCLASn keywords.
85 */
86 HDUCLASS(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "general identifier for the classification of the data"),
87
88 /**
89 * The value field shall contain a character string that gives a reference to a document that describes the allowed
90 * values that may be assigned to the HDUCLASn data classification keywords.
91 */
92 HDUDOC(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "reference to document describing the data format"),
93
94 /**
95 * This keyword is synonymous to the standard EXTLEVEL. It is recommended that the HDULEVEL and EXTLEVEL keywords
96 * should not both be given in the same HDU key, but if they are, then the HDULEVEL keyword will have precedence.
97 */
98 HDULEVEL(SOURCE.UNKNOWN, HDU.ANY, VALUE.INTEGER, "hierarchical level of the HDU"),
99 /**
100 * This keyword is synonymous to the standard EXTNAME keyword except. It is recommended that the HDUNAME and EXTNAME
101 * keywords should not both be given in the same HDU key, but if they are, then the HDUNAME keyword will have
102 * precedence.
103 */
104 HDUNAME(SOURCE.UNKNOWN, HDU.ANY, VALUE.STRING, "descriptive name of the HDU"),
105
106 /**
107 * This keyword is synonymous to the standard EXTVER keyword. It is recommended that the HDUVER and EXTVER keywords
108 * should not both be given in the same HDU key, but if they are, then the HDUVER keyword will have precedence.
109 */
110 HDUVER(SOURCE.UNKNOWN, HDU.ANY, VALUE.INTEGER, "version number of the HDU"),
111 /**
112 * The value field shall contain a character string that gives the specific version of the document referenced by
113 * HDUDOC.
114 */
115 HDUVERS(SOURCE.HEASARC, HDU.ANY, VALUE.STRING, "specific version of the document referenced by HDUDOC"),
116 /**
117 * The value field shall contain an integer giving the number of standard extensions contained in the FITS file.
118 * This keyword may only be used in the primary array key.
119 */
120 NEXTEND(SOURCE.STScI, HDU.PRIMARY, VALUE.INTEGER, "Number of standard extensions"),
121 /**
122 * The value field shall contain a character string giving the name, and optionally, the version of the program that
123 * originally created the current FITS HDU. This keyword is synonymous with the CREATOR keyword. Example: 'TASKNAME
124 * V1.2.3'
125 */
126 PROGRAM(SOURCE.UCOLICK, HDU.ANY, VALUE.STRING, "the name of the software task that created the file"),
127 /**
128 * The value field shall contain a character string giving the root of the host file name. The full file name
129 * typically consists of the root name followed by a file type suffix (see FILETYPE), separated by the period ('.')
130 * character.
131 */
132 ROOTNAME(SOURCE.UNKNOWN, HDU.ANY, VALUE.STRING, "rootname of the file"),
133 /**
134 * The value field of this indexed keyword shall contain a floating point number specifying the suggested bin size
135 * when producing a histogram of the values in column n. This keyword is typically used in conjunction the TLMINn
136 * and TLMAXn keywords when constructing a histogram of the values in column n, such that the histogram ranges from
137 * TLMINn to TLMAXn with the histogram bin size given by TDBINn. This keyword may only be used in 'TABLE' or
138 * 'BINTABLE' extensions.
139 */
140 TDBINn(SOURCE.CXC, HDU.TABLE, VALUE.REAL, "default histogram bin size for the column"),
141 /**
142 * The value field of this indexed keyword shall contain a floating point number specifying the maximum valid
143 * physical value represented in column n of the table, exclusive of any special values. This keyword may only be
144 * used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMAX keyword used for FITS images.
145 *
146 * @deprecated Use {@link Standard#TDMAXn} instead.
147 */
148 TDMAXn(SOURCE.HEASARC, HDU.TABLE, VALUE.REAL, "maximum value in the column"),
149 /**
150 * The value field of this indexed keyword shall contain a floating point number specifying the minimum valid
151 * physical value represented in column n of the table, exclusive of any special values. This keyword may only be
152 * used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMIN keyword used for FITS images.
153 *
154 * @deprecated Use {@link Standard#TDMINn} instead.
155 */
156 TDMINn(SOURCE.HEASARC, HDU.TABLE, VALUE.REAL, "minimum value in the column"),
157 /**
158 * The value field shall contain a character string giving a title that is suitable for display purposes, e.g., for
159 * annotation on images or plots of the data contained in the HDU.
160 */
161 TITLE(SOURCE.ROSAT, HDU.ANY, VALUE.STRING, "title for the observation or data"),
162 /**
163 * The value field of this indexed keyword shall contain a floating point number specifying the upper bound of the
164 * legal range of physical values that may be represented in column n of the table. The column may contain values
165 * that are greater than this legal maximum value but the interpretation of such values is not defined here. The
166 * value of this keyword is typically used as the maxinum value when constructing a histogram of the values in the
167 * column. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.
168 *
169 * @deprecated Use {@link Standard#TLMAXn} instead.
170 */
171 TLMAXn(SOURCE.HEASARC, HDU.TABLE, VALUE.REAL, "maximum legal value in the column"),
172 /**
173 * The value field of this indexed keyword shall contain a floating point number specifying the lower bound of the
174 * legal range of physical values that may be represented in column n of the table. The column may contain values
175 * that are less than this legal minimum value but the interpretation of such values is not defined here. The value
176 * of this keyword is typically used as the mininum value when constructing a histogram of the values in the column.
177 * This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.
178 *
179 * @deprecated Use {@link Standard#TLMINn} instead.
180 */
181 TLMINn(SOURCE.HEASARC, HDU.TABLE, VALUE.REAL, "minimum legal value in the column"),
182 /**
183 * The value field shall contain a character string that defines the order in which the rows in the current FITS
184 * ASCII or binary table extension have been sorted. The character string lists the name (as given by the TTYPEn
185 * keyword) of the primary sort column, optionally followed by the names of any secondary sort column(s). The
186 * presence of this keyword indicates that the rows in the table have been sorted first by the values in the primary
187 * sort column; any rows that have the same value in the primary column have been further sorted by the values in
188 * the secondary sort column and so on for all the specified columns. If more than one column is specified by
189 * TSORTKEY then the names must be separated by a comma. One or more spaces are also allowed between the comma and
190 * the following column name. By default, columns are sorted in ascending order, but a minus sign may precede the
191 * column name to indicate that the rows are sorted in descending order. This keyword may only be used in 'TABLE' or
192 * 'BINTABLE' extensions. Example: TSORTKEY = 'TIME, RA, DEC'.
193 */
194 TSORTKEY(SOURCE.HEASARC, HDU.TABLE, VALUE.STRING, "defines the sort order of a table");
195
196 private final FitsKey key;
197
198 DataDescription(IFitsHeader.SOURCE status, HDU hdu, VALUE valueType, String comment) {
199 key = new FitsKey(name(), status, hdu, valueType, comment);
200 }
201
202 @Override
203 public final FitsKey impl() {
204 return key;
205 }
206 }