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 denote non-standard FITS
38 * keyword format conventions.
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 NonStandard implements IFitsHeader {
48 /**
49 * @deprecated The CONTINUE key is now part of the FITS 4.0 standard, so use {@link Standard#CONTINUE} instead.
50 */
51 @Deprecated
52 CONTINUE(SOURCE.HEASARC, HDU.ANY, VALUE.NONE, "denotes the CONTINUE long string keyword convention"),
53
54 /**
55 * The HIERARCH keyword, when followed by spaces in columns 9 and 10 of the FITS card image, indicates that the ESO
56 * HIERARCH keyword convention should be used to interpret the name and value of the keyword. The HIERARCH keyword
57 * formally has no value because it is not followed by an equals sign in column 9. Under the HIERARCH convention the
58 * actual name of the keyword begins in column 11 of the card image and is terminated by the equal sign ('=')
59 * character. The name can contain any number of characters as long as it fits within columns 11 and 80 of the card
60 * image and also leaves enough space for the equal sign separator and the value field. The name can contain any
61 * printable ASCII text character, including spaces and lower-case characters, except for the equal sign character
62 * which serves as the terminator of the name field. Leading and trailing spaces in the name field are not
63 * significant, but embedded spaces within the name are significant. The value field follows the equals sign and
64 * must conform to the syntax for a free-format value field as defined in the FITS Standard. The value field may be
65 * null, in which case it contains only space characters, otherwise it may contain either a character string
66 * enclosed in single quotes, the logical constant T or F, an integer number, a floating point number, a complex
67 * integer number, or a complex floating point number. The value field may be followed by an optional comment
68 * string. The comment field must be separated from the value field by a slash character ('/'). It is recommended
69 * that the slash character be preceeded and followed by a space character. Example: "HIERARCH Filter Wheel = 12 /
70 * filter position". In this example the logical name of the keyword is 'Filter Wheel' and the value is 12.
71 */
72 HIERARCH(SOURCE.ESO, HDU.ANY, VALUE.NONE, null),
73
74 /**
75 * The presence of this keyword with a value = T in an extension key indicates that the keywords contained in the
76 * primary key (except the FITS Mandatory keywords, and any COMMENT, HISTORY or 'blank' keywords) are to be
77 * inherited, or logically included in that extension key.
78 *
79 * @deprecated Part of the FITS standard, use {@link Standard#INHERIT} instead.
80 */
81 INHERIT(SOURCE.STScI, HDU.EXTENSION, VALUE.LOGICAL, "inherit header description of primary HDU");
82
83 private final FitsKey key;
84
85 /**
86 * An alternative older value of the XTENSION keword in case of an image.
87 */
88 public static final String XTENSION_IUEIMAGE = "IUEIMAGE";
89
90 /**
91 * an alternative olde value of the XTENSION keword in case of an earlier version of binary table.
92 */
93 public static final String XTENSION_A3DTABLE = "A3DTABLE";
94
95 NonStandard(IFitsHeader.SOURCE status, HDU hdu, VALUE valueType, String comment) {
96 key = new FitsKey(name(), status, hdu, valueType, comment);
97 }
98
99 @Override
100 public final FitsKey impl() {
101 return key;
102 }
103 }