Enum InstrumentDescription

java.lang.Object
java.lang.Enum<InstrumentDescription>
nom.tam.fits.header.InstrumentDescription
All Implemented Interfaces:
Serializable, Comparable<InstrumentDescription>, java.lang.constant.Constable, IFitsHeader
public enum InstrumentDescription extends Enum<InstrumentDescription> implements IFitsHeader

This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is recommended that these keywords only be used as defined here. These are the Keywords that describe the instrument that took the data.

See http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html

Author:
Richard van Nieuwenhoven

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

    Nested classes/interfaces inherited from interface IFitsHeader

    IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
    Modifier and Type
    Interface
    Description
    static enum 
    IFitsHeader.HDU
    An enumeration of HDU types in which a header keyword may be used.
    static enum 
    IFitsHeader.SOURCE
    Documentation sources for the various known conventions.
    static enum 
    IFitsHeader.VALUE
    Values types to which implementing keywords can be restricted to.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    APERTURE
    The value field shall contain a character string which gives the name of the instrumental aperture though which the observation was made.
    DATAMODE
    The value field shall contain a character string which identifies the configuration or mode of the pre-processing software that operated on the raw instrumental data to generate the data that is recorded in the FITS file.
    DETNAM
    The value field shall contain a character string giving the name of the detector within the instrument that was used to make the observation.
    FILTER
    The value field shall contain a character string which gives the name of the filter that was used during the observation to select or modify the radiation that was transmitted to the detector.
    FILTERn
    The value field of this indexed keyword shall contain a character string which gives the name of one of multiple filters that were used during the observation to select or modify the radiation that was transmitted to the detector.
    GRATING
    The value field shall contain a character string which gives the name of the defraction grating that was used during the observation.
    GRATINGn
    The value field of this indexed keyword shall contain a character string which gives the name of one of multiple defraction gratings that were used during the observation.
    OBS_MODE
    The value field shall contain a character string which gives the observing mode of the observation.
    SATURATE
    The value field shall contain an integer giving the data value at which the detector becomes saturated.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FILTER_NONE
    Standard FILTER name when no filter was used.
    static final String
    GRATING_NONE
    Standard GRATING name when no filter was used.

    Fields inherited from interface IFitsHeader

    MAX_INDEX
    Modifier and Type
    Field
    Description
    static final int
    MAX_INDEX
    Max numeric index we may use to replace n in the Java name of indexed variables.

  • Method Summary

    Modifier and Type
    Method
    Description
    final FitsKey
    impl()
    (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
    static InstrumentDescription
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static InstrumentDescription[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface IFitsHeader

    comment, extractIndices, hdu, key, n, status, valueType
    Modifier and Type
    Method
    Description
    default String
    comment()
    Returns the comment associated to this FITS header entry.
    default int[]
    extractIndices(String key)
    Extracts the indices for this stndardized key from an actual keyword realization.
    default IFitsHeader.HDU
    hdu()
    Returns the type of HDU(s) in which this header entry may be used.
    default String
    key()
    Returns the FITS header keyword (or keyword template) for this header entry.
    default IFitsHeader
    n(int... numbers)
    Constructs an indexed FITS header keyword entry from this stem, replacing index place-holders (indicated by lower-case 'n' in the name) with actual numerical values.
    default IFitsHeader.SOURCE
    status()
    Returns the standard convention, which defines this FITS header entry
    default IFitsHeader.VALUE
    valueType()
    The type(s) of value(s) this FITS header entry might take.

  • Enum Constant Details

    • APERTURE

      public static final InstrumentDescription APERTURE
      The value field shall contain a character string which gives the name of the instrumental aperture though which the observation was made. This keyword is typically used in instruments which have a selection of apertures which restrict the field of view of the detector.

    • DATAMODE

      public static final InstrumentDescription DATAMODE
      The value field shall contain a character string which identifies the configuration or mode of the pre-processing software that operated on the raw instrumental data to generate the data that is recorded in the FITS file. Example: some X-ray satellite data may be recorded in 'BRIGHT', 'FAINT', or 'FAST' data mode.

    • DETNAM

      public static final InstrumentDescription DETNAM
      The value field shall contain a character string giving the name of the detector within the instrument that was used to make the observation. Example: 'CCD1'

    • FILTER

      public static final InstrumentDescription FILTER
      The value field shall contain a character string which gives the name of the filter that was used during the observation to select or modify the radiation that was transmitted to the detector. More than 1 filter may be listed by using the FILTERn indexed keyword. The value 'none' or 'NONE' indicates that no filter was used.

    • FILTERn

      public static final InstrumentDescription FILTERn
      The value field of this indexed keyword shall contain a character string which gives the name of one of multiple filters that were used during the observation to select or modify the radiation that was transmitted to the detector. The value 'none' or 'NONE' indicates that no filter was used.

    • GRATING

      public static final InstrumentDescription GRATING
      The value field shall contain a character string which gives the name of the defraction grating that was used during the observation. More than 1 grating may be listed by using the GRATINGn indexed keyword. The value 'none' or 'NONE' indicates that no grating was used.

    • GRATINGn

      public static final InstrumentDescription GRATINGn
      The value field of this indexed keyword shall contain a character string which gives the name of one of multiple defraction gratings that were used during the observation. The value 'none' or 'NONE' indicates that no grating was used.

    • OBS_MODE

      public static final InstrumentDescription OBS_MODE
      The value field shall contain a character string which gives the observing mode of the observation. This is used in cases where the instrument or detector can be configured to operate in different modes which significantly affect the resulting data. Examples: 'SLEW', 'RASTER', or 'POINTING'

    • SATURATE

      public static final InstrumentDescription SATURATE
      The value field shall contain an integer giving the data value at which the detector becomes saturated. This keyword value may differ from the maximum value implied by the BITPIX in that more bits may be allocated in the FITS pixel values than the detector can accommodate.

  • Field Details

  • Method Details

    • values

      public static InstrumentDescription[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static InstrumentDescription valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • impl

      public final FitsKey impl()
      Description copied from interface: IFitsHeader
      (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
      Specified by:
      impl in interface IFitsHeader
      Returns:
      the implementation of this keyword, which provides the actual access methods. Implementations of this interface should simply return themselves.