Enum InstrumentDescription

    • 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
      private IFitsHeader key  
    • Enum Constant Detail

      • 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.
    • Method Detail

      • values

        public static InstrumentDescription[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (InstrumentDescription c : InstrumentDescription.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static InstrumentDescription valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • comment

        public java.lang.String comment()
        Specified by:
        comment in interface IFitsHeader
      • key

        public java.lang.String key()
        Specified by:
        key in interface IFitsHeader