Package nom.tam.fits.header
Enum Class InstrumentDescription
- All Implemented Interfaces:
Serializable
,Comparable<InstrumentDescription>
,Constable
,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.
- Author:
- Richard van Nieuwenhoven
- 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 ConstantsEnum ConstantDescriptionThe 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. -
Method Summary
Modifier and TypeMethodDescriptioncomment()
hdu()
key()
n
(int... number) status()
static InstrumentDescription
Returns the enum constant of this class with the specified name.static InstrumentDescription[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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
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
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
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
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
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
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
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
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 Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
comment
- Specified by:
comment
in interfaceIFitsHeader
-
hdu
- Specified by:
hdu
in interfaceIFitsHeader
-
key
- Specified by:
key
in interfaceIFitsHeader
-
n
- Specified by:
n
in interfaceIFitsHeader
-
status
- Specified by:
status
in interfaceIFitsHeader
-
valueType
- Specified by:
valueType
in interfaceIFitsHeader
-