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   * This is the file represents the common keywords between CXC and STSclExt
39   *
40   * @author     Richard van Nieuwenhoven
41   * 
42   * @deprecated This enum is duplicated by both {@link CXCExt} and {@link STScIExt}, and users would (should) typically
43   *                 use one or the other.
44   */
45  public enum CXCStclSharedExt implements IFitsHeader {
46      /**
47       * Clock correction applied
48       * <p>
49       * T
50       * </p>
51       */
52      CLOCKAPP("Clock correction applied"),
53      /**
54       * 1998-01-01T00:00:00 (TT) expressed in MJD (TT)
55       */
56      MJDREF("1998-01-01T00:00:00 (TT) expressed in MJD"),
57      /**
58       * Spacecraft clock
59       */
60      TASSIGN("Spacecraft clock"),
61      /**
62       * Time resolution of data (in seconds)
63       */
64      TIMEDEL("Time resolution of data (in seconds)"),
65      /**
66       * No pathlength corrections
67       */
68      TIMEREF("No pathlength corrections"),
69      /**
70       * Units of time e.g. 's'
71       */
72      TIMEUNIT("Units of time "),
73      /**
74       * AXAF FITS design document
75       */
76      TIMVERSN("AXAF FITS design document"),
77      /**
78       * Clock correction (if not zero)
79       */
80      TIMEZERO("Clock correction (if not zero)"),
81      /**
82       * As in the "TIME" column: raw space craft clock;
83       */
84      TSTART("As in the \"TIME\" column: raw space craft clock;"),
85      /**
86       * add TIMEZERO and MJDREF for absolute TT
87       */
88      TSTOP("add TIMEZERO and MJDREF for absolute TT");
89  
90      private final FitsKey key;
91  
92      CXCStclSharedExt(String comment) {
93          key = new FitsKey(name(), IFitsHeader.SOURCE.CXC, HDU.ANY, VALUE.STRING, comment);
94      }
95  
96      @Override
97      public final FitsKey impl() {
98          return key;
99      }
100 
101 }