Enum Class InstrumentDescription

java.lang.Object
java.lang.Enum<InstrumentDescription>
nom.tam.fits.header.InstrumentDescription
All Implemented Interfaces:
Serializable, Comparable<InstrumentDescription>, 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 Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader

    IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    The value field shall contain a character string which gives the name of the instrumental aperture though which the observation was made.
    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.
    The value field shall contain a character string giving the name of the detector within the instrument that was used to make the observation.
    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.
    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 field shall contain a character string which gives the name of the defraction grating that was used during the observation.
    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 field shall contain a character string which gives the observing mode of the observation.
    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 final IFitsHeader
     
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    hdu()
     
    key()
     
    n(int... number)
     
     
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • 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

  • Constructor Details

  • Method Details